account-highlights3

accounts17

activity-types1

article-feedback1

articles6

attachments1

audit_logs2

call-recordings5

collections5

contacts7

custom-fields7

custom-objects7

email-suppressions2

feature-requests9

import5

issue-statuses1

issues18

knowledge-base-themes3

knowledge-bases2

macros6

me1

messages9

milestones5

projects5

route-redirects1

surveys5

tags6

task-statuses1

tasks12

teams4

ticket-forms3

training-data6

user2

user-roles1

user-statuses1

users2

voice_calls1

contacts

Search for contacts by a given filter

Changed on Nov 1, 2026

Filterable fields and their allowed operators:

Field	Allowed operators
id	equals, in, not_in
email	equals, in, not_in, string_contains
name	equals, in, not_in, string_contains
account_id	equals, in, not_in

For custom fields, pass the field slug as field.

Rate limit: 120 requests per minute

post/contacts/search

Request

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

Request body

cursorstring

The cursor to use for pagination.

limitinteger

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

search_textstring

Text search across contact name, primary email, secondary emails, primary phone number, and secondary phone numbers. Results are intersected with any provided filter.

Example request

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

Response

request_idstring required

The request ID for tracking.

Example response

{
  "data": [
    {
      "custom_fields": {
        "role": {
          "value": "admin"
        }
      }
    }
  ]
}

Changes

Nov 1, 20268522e66913b4 Revision 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 /
Oct 11, 2026dfb481067e5a Revision changes
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the response property // became nullable for the status
- breaking
  the // response's property type changed from object to no type for status
- warning
  removed the optional property /// from the response with the status
- warning
  removed the optional property /// from the response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added to the // response property allOf list for the response status
- info
  the response property became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property //// became required for the status
- info
  the response property //// became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  removed the admin enum value from the // response property for the response status
- info
  removed the duplicate_object enum value from the response property for the response status
- info
  removed the email_bounced enum value from the response property for the response status
- info
  removed the internal_error enum value from the response property for the response status
- info
  removed the internal_issue_reply_not_allowed enum value from the response property for the response status
- info
  removed the invalid_api_token enum value from the response property for the response status
- info
  removed the invalid_authorization_header enum value from the response property for the response status
- info
  removed the invalid_oauth_token enum value from the response property for the response status
- info
  removed the invalid_request_body enum value from the response property for the response status
- info
  removed the invalid_webhook_credentials enum value from the response property for the response status
- info
  removed the member enum value from the // response property for the response status
- info
  removed the method_not_allowed enum value from the response property for the response status
- info
  removed the no_access enum value from the // response property for the response status
- info
  removed the not_found enum value from the response property for the response status
- info
  removed the oauth_not_permitted enum value from the response property for the response status
- info
  removed the organization_deactivated enum value from the response property for the response status
- info
  removed the organization_inactive enum value from the response property for the response status
- info
  removed the organization_suspended enum value from the response property for the response status
- info
  removed the payload_too_large enum value from the response property for the response status
- info
  removed the permission_denied enum value from the response property for the response status
- info
  removed the rate_limited enum value from the response property for the response status
- info
  removed the recipients_suppressed enum value from the response property for the response status
- info
  removed the wrong_region_token enum value from the response property for the response status

Operation history (6 revisions)