Accounts

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.

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

Request

Path parameters

connection_idinteger required

Connection identifier, as returned by the connection list.

Query parameters

searchstring

Case-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.

pageinteger

Page number, starting at 1. A page beyond the last one is rejected with 400 invalid_query_parameter, not answered with an empty list.

page_sizeinteger

Accounts per page, from 1 to 100. A larger value is rejected with 400 invalid_query_parameter; it is not silently capped.

Response

One page of connection accounts

countinteger

Total number of accounts matching the request.

nextstring nullable

Full URL of the next page, or null on the last page.

previousstring nullable

Full URL of the previous page, or null on the first page.

Changes

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