List Post

POST
Gets a list of accounts.

Request

This endpoint expects an object.
created_bylist of stringsOptional
Filters for accounts created by the specified user(s).
created_dateobjectOptional
cursorstringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
display_namelist of stringsOptional
Array of display names of 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'.
mode"after" or "before"Optional
Allowed values: afterbefore
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.
modified_dateobjectOptional
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.

Response

This endpoint returns an object.
accountslist of objects
List containing all the accounts
next_cursorstringOptional
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursorstringOptional
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.