v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
Accounts

Filter accounts

<small>Requires the contacts:read scope (or a broader one that includes it).</small>

Returns a paginated, filtered list of accounts using advanced filter criteria.

post/v3/contact-accounts/filter

Query parameters

topinteger

Maximum number of items to return (default 25, max 1000)

skipinteger

Number of items to skip

Request body

searchstring nullable

Search term to filter accounts by name

sortBystring nullable

Field name to sort by

sortDirection'asc' | 'desc' nullable

Sort direction

listIdinteger nullable

Filter by contact list ID

Response

Paginated list of accounts matching filter criteria

hasMoreboolean

Whether more items are available beyond the current page