custom-objects

Search for custom objects by a given filter

Changed on

Filterable fields and their allowed operators:

FieldAllowed operators
nameequals, in, not_in, string_contains, string_does_not_contain, is_set, is_unset
accountequals, in, not_in, is_set, is_unset
created_attime_is_after, time_is_before, time_range
updated_attime_is_after, time_is_before, time_range

account is the built-in Account relationship field present on every custom object type; its values are account IDs. Timestamp values use RFC3339 format. For custom fields, pass the field slug as field.

A {type} of opportunity is an alias for the opportunities API and filters on a different set of fields:

FieldAllowed operators
nameequals, in, not_in, string_contains
account_idequals, in, not_in
sourceequals, in, not_in
created_attime_is_after, time_is_before, time_range

Rate limit: 120 requests per minute

post/custom-objects/{type}/search

Request

  • Base URL
    https://api.usepylon.com
  • URL
    https://api.usepylon.com/custom-objects/{type}/search
  • Auth
    HTTP bearer

Path parameters

typestring required

The type slug of the custom object (e.g. "companies").

Request body

cursorstring

The cursor to use for pagination.

limitinteger

The number of results to fetch. Defaults to 25, max 100.

Example request

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

Response

request_idstring required

Example response

{
  "data": [
    {
      "custom_fields": {
        "priority": {
          "value": "high"
        }
      }
    }
  ]
}

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 /

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with 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

      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 duplicate_object 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 duplicate_object 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 email_bounced 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 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_error 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_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 internal_issue_reply_not_allowed 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 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_api_token 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_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_authorization_header 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_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_oauth_token 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_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_request_body 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_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 invalid_webhook_credentials 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 invalid_webhook_credentials 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 method_not_allowed 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 method_not_allowed 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 not_found 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 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 oauth_not_permitted 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 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_deactivated 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_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_inactive 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_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 organization_suspended 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 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 payload_too_large 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 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 permission_denied 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 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 rate_limited 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 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 recipients_suppressed 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 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

    • info

      removed the wrong_region_token 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

    • info

      removed the wrong_region_token enum value from the response property for the response status