v1

latestOpenAPI 3.1.02026-08-04751,1671.3 MB
Address Book

List Contacts

Get a list of all contacts in an organization.

get/api/v1/addressbook/contacts

Query parameters

sort_byContactSortableFields[]
pageinteger

The page number to fetch.

The page number to fetch.

sizeinteger

The number of items per page.

The number of items per page.

skip_countboolean

Whether to skip counting the total number of items.

Whether to skip counting the total number of items.

contact_idsstring[]

The contact IDs to filter by.

The contact IDs to filter by.

namesstring[]

The names to filter by.

The names to filter by.

statesAddressBookContactState[]

The states to filter by.

The states to filter by.

chain_typesChainType[]

The chain types to filter by.

The chain types to filter by.

chainsstring[]

The chain unique ids to filter by.

The chain unique ids to filter by.

asset_idsstring[]

List of asset identifiers to filter on.

List of asset identifiers to filter on.

address_group_idsstring[]

The address group IDs to filter by.

The address group IDs to filter by.

exclude_address_group_idsstring[]

List of address group IDs to exclude.

List of address group IDs to exclude.

exclude_contact_idsstring[]

List of contact IDs to exclude.

List of contact IDs to exclude.

Response

Successful Response

totalinteger required
pageinteger required
sizeinteger required