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 (Optional) The id of the form. number
limit (Optional) The maximum number of follow-ups to return. Max 500. Defaults to 100. Use page to fetch additional records. 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
status (Optional) Filter follow-ups by whether they are open or closed. Defaults to including all follow-ups. all or undefined includes all follow-ups. open only includes pending follow-ups. closed only includes completed follow-ups. overdue only includes overdue follow-ups. string
observer_id (Optional) Filters follow-ups by the user id of the observer who originally created the follow-up. string
assignee_id (Optional) Filters follow-ups by the user id of the person who the follow-up is currently assigned to. string
response_id (Optional) Filters follow-ups by the form response where it was created. number
created_before (Optional) Only include follow-ups created before the given date. Should be formatted as the number of milliseconds since 1970. number
created_after (Optional) Only include follow-ups created after the given date. Should be formatted as the number of milliseconds since 1970. number
updated_before (Optional) Only include follow-ups updated before the given date. Should be formatted as the number of milliseconds since 1970. number
updated_after (Optional) Only include follow-ups updated after the given date. Should be formatted as the number of milliseconds since 1970. number