This is intended to help conceptualize requests.

We recommend tools such as Postman or ApiDog for development and testing.

Advanced
Parameter Description TypeScript Value
token (Required) Your API Token string
pretty (Optional) true means the response json will include white space for readability. Default is false. boolean
form_id (Required) The id of the form. number
limit (Optional) The maximum number of responses to return. Max 1000. Defaults to 100. Use page to fetch additional responses. number
page (Optional) The page of responses to return. Defaults to 1. The response field paging.last_page tells you what the last valid page number is. number
observer_id (Optional) Filters responses by the user id of the observer. string
before (Optional) Only include responses submitted before the given date. Should be formatted as the number of milliseconds since 1970 UTC. number
after (Optional) Only include responses submitted after the given date. Should be formatted as the number of milliseconds since 1970 UTC. number
updated_before (Optional) Only include responses that have been updated before the given date. Should be formatted as the number of milliseconds since 1970 UTC. number
updated_after (Optional) Only include responses that have been updated after the given date. Should be formatted as the number of milliseconds since 1970 UTC. number
format (Optional) Choose whether the response should be in `json` or `csv` format. `json` is the default. string
columns (Optional) The column names that should be fetched. If no columns are provided then all columns will be returned. string[]
response_ids (Optional) The response ids that should be fetched. May not be an empty array. If this is omitted or empty then all responses are included. number[]
deleted (Optional) false (default): only returns non-deleted responses. true: only returns deleted responses. boolean
skip_field_id_mapping (Optional) CSV format only. false (default): includes field-id to field-title mapping row. true: omits field-id to field-title mapping row. boolean
skip_field_id_mapping_json (Optional) JSON format only. false (default): includes field-id to field-title mapping row. true: omits field-id to field-title mapping row. boolean
force_date_format (Optional) Forces all date formats to conform to: YYYY-MM-DD HH:mm:ss boolean