Surveys

Get all surveys

get

Returns all surveys for the organization.

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400Error

application/json

500Error

application/json

get

/surveys

HTTPcURLJavaScriptPython

GET /surveys HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "type": "nps",
      "updated_at": "text"
    }
  ],
  "request_id": "text"
}

Get a survey by its ID

get

Returns a single survey by ID.

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the survey.

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400Error

application/json

404Error

application/json

500Error

application/json

get

/surveys/{id}

HTTPcURLJavaScriptPython

GET /surveys/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "id": "text",
    "name": "text",
    "type": "nps",
    "updated_at": "text"
  },
  "request_id": "text"
}

Get survey responses for a survey

get

Returns paginated survey responses, optionally filtered by time range, account, or contact.

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the survey.

Query parameters

submitted_afterstringOptional

Filter responses submitted after this time (RFC3339 format).

submitted_beforestringOptional

Filter responses submitted before this time (RFC3339 format).

account_idstringOptional

Filter responses by account ID.

contact_idstringOptional

Filter responses by contact ID.

cursorstringOptional

The cursor for pagination.

limitinteger · int64Optional

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

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400Error

application/json

404Error

application/json

500Error

application/json

get

/surveys/{id}/responses

HTTPcURLJavaScriptPython

GET /surveys/{id}/responses HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "account_id": "text",
      "answers": [
        {
          "prompt": "text",
          "question_type": "text",
          "value": "text"
        }
      ],
      "contact_id": "text",
      "id": "text",
      "submitted_at": "2026-03-20T11:04:49.191Z"
    }
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": true
  },
  "request_id": "text"
}

Search for surveys by a given filter

post

Currently, the following fields are filterable for surveys:

• updated_at (in RFC3339 format). Allowed operators: time_is_after, time_is_before, time_range

Rate limit: 20 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Body

application/json

limitinteger · int64Optional

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

Responses

200Success

application/json

request_idstringOptional

400Error

application/json

post

/surveys/search

HTTPcURLJavaScriptPython

POST /surveys/search HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 296

{
  "filter": {
    "field": "text",
    "operator": "equals",
    "subfilters": [
      {
        "field": "text",
        "operator": "equals",
        "subfilters": [
          {
            "field": "text",
            "operator": "equals",
            "subfilters": "[Circular Reference]",
            "value": "text",
            "values": [
              "text"
            ]
          }
        ],
        "value": "text",
        "values": [
          "text"
        ]
      }
    ],
    "value": "text",
    "values": [
      "text"
    ]
  },
  "limit": 1
}

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "type": "nps",
      "updated_at": "text"
    }
  ],
  "request_id": "text"
}