chatformdocs
API referenceV1

List a form's responses, newest first

GET
/v1/forms/{id}/responses

Authorization

AuthorizationBearer <token>

A server-side secret key. Never send one from a browser — a request carrying an Origin header is refused for this reason.

In: header

Path Parameters

id*string

Query Parameters

status?string
source?string
mode?string

Value in

  • "live"
  • "test"
  • "all"
created_after?number
created_before?number
updated_since?number
ending_ref?string
q?string
Lengthlength <= 200
order?string
Default"created"

Value in

  • "created"
  • "updated"
include?string
limit?integer
Range1 <= value <= 100
Default25
cursor?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/forms/string/responses"
{  "data": [    {      "id": "string",      "object": "response",      "form_id": "string",      "status": "in_progress",      "source": "chat",      "mode": "live",      "started_at": 0,      "updated_at": 0,      "completed_at": 0,      "expires_at": 0,      "duration_ms": 0,      "ending_ref": "string",      "abandon_reason": "string",      "metadata": {        "channel": "link",        "pageUrl": "string",        "referrer": "string",        "referrerHost": "string",        "utm": {          "property1": "string",          "property2": "string"        },        "language": "string",        "screen": "string",        "timezone": "string",        "device": {          "type": "mobile",          "browser": "string",          "browserVersion": "string",          "os": "string",          "osVersion": "string"        },        "geo": {          "country": "string",          "region": "string",          "regionCode": "string",          "city": "string",          "postalCode": "string",          "latitude": 0,          "longitude": 0,          "continent": "string",          "timezone": "string"        },        "network": {          "asn": 0,          "organization": "string"        }      },      "progress": {        "answered": 0,        "totalEstimate": 0,        "pct": 0      },      "variables": {        "property1": null,        "property2": null      },      "hidden_fields": {        "property1": null,        "property2": null      },      "next": {        "kind": "block",        "block": {          "id": "string",          "ref": "string",          "type": "string",          "title": "string",          "required": true,          "imageKey": "string",          "media": null,          "property1": null,          "property2": null        }      },      "complete_ready": true,      "missing_required": [        {          "ref": "string",          "title": "string"        }      ],      "off_path_answers": [        "string"      ],      "answers": [        {          "ref": "string",          "type": "string",          "value": null        }      ],      "recorded": [        {          "ref": "string",          "value": null        }      ],      "property1": null,      "property2": null    }  ],  "has_more": true,  "next_cursor": "string"}

List a form's payment attempts, newest first

Every checkout opened on a verified payment block, including the ones that never became an answer — a payment that arrived after the respondent left, a duplicate from a second tab, a failure. `status` defaults to `all`. Amounts are given both in minor units (`amount_minor`, what the gateway charged) and major units. Pass `next_cursor` back as `cursor` for the next page.

Every setting a form has, by key, with its current value

The settings you can change with `PATCH /v1/forms/{id}/settings`: colours and fonts, the interviewer's tone and goal, who can respond, when the form closes, emails, sharing and embedding. Each carries the builder's label, where it lives in the builder, the values it takes, and `locked` when your plan does not include it.