Accounts

List accounts for connection

List accounts for connection.

When you configure a recipe through the v3.1 API, take the account id values from List connection accounts (v3.1), not from this operation: for some agencies this operation returns different keys, and PUT /api/v3.1/automated-recipes/{recipe_id}/ rejects them with account_unavailable.

get/api/v3/connections/{connection_id}/accounts

Request

Path parameters

connection_idinteger required

Connection ID

Response

Get a list of Accounts

countinteger

Number of accounts

nextstring

URL to the next page

previousstring

URL to the previous page

Example response

[
  {
    "accounts_list": {
      "value": {
        "count": 2,
        "next": null,
        "previous": null,
        "results": [
          {
            "id": 1,
            "account_id": "12345678-1234-5678-1234-567812345678",
            "title": "Account 1",
            "currency": "USD",
            "connection_id": 1,
            "datasource_name": "google_sheets",
            "created_at": "2021-01-01T00:00:00Z",
            "updated_at": "2021-01-01T00:00:00Z",
            "is_active": true,
            "enabled_for_embedded_extraction": true
          },
          {
            "id": 2,
            "account_id": "12345678-1234-5678-1234-567812345678",
            "title": "Account 2",
            "currency": "USD",
            "connection_id": 2,
            "datasource_name": "google_ads",
            "created_at": "2021-01-01T00:00:00Z",
            "updated_at": "2021-01-01T00:00:00Z",
            "is_active": true,
            "enabled_for_embedded_extraction": true
          }
        ]
      }
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.