USusepylon
surveys

Search for surveys by a given filter

Changed on

Filterable fields and their allowed operators:

FieldAllowed operators
updated_attime_is_after, time_is_before, time_range

Timestamp values use RFC3339 format.

Rate limit: 120 requests per minute

post/surveys/search

Request

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

Request body

limitinteger

The number of surveys 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

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 /

  • dfb481067e5aRevision changes
    • 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

      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 csat enum value from the // response property for the response status

    • info

      removed the custom 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 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 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_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_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 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 nps 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_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 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 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 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