latestOpenAPI 3.0.32026-08-20147323331.7 KB

a7231589e927

users

Search for users by a given filter

Filterable fields and their allowed operators:

FieldAllowed operators
emailequals, in, not_in

Rate limit: 20 requests per minute

post/users/search

Request body

cursorstring

The cursor to use for pagination.

limitinteger

The number of users to fetch. Defaults to 100. Must be greater than 0 and less than 1000.

Example request

{
  "filter": {
    "subfilters": [
      {
        "field": "state",
        "operator": "equals",
        "value": "new"
      }
    ]
  }
}

Response

request_idstring

The request ID for tracking.

Example response

{
  "data": [
    {
      "status": "active"
    }
  ]
}