List

GET

Gets a list of accounts.

Query parameters

created_bystringOptional

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

created_date.afterdatetimeOptional

Filters for objects created after the provided timestamp (inclusive).

created_date.beforedatetimeOptional

Filters for objects created before the provided timestamp (inclusive).

cursorstringOptional

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

custom_fieldsmap from strings to anyOptional

Filters for custom fields.

display_namestringOptional

Array of display names of accounts to be filtered.

domainsstringOptional

Domains for accounts to be filtered.

external_refsstringOptional

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

The iteration mode to use, otherwise if not set, then “after” is used.

Allowed values: afterbefore
modified_date.afterdatetimeOptional

Filters for objects created after the provided timestamp (inclusive).

modified_date.beforedatetimeOptional

Filters for objects created before the provided timestamp (inclusive).

owned_bystringOptional

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

sort_bystringOptional

Fields to sort the accounts by and the direction to sort them in.

stagestringOptional

Filters for accounts on specified stages.

tagsstringOptional

List of tags to be filtered.

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.