USusepylon
users

Search for users by a given filter

Changed on

Filterable fields and their allowed operators:

FieldAllowed operators
emailequals, in, not_in

Rate limit: 120 requests per minute

post/users/search

Request

  • Base URL
    https://api.usepylon.com
  • URL
    https://api.usepylon.com/users/search
  • Auth
    HTTP bearer

Request body

cursorstring

The cursor to use for pagination.

limitinteger

The number of users to fetch. Defaults to 100. Must be between 1 and 1000.

Example request

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

Response

request_idstring required

The request ID for tracking.

Example response

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

Changes

  • 8522e66913b4Revision changes
    • info

      added the new not enum value to the request property /

    • info

      added the new time_is_in_last enum value to the request property /

    • info

      added the new time_is_in_next enum value to the request property /

    • info

      added the new time_is_not_in_last enum value to the request property /

    • info

      added the new time_is_not_in_next enum value to the request property /

  • 69a0bee18b33Revision changes
    • info

      added the optional property // to the response with the status