List forms
GET /forms/{form}/responses. Parameters, permissions, request and response schemas.
GET /forms/{form}/responses
List forms. Requires the REST read token ability. The bearer token selects the Team; a supplied team_id cannot switch tenants. Additional role, entity-policy and plan requirements vary by operation.
Authentication
Use a team API key as Authorization: Bearer YOUR_API_KEY. The token ability and the user’s role must both allow this operation. See authentication.
{
"ability": "read",
"team": "Token-bound Team",
"authorization": "Additional role, entity-policy and plan requirements vary by operation."
}Parameters
| Name | Location | Required | Description |
|---|---|---|---|
form | path | Yes | The form ID |
page[number] | query | No | Page number, starting at 1. |
page[size] | query | No | Results per page. Values above the configured maximum are capped. |
sort | query | No | Comma-separated sort fields; prefix a field with - for descending order. Allowed: id, status, submitted_at, created_at, updated_at. |
filter[status] | query | No | Filter by status. Values use the endpoint’s configured matching; comma-separated values are supported by standard exact filters. |
form
{
"type": "integer",
"minimum": 1
}page[number]
{
"type": "integer",
"minimum": 1,
"default": 1
}page[size]
{
"type": "integer",
"minimum": 1,
"maximum": 30,
"default": 30
}sort
{
"type": "string"
}filter[status]
{
"type": "string"
}Example request
curl --request GET 'https://api.example.test/api/forms/1/responses' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Accept: application/json'Examples use fictional data. Replace resource IDs and the API host with your environment’s values.
Responses
200
Array of FormResponseResource
Content type: application/json.
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"form_id": {
"type": "integer"
},
"response_key": {
"type": [
"string",
"null"
]
},
"respondent_id": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"page_url": {
"type": [
"string",
"null"
]
},
"user_agent": {
"type": [
"string",
"null"
]
},
"referrer": {
"type": [
"string",
"null"
]
},
"language": {
"type": [
"string",
"null"
]
},
"timezone": {
"type": [
"string",
"null"
]
},
"viewport_width": {
"type": [
"integer",
"null"
]
},
"viewport_height": {
"type": [
"integer",
"null"
]
},
"screen_width": {
"type": [
"integer",
"null"
]
},
"screen_height": {
"type": [
"integer",
"null"
]
},
"client_type": {
"type": [
"string",
"null"
]
},
"browser_name": {
"type": [
"string",
"null"
]
},
"browser_version": {
"type": [
"string",
"null"
]
},
"os_name": {
"type": [
"string",
"null"
]
},
"os_version": {
"type": [
"string",
"null"
]
},
"device_type": {
"type": [
"string",
"null"
]
},
"is_bot": {
"type": "boolean"
},
"answers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"form_response_id": {
"type": "integer"
},
"form_question_id": {
"type": "integer"
},
"value": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"form_response_id",
"form_question_id",
"value",
"created_at",
"updated_at"
],
"title": "FormAnswerResource"
}
},
"submitted_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"form_id",
"response_key",
"respondent_id",
"status",
"page_url",
"user_agent",
"referrer",
"language",
"timezone",
"viewport_width",
"viewport_height",
"screen_width",
"screen_height",
"client_type",
"browser_name",
"browser_version",
"os_name",
"os_version",
"device_type",
"is_bot",
"submitted_at",
"created_at",
"updated_at"
],
"title": "FormResponseResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}{
"data": [
{
"id": 101,
"form_id": 101,
"response_key": null,
"respondent_id": null,
"status": "example",
"page_url": null,
"user_agent": null,
"referrer": null,
"language": null,
"timezone": null,
"viewport_width": null,
"viewport_height": null,
"screen_width": null,
"screen_height": null,
"client_type": null,
"browser_name": null,
"browser_version": null,
"os_name": null,
"os_version": null,
"device_type": null,
"is_bot": true,
"submitted_at": null,
"created_at": null,
"updated_at": null
}
],
"links": {
"first": null,
"last": null,
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": null,
"last_page": 1,
"links": [
{
"url": null,
"label": "example",
"active": true
}
],
"path": null,
"per_page": 1,
"to": null,
"total": 1
}
}400
Unsupported filter, sort, or include.
Content type: application/json.
{
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Requested query option is not allowed."
}
},
"required": [
"message"
]
}{
"message": "Requested query option is not allowed."
}401
Unauthenticated
Content type: application/json.
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}{
"message": "The request could not be completed."
}403
Authorization error
Content type: application/json.
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}{
"message": "The request could not be completed."
}404
Not found
Content type: application/json.
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}{
"message": "The request could not be completed."
}422
Validation error
Content type: application/json.
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Errors overview."
},
"errors": {
"type": "object",
"description": "A detailed description of each field that failed validation.",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": [
"message",
"errors"
]
}{
"message": "The request could not be completed.",
"errors": {
"name": [
"The name field is required."
]
}
}429
Rate limit exceeded. Honor Retry-After before retrying.
Response headers:
{
"Retry-After": {
"description": "Seconds before retrying.",
"schema": {
"type": "integer"
}
}
}Content type: application/json.
{
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Too Many Attempts."
}
},
"required": [
"message"
]
}{
"message": "Too Many Attempts."
}See API conventions for error handling, rate limits, pagination, and uploads.