v14

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-279719892.3 MB

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