YNAB

Create new YNAB connection

When creating a new YNAB connection, Synci will generate an authorization URL (auth_url). You should follow the authorization URL to activate the connection. Once the connection is authorized, Synci will automatically fetch available budgets and budget accounts.

POST

/destinations/ynab/connections

curl --request POST \
  --url https://api.synci.io/api/v1/destinations/ynab/connections \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "auth_url": "<string>",
    "ynab_connection": {
      "auth_url": "<string>",
      "budgets": [
        {
          "accounts": [
            {
              "balance": "<string>",
              "budget": {},
              "budget_id": "<string>",
              "cleared_balance": "<string>",
              "closed": "<string>",
              "created_at": "<string>",
              "direct_import_linked": "<string>",
              "health": {
                "failure_count": "<string>",
                "integrator_message": "<string>",
                "last_attempt_at": "<string>",
                "status": "<string>",
                "transient_failure_count": "<string>",
                "transient_message": "<string>"
              },
              "id": "<string>",
              "last_reconciled_at": "<string>",
              "name": "<string>",
              "note": "<string>",
              "on_budget": "<string>",
              "transfer_links": [
                {
                  "active": "<string>",
                  "created_at": "<string>",
                  "destination": "<any>",
                  "destination_id": "<string>",
                  "destination_type": "<string>",
                  "financial_account": {},
                  "financial_account_id": "<string>",
                  "id": "<string>",
                  "on_booked_change": {},
                  "rules": [],
                  "sync_mode": "<string>",
                  "transfer_start_date": "2025-01-01",
                  "updated_at": "<string>"
                }
              ],
              "transfer_payee_id": "<string>",
              "type": "<string>",
              "uncleared_balance": "<string>",
              "updated_at": "<string>",
              "ynab_id": "<string>"
            }
          ],
          "connection": {},
          "connection_id": "<string>",
          "created_at": "<string>",
          "currency": "<string>",
          "enabled": "<string>",
          "first_month": "<string>",
          "id": "<string>",
          "last_month": "<string>",
          "last_synced_at": "<string>",
          "name": "<string>",
          "updated_at": "<string>",
          "ynab_id": "<string>"
        }
      ],
      "created_at": "<string>",
      "enabled": "<string>",
      "health": {
        "failure_count": "<string>",
        "integrator_message": "<string>",
        "last_attempt_at": "<string>",
        "status": "<string>",
        "transient_failure_count": "<string>",
        "transient_message": "<string>"
      },
      "id": "<string>",
      "last_synced_at": "<string>",
      "name": "<string>",

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

namestring

Optional display name for the connection.

Maximum string length: 255

Response

dataobjectrequired

Show child attributes

messagestringrequired

Still need help? Ask the team