> For the complete documentation index, see [llms.txt](https://docs.usepylon.com/pylon-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.usepylon.com/pylon-docs/developer/api/api-reference/surveys.md). # Surveys ## Get all surveys > Returns all surveys for the organization.\ > \ > \*\*Rate limit:\*\* 300 requests per minute ```json {"openapi":"3.0.3","info":{"title":"Pylon API.","version":"1.0.0"},"servers":[{"description":"US region","url":"https://api.usepylon.com"},{"description":"EU region","url":"https://api.eu.usepylon.com"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"description":"Authorization: Bearer ","scheme":"bearer","type":"http"}},"responses":{"GetSurveysResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSurveysResponseBody"}}},"description":""},"BadRequestApiResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponseBody"}}},"description":"The request was invalid or could not be completed."},"ForbiddenApiResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponseBody"}}},"description":"The authenticated caller or organization is not allowed to access this endpoint or operation."},"InternalServerErrorApiResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponseBody"}}},"description":"An unexpected internal error occurred."}},"schemas":{"GetSurveysResponseBody":{"properties":{"data":{"description":"The data payload of the response.","items":{"$ref":"#/components/schemas/Survey"},"type":"array"},"request_id":{"description":"The request ID for tracking.","type":"string"}},"type":"object"},"Survey":{"properties":{"id":{"description":"The unique identifier of the survey.","type":"string"},"name":{"description":"The name of the survey.","type":"string"},"type":{"description":"The type of the survey.","enum":["nps","csat","custom"],"type":"string"},"updated_at":{"description":"When the survey was last updated (RFC3339 format).","type":"string"}},"title":"Survey represents a survey in the API response.","type":"object"},"ErrorApiResponseBody":{"properties":{"errors":{"description":"The list of errors.","items":{"type":"string"},"type":"array"},"exists_id":{"description":"The ID of the object that already exists if this is a duplicate object error.","type":"string"},"request_id":{"description":"The request ID for tracking.","type":"string"}},"type":"object"}}},"paths":{"/surveys":{"get":{"description":"Returns all surveys for the organization.\n\n**Rate limit:** 300 requests per minute","operationId":"GetSurveys","responses":{"200":{"$ref":"#/components/responses/GetSurveysResponse"},"400":{"$ref":"#/components/responses/BadRequestApiResponse"},"403":{"$ref":"#/components/responses/ForbiddenApiResponse"},"500":{"$ref":"#/components/responses/InternalServerErrorApiResponse"}},"summary":"Get all surveys","tags":["surveys"]}}}} ``` ## Get a survey by its ID > Returns a single survey by ID.\ > \ > \*\*Rate limit:\*\* 300 requests per minute ```json {"openapi":"3.0.3","info":{"title":"Pylon API.","version":"1.0.0"},"servers":[{"description":"US region","url":"https://api.usepylon.com"},{"description":"EU region","url":"https://api.eu.usepylon.com"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"description":"Authorization: Bearer ","scheme":"bearer","type":"http"}},"responses":{"GetSurveyResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSurveyResponseBody"}}},"description":""},"BadRequestApiResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponseBody"}}},"description":"The request was invalid or could not be completed."},"ForbiddenApiResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponseBody"}}},"description":"The authenticated caller or organization is not allowed to access this endpoint or operation."},"ErrorApiResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponseBody"}}},"description":""},"InternalServerErrorApiResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponseBody"}}},"description":"An unexpected internal error occurred."}},"schemas":{"GetSurveyResponseBody":{"properties":{"data":{"$ref":"#/components/schemas/Survey"},"request_id":{"description":"The request ID for tracking.","type":"string"}},"type":"object"},"Survey":{"properties":{"id":{"description":"The unique identifier of the survey.","type":"string"},"name":{"description":"The name of the survey.","type":"string"},"type":{"description":"The type of the survey.","enum":["nps","csat","custom"],"type":"string"},"updated_at":{"description":"When the survey was last updated (RFC3339 format).","type":"string"}},"title":"Survey represents a survey in the API response.","type":"object"},"ErrorApiResponseBody":{"properties":{"errors":{"description":"The list of errors.","items":{"type":"string"},"type":"array"},"exists_id":{"description":"The ID of the object that already exists if this is a duplicate object error.","type":"string"},"request_id":{"description":"The request ID for tracking.","type":"string"}},"type":"object"}}},"paths":{"/surveys/{id}":{"get":{"description":"Returns a single survey by ID.\n\n**Rate limit:** 300 requests per minute","operationId":"GetSurvey","parameters":[{"description":"The ID of the survey.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/GetSurveyResponse"},"400":{"$ref":"#/components/responses/BadRequestApiResponse"},"403":{"$ref":"#/components/responses/ForbiddenApiResponse"},"404":{"$ref":"#/components/responses/ErrorApiResponse"},"500":{"$ref":"#/components/responses/InternalServerErrorApiResponse"}},"summary":"Get a survey by its ID","tags":["surveys"]}}}} ``` ## Get survey responses for a survey > Returns paginated survey responses visible to the caller, optionally filtered by time range, account, or contact.\ > \ > \*\*Rate limit:\*\* 300 requests per minute ```json {"openapi":"3.0.3","info":{"title":"Pylon API.","version":"1.0.0"},"servers":[{"description":"US region","url":"https://api.usepylon.com"},{"description":"EU region","url":"https://api.eu.usepylon.com"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"description":"Authorization: Bearer ","scheme":"bearer","type":"http"}},"responses":{"GetSurveyResponsesResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSurveyResponsesResponseBody"}}},"description":""},"BadRequestApiResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponseBody"}}},"description":"The request was invalid or could not be completed."},"ForbiddenApiResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponseBody"}}},"description":"The authenticated caller or organization is not allowed to access this endpoint or operation."},"ErrorApiResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponseBody"}}},"description":""},"InternalServerErrorApiResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponseBody"}}},"description":"An unexpected internal error occurred."}},"schemas":{"GetSurveyResponsesResponseBody":{"properties":{"data":{"description":"The data payload of the response.","items":{"$ref":"#/components/schemas/SurveyResponse"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"},"request_id":{"description":"The request ID for tracking.","type":"string"}},"type":"object"},"SurveyResponse":{"properties":{"account_id":{"description":"The ID of the account associated with the response.","type":"string"},"answers":{"description":"The answers submitted in this response.","items":{"$ref":"#/components/schemas/SurveyResponseAnswer"},"type":"array"},"contact_id":{"description":"The ID of the contact who submitted the response.","type":"string"},"excluded_at":{"description":"When the response was excluded from analytics.","format":"date-time","type":"string"},"id":{"description":"The unique identifier of the survey response.","type":"string"},"issue_id":{"description":"The ID of the issue associated with this response, when applicable.","type":"string"},"submitted_at":{"description":"When the response was submitted.","format":"date-time","type":"string"},"survey_id":{"description":"The ID of the survey template associated with this response.","type":"string"},"survey_instance_id":{"description":"The ID of the individual survey delivery that produced this response.","type":"string"},"survey_type":{"description":"The type of survey associated with this response.","enum":["nps","csat","custom"],"type":"string"}},"title":"SurveyResponse represents a survey response in the API.","type":"object"},"SurveyResponseAnswer":{"properties":{"prompt":{"description":"The prompt/question that was answered.","type":"string"},"question_id":{"description":"The ID of the survey question, when applicable.","type":"string"},"question_type":{"description":"The type of question (score or comment).","type":"string"},"value":{"description":"The value of the answer.","type":"string"}},"title":"SurveyResponseAnswer represents an answer in a survey response.","type":"object"},"Pagination":{"properties":{"cursor":{"description":"The cursor for the next page of results.","type":"string"},"has_next_page":{"description":"Indicates if there is a next page of results.","type":"boolean"}},"required":["cursor","has_next_page"],"type":"object"},"ErrorApiResponseBody":{"properties":{"errors":{"description":"The list of errors.","items":{"type":"string"},"type":"array"},"exists_id":{"description":"The ID of the object that already exists if this is a duplicate object error.","type":"string"},"request_id":{"description":"The request ID for tracking.","type":"string"}},"type":"object"}}},"paths":{"/surveys/{id}/responses":{"get":{"description":"Returns paginated survey responses visible to the caller, optionally filtered by time range, account, or contact.\n\n**Rate limit:** 300 requests per minute","operationId":"GetSurveyResponses","parameters":[{"description":"The ID of the survey.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Filter responses submitted after this time (RFC3339 format).","in":"query","name":"submitted_after","schema":{"type":"string"}},{"description":"Filter responses submitted before this time (RFC3339 format).","in":"query","name":"submitted_before","schema":{"type":"string"}},{"description":"Filter responses by account ID. Required with contact_id when the caller has scoped account or contact access.","in":"query","name":"account_id","schema":{"type":"string"}},{"description":"Filter responses by contact ID. Required with account_id when the caller has scoped account or contact access.","in":"query","name":"contact_id","schema":{"type":"string"}},{"description":"The cursor for pagination.","in":"query","name":"cursor","schema":{"type":"string"}},{"description":"The number of responses to fetch. Defaults to 100. Must be greater than 0 and less than 1000.","in":"query","name":"limit","schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/GetSurveyResponsesResponse"},"400":{"$ref":"#/components/responses/BadRequestApiResponse"},"403":{"$ref":"#/components/responses/ForbiddenApiResponse"},"404":{"$ref":"#/components/responses/ErrorApiResponse"},"500":{"$ref":"#/components/responses/InternalServerErrorApiResponse"}},"summary":"Get survey responses for a survey","tags":["surveys"]}}}} ``` ## Search for surveys by a given filter > Filterable fields and their allowed operators:\ > \ > Field | Allowed operators |\ > \--- | --- |\ > \`updated\_at\` | \`time\_is\_after\`, \`time\_is\_before\`, \`time\_range\` |\ > \ > Timestamp values use RFC3339 format.\ > \ > \*\*Rate limit:\*\* 120 requests per minute ```json {"openapi":"3.0.3","info":{"title":"Pylon API.","version":"1.0.0"},"servers":[{"description":"US region","url":"https://api.usepylon.com"},{"description":"EU region","url":"https://api.eu.usepylon.com"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"description":"Authorization: Bearer ","scheme":"bearer","type":"http"}},"schemas":{"SearchSurveysRequest":{"properties":{"filter":{"$ref":"#/components/schemas/Filter"},"limit":{"description":"The number of surveys to fetch. Defaults to 100. Must be greater than 0 and less than 1000.","format":"int64","type":"integer"}},"type":"object"},"Filter":{"properties":{"field":{"description":"The field for this filter. For allowed fields, see the documentation for\nthe specific endpoint you are using.\nFor non-compound filters (any operators other than \"and\" or \"or\"),\nfield must be set, along with either value or values, depending on the operator.","type":"string"},"operator":{"description":"The operator for this filter.","enum":["equals","not_equals","contains","does_not_contain","in","not_in","and","or","time_is_after","time_is_before","time_range","string_contains","string_does_not_contain","is_set","is_unset","greater_than","less_than","greater_than_or_equals","less_than_or_equals"],"type":"string"},"subfilters":{"description":"Sub-filters for this filter. Valid only when operator is \"and\" or \"or\".\nThe maximum allowed depth for a tree of filters is 3.","items":{"$ref":"#/components/schemas/Filter"},"type":"array"},"value":{"description":"The value for this filter. Only used for single-valued operators\n(\"equals\", \"not_equals\", \"contains\", \"does_not_contain\")","type":"string"},"values":{"description":"The values for this filter. Only used for multi-valued operators (\"in\", \"not_in\").","items":{"type":"string"},"type":"array"}},"required":["operator"],"type":"object"},"SearchSurveysResponseBody":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Survey"},"type":"array"},"request_id":{"type":"string"}},"type":"object"},"Survey":{"properties":{"id":{"description":"The unique identifier of the survey.","type":"string"},"name":{"description":"The name of the survey.","type":"string"},"type":{"description":"The type of the survey.","enum":["nps","csat","custom"],"type":"string"},"updated_at":{"description":"When the survey was last updated (RFC3339 format).","type":"string"}},"title":"Survey represents a survey in the API response.","type":"object"},"ErrorApiResponseBody":{"properties":{"errors":{"description":"The list of errors.","items":{"type":"string"},"type":"array"},"exists_id":{"description":"The ID of the object that already exists if this is a duplicate object error.","type":"string"},"request_id":{"description":"The request ID for tracking.","type":"string"}},"type":"object"}},"responses":{"SearchSurveysResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchSurveysResponseBody"}}},"description":""},"BadRequestApiResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponseBody"}}},"description":"The request was invalid or could not be completed."},"ForbiddenApiResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorApiResponseBody"}}},"description":"The authenticated caller or organization is not allowed to access this endpoint or operation."}}},"paths":{"/surveys/search":{"post":{"description":"Filterable fields and their allowed operators:\n\n Field | Allowed operators |\n --- | --- |\n `updated_at` | `time_is_after`, `time_is_before`, `time_range` |\n\nTimestamp values use RFC3339 format.\n\n**Rate limit:** 120 requests per minute","operationId":"SearchSurveys","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchSurveysRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/SearchSurveysResponse"},"400":{"$ref":"#/components/responses/BadRequestApiResponse"},"403":{"$ref":"#/components/responses/ForbiddenApiResponse"}},"summary":"Search for surveys by a given filter","tags":["surveys"]}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.usepylon.com/pylon-docs/developer/api/api-reference/surveys.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.