Search

Search for users based on specified criteria.

Changed on

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

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/crm/objects/2026-03/users/search
  • Auth
    • HTTP bearer
    • or API key in query parameter hapikey
    • or none

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

Some revisions have not been checked yet.