Accounts
Manage connection accounts from which data is extracted.
Accounts represent specific accounts within a data source platform. Each account is associated with a connection and can have multiple extracts configured to pull data from it.
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.
path Parameters
connection_idConnection ID
List accounts for connection › Responses
Get a list of Accounts
countNumber of accounts
nextURL to the next page
previousURL to the previous page
Update accounts
Update accounts
path Parameters
connection_idConnection ID
Update accounts › Request Body
idAccount ID
enabled_for_embedded_extractionEnabled for embedded extraction
Update accounts › Responses
Update Accounts
idAccount ID
account_idRemote account ID
titleAccount title
currencyAccount currency
connection_idConnection ID
datasource_nameData source name
created_atAccount creation date
updated_atAccount update date
is_activeIs the account active
enabled_for_embedded_extractionIs the account enabled for embedded extraction
Data source-specific account item information
List connection accounts (v3.1)
Lists the accounts of one connection in the workspace your token belongs to, sorted by id. Use it to pick the accounts a recipe extracts from.
The id values returned here are the ones PUT /api/v3.1/automated-recipes/{recipe_id}/ accepts in connections[].accounts[]. Only accounts with is_active: true can be used there; the others are rejected with account_unavailable.
The trailing slash is mandatory on this path, unlike the v3 accounts operation.
The page holds 100 accounts by default and 100 at most; next and previous are full v3.1 URLs.
path Parameters
connection_idConnection identifier, as returned by the connection list.
query Parameters
searchCase-insensitive substring of the account title. A value made only of digits also matches the account whose id is exactly that number. An empty or blank value applies no filter and is not rejected, unlike search on the recipe template list.
pagePage number, starting at 1. A page beyond the last one is rejected with 400 invalid_query_parameter, not answered with an empty list.
page_sizeAccounts per page, from 1 to 100. A larger value is rejected with 400 invalid_query_parameter; it is not silently capped.
List connection accounts (v3.1) › Responses
One page of connection accounts
countTotal number of accounts matching the request.
nextFull URL of the next page, or null on the last page.
previousFull URL of the previous page, or null on the first page.
Accounts on this page.
Update an account
Update an account
path Parameters
connection_idConnection ID
account_idAccount ID
Update an account › Request Body
enabled_for_embedded_extractionEnabled for embedded extraction
Update an account › Responses
Update an Account
idAccount ID
account_idRemote account ID
titleAccount title
currencyAccount currency
connection_idConnection ID
datasource_nameData source name
created_atAccount creation date
updated_atAccount update date
is_activeIs the account active
enabled_for_embedded_extractionIs the account enabled for embedded extraction
Data source-specific account item information