v1
latestOpenAPI 3.0.02026-08-062438369.6 KBForms
Get all forms
Returns a paginated list of all forms for your organization. By default, archived (soft-deleted) forms are excluded; pass include_archived=true to include them. Use the date filters to retrieve only forms created or updated within a specific time window.
get/forms
Query parameters
name_likestring
The form name, or part of a name, to search for.
created_beforestring date-time
Date the Form was created on or before.
created_afterstring date-time
Date the Form was created on or after
updated_beforestring date-time
Date the Form was updated on or before.
updated_afterstring date-time
Date the Form was updated on or after
include_archived'true' | 'false'
This flag will include archived forms.
Response
Returns the paginated list of forms for your organization. The response includes pagination links and meta fields to navigate additional pages.
Example response
{
"data": [
{
"type": "form",
"id": 1,
"name": "Volunteer Application",
"form_type": "PROJECT",
"slug": "2d8614a5-31ed-4810-8da2-448f59463e43",
"description": "Thank you for supporting our organization. This is a standard application required for volunteering with us.",
"author_id": 1,
"organization_id": 1,
"created_at": "2016-03-07T07:49:41+00:00",
"updated_at": "2016-03-07T07:49:41+00:00",
"deleted_at": "2016-03-07T07:49:41+00:00",
"fields": [
{
"type": "form_field",
"id": 1,
"name": "T-shirt Size",
"description": "Please select a T-Shirt size",
"field_type": "DROPDOWN",
"slug": "2d8614a5-31ed-4810-8da2-448f59463e43",
"show_in_profile": true,
"options": [
{
"type": "field_option",
"id": 1,
"name": "Small",
"value": "S",
"enabled": true
}
]
}
]
}
]
}