latestOpenAPI 3.0.02026-08-216686147.9 KB
6f6009a58cdd
forms
engagements
List Forms attached to the specified Engagement or Engagement Template
get/v1/engagements/{uuid}/forms
Path parameters
uuidstring uuid required
The UUID of the Engagement or Engagement Template to retrieve Forms for
Query parameters
pagenumber nullable
per_pagenumber nullable
sort_order'asc' | 'desc'
Sort order for paginated results. Use desc to reverse the default ascending order.
Response
The visible active Forms attached to the Engagement or Engagement Template
Example response
{
"data": [
{
"uuid": "4d50d252-be0c-4d69-b77a-5bbdfef83f54",
"name": "Client acceptance form",
"description": "Standard client acceptance questions",
"created_at": "2026-02-01T12:30:00.000Z",
"updated_at": "2026-03-10T12:30:00.000Z",
"_links": {
"fieldguide": {
"href": "https://example.com/resource/or/path",
"title": "A description for the link",
"type": "text/html"
}
}
}
],
"_links": {
"self": {
"href": "https://api.fieldguide.io/v1/example?page=2&per_page=50"
},
"first": {
"href": "https://api.fieldguide.io/v1/example?page=1&per_page=50"
},
"last": {
"href": "https://api.fieldguide.io/v1/example?page=10&per_page=50"
},
"previous": {
"href": "https://api.fieldguide.io/v1/example?page=1&per_page=50"
},
"next": {
"href": "https://api.fieldguide.io/v1/example?page=3&per_page=50"
}
}
}