Search for users based on specified criteria.

Execute a search for users using defined filters, properties, and sorting options. The request must include a search query and can return up to 200 results per request.

post/crm/objects/2026-03/users/search

Request body

afterstring required

A paging cursor token for retrieving subsequent pages.

limitinteger required

The maximum results to return, up to 200 objects.

propertiesstring[] required

A list of property names to include in the response.

querystring

The search query string, up to 3000 characters.

sortsstring[] required

Specifies sorting order based on object properties.

Response

successful operation

totalinteger required

The number of available results

Changes

Changed in 2 of the 14 revisions of this API.2

Mar 30, 2026dc2fdad57f7f1See the full diff
- ○
  api operation id post-/crm/objects/2026-03/users/search_/crm/objects/2026-03/users/search removed and replaced with post-/crm/objects/2026-03/users/search
  api-operation-id-removed
This revision also has 129 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 25, 202662586336cea21See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 73 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 14 revisions, 1 has no diff computed and 2 have a changelog that could not be searched.

Full history