chatformdocs
API referenceV1

List forms

GET
/v1/forms

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

Query Parameters

status?string
Default"all"

Value in

  • "draft"
  • "published"
  • "archived"
  • "all"
limit?integer
Range1 <= value <= 100
Default25
cursor?string

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/forms"
{  "data": [    {      "id": "string",      "title": "string",      "slug": "string",      "status": "string",      "published": true,      "created_at": 0,      "updated_at": 0    }  ],  "has_more": true,  "next_cursor": "string"}

A respondent's uploaded file, inline

The file's bytes in the JSON body under the same API key: UTF-8 text for text types, base64 otherwise. For a caller that cannot fetch `download_url`. Files over 4 MB answer 413; use `download_url` for those.

Read a form: its public config, or the document behind it

Without `view`, this answers the published form exactly as a respondent receives it. A form with no published version has only a draft, so that is what comes back instead -- the same body as `view=document`, with `status` saying which you are looking at. Pass `view=document` to read the draft of a form that is already live.