List all forms
GET /v1/forms
- Scope
forms:read- Roles
- admin, scheduler
Retrieve a paginated list of forms with filtering and search capabilities.
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
page | integer | Page number |
search | string | Search by name, description, or form code |
scope | string | Filter by scope (internal, external) One of: |
localSearch | string | Search within the current results. |
formType | string | Filter by form type. One of: |
moduleType | string | Filter by module (assignment, shift, client, consumer, …). Send all to ignore the filter. |
status | string | Filter by status id. |
isPublished | boolean | Filter published (true) or draft (false) forms. |
startDate | string (date) | |
endDate | string (date) | |
sortBy | string | |
sortOrder | string | One of: |
perPage | integer | Rows per page (default 10). Example |
columns | string | Comma-separated columns to search in. |
assignedTo | string | Filter by the Assign To column: forms bound to this client, consumer or provider ID. Blank means no filter. Example |
assignTo | string | Older name for assignedTo, read only when assignedTo is blank. Example |
externalVisibility | string | Filter by the External Visibility column. Returns external forms only. One of: |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/forms" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Successful operation
Successful operation
{
"success": true,
"data": [
{
"id": "string",
"name": "Example name",
"description": "Short human-readable description.",
"isPublished": true,
"formType": "string",
"moduleType": {
"id": "string",
"label": "Example label"
},
"status": {
"id": 1,
"label": "Example label"
},
"version": 1,
"scope": "string",
"assignedTo": "string",
"usage": 1,
"lastUsedDate": "2026-01-15",
"customFields": 1,
"lastUpdated": "string",
"externalVisibility": {
"id": "private",
"label": "Private"
}
}
],
"meta": {
"currentPage": 1,
"lastPage": 1,
"perPage": 10,
"total": 2
}
}Response fields (28)
3 top-level fields; 2 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object (21 nested) | |
meta | object (4 nested) |
Nested fields
data 21 fields
| Field | Type | Description |
|---|---|---|
data[].id | string | Example |
data[].name | string | Example |
data[].description | string | Example |
data[].isPublished | boolean | Example |
data[].formType | string | Example |
data[].moduleType | object | |
data[].moduleType.id | string | Example |
data[].moduleType.label | string | Example |
data[].status | object | |
data[].status.id | integer | Example |
data[].status.label | string | Example |
data[].version | integer | Example |
data[].scope | string | Example |
data[].assignedTo | string | Example |
data[].usage | integer | Example |
data[].lastUsedDate | string (date) | Example |
data[].customFields | integer | Example |
data[].lastUpdated | string | Example |
data[].externalVisibility | object | |
data[].externalVisibility.id | string | Example |
data[].externalVisibility.label | string | Example |
meta 4 fields
| Field | Type | Description |
|---|---|---|
meta.currentPage | integer | Example |
meta.lastPage | integer | Example |
meta.perPage | integer | Example |
meta.total | integer | Example |
401 Not signed in
Missing, invalid or expired API key.
{
"success": false,
"message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
"errors": null,
"code": "API_KEY_MISSING"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"success": false,
"message": "You don't have permission to access this endpoint. This API key is missing the 'forms:read' scope.",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"success": false,
"message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
"errors": null,
"code": "RATE_LIMITED"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |