API ReferenceAccounts

List Accounts (POST)

Gets a list of accounts.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
created_bylist of stringsOptional

Filters for accounts created by the specified user(s).

created_dateobjectOptional
cursorstringOptionalformat: "text"
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
custom_fieldsobjectOptional
Filters for custom fields.
display_namelist of stringsOptional
Array of display names of accounts to be filtered.
domainslist of stringsOptional
Domains for accounts to be filtered.
external_refslist of stringsOptional
Array of references of accounts to be filtered.
limitintegerOptional
The maximum number of accounts to return per page. The default is '50'.
modeenumOptional

The iteration mode to use. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

Allowed values:
modified_dateobjectOptional
owned_bylist of stringsOptional

Filters for accounts owned by the specified user(s).

sort_bylist of stringsOptional
Fields to sort the accounts by and the direction to sort them in.
stagelist of stringsOptional
Filters for accounts on specified stages.
subtypelist of stringsOptional
Subtypes of the accounts to be filtered.
tagslist of stringsOptional
List of tags to be filtered.
tierlist of stringsOptional
Tier of the accounts to be filtered.
websiteslist of stringsOptional
Array of websites of accounts to be filtered.

Response

The response to listing all accounts matching the filter criteria.
accountslist of objects
List containing all the accounts
next_cursorstring or nullformat: "text"
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursorstring or nullformat: "text"
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors