List selectable form fields
GET /v1/forms/fields
- Scope
forms:read- Roles
- admin, scheduler
Retrieve default (module-specific) or custom (org-wide reusable) field definitions for the form builder's field picker. For options=custom, each item is annotated with usage stats (active/historical forms, submission count) so the caller can build its own delete or archive confirmation.
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
options required | string | Which set of fields to return. One of: |
module | string | Module key, required when options=default. One of: |
type | string | When module=request, disambiguates to client_request or consumer_request. One of: |
assignTo | string | For assignment/shift default fields: 'client' or 'organization'. One of: |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/forms/fields?options=" \
-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": 1,
"fieldId": 1,
"fieldKey": "string",
"label": "string",
"type": "string",
"module": "string",
"isDefault": true,
"isRequired": true,
"isVisible": true,
"isArchived": true,
"order": 1,
"settings": [],
"isAlreadyUsed": true,
"activeFormsCount": "string",
"historicalFormsCount": "string",
"submissionsCount": "string",
"canPermanentlyDelete": true,
"canArchive": true,
"activeForms": [],
"historicalForms": []
}
]
}Response fields (22)
2 top-level fields; 1 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object (20 nested) |
Nested fields
data 20 fields
| Field | Type | Description |
|---|---|---|
data[].id | integer | Example |
data[].fieldId | integer | Example |
data[].fieldKey | string | Example |
data[].label | string | Example |
data[].type | string | Example |
data[].module | string | Example |
data[].isDefault | boolean | Example |
data[].isRequired | boolean | Example |
data[].isVisible | boolean | Example |
data[].isArchived | boolean | Example |
data[].order | integer | Example |
data[].settings | array of object | |
data[].isAlreadyUsed | boolean | Example |
data[].activeFormsCount | string | Example |
data[].historicalFormsCount | string | Example |
data[].submissionsCount | string | Example |
data[].canPermanentlyDelete | boolean | Example |
data[].canArchive | boolean | Example |
data[].activeForms | array of object | |
data[].historicalForms | array of object |
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 |
422 Validation failed
Validation failed
{
"success": false,
"message": "Unable to save. Please check the highlighted fields",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Details when the handler has them — a field-keyed object, a single string, or null. |
code | string | Empty unless the handler sets one. 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: |