Surveys

get

Get a survey by its ID

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the survey.

Responses

200Success

application/json

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"
  },
  "request_id": "text"
}

get

Get survey responses for a survey

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

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-02-06T02:07:32.965Z"
    }
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": true
  },
  "request_id": "text"
}