Fetch custom-fields schema for a module (add-mode)
GET /v1/forms/module-fields/{module}
- Scope
forms:read- Roles
- admin, scheduler
Returns an array of customFields response shapes (form + groups + fields with default values) — one entry per active internal form matching the given scope, merged with the module's generic form. Used when rendering the add screen for a module that does not yet have a record.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
module required | string | Module key (client, consumer, assignment, shift, service-provider, client-location) One of: |
Query parameters
| Name | Type | Description |
|---|---|---|
assignTo | string | Form scope for assignment/shift: 'organization' (generic) or 'client' (client-specific, with clientId). One of: |
clientId | string | Client id (CLT-…) to fetch the client-specific form for assignment/shift/client-location. Example |
locationId | string | Client location id (CLTLOC-…) to fetch the location-specific form (client-location). Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/forms/module-fields/{module}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Form fields retrieved, or null when no active form applies
Form fields retrieved, or null when no active form applies.
{
"success": true,
"message": "Form fields retrieved!",
"data": [
{
"form": {
"id": "FRM-7KQ2PA",
"name": "Intake",
"description": "string",
"isPublished": true,
"formType": "internal",
"moduleType": {
"id": "client",
"label": "Client"
},
"status": {
"id": 1,
"label": "Active"
},
"assignTo": {
"id": "organization",
"label": "Organization",
"isCustom": false
},
"version": 2,
"multiStep": false,
"reviewStep": false,
"externalVisibility": {
"id": "private",
"label": "Private"
},
"lastUsedDate": "01/15/2025",
"settings": {}
},
"startsStep": 1,
"groups": [
{
"label": "Contact",
"isRequired": false,
"isArchived": false,
"fields": [
null
]
}
]
}
]
}Response fields (44)
3 top-level fields; 1 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | array of object or null (41 nested) | One entry per active form in scope, each in the same shape the form-details endpoint returns, with each field's empty value filled in, archived placements dropped and a usage count attached. Sent as null — not an empty array — when no active form applies. |
Nested fields
data 41 fields
| Field | Type | Description |
|---|---|---|
data[].form | object | |
data[].form.id | string | The form code. Example |
data[].form.name | string | Example |
data[].form.description | string or null | |
data[].form.isPublished | boolean | Example |
data[].form.formType | string or null | Example |
data[].form.moduleType | object or null | |
data[].form.moduleType.id | string | Example |
data[].form.moduleType.label | string | Example |
data[].form.status | object or null | |
data[].form.status.id | integer or string | Example |
data[].form.status.label | string | Example |
data[].form.assignTo | object or null | |
data[].form.assignTo.id | string | Example |
data[].form.assignTo.label | string | Example |
data[].form.assignTo.isCustom | boolean | Example |
data[].form.version | integer or null | Example |
data[].form.multiStep | boolean | Example |
data[].form.reviewStep | boolean | Only meaningful while multiStep is true. Example |
data[].form.externalVisibility | object or null | |
data[].form.externalVisibility.id | string | One of: |
data[].form.externalVisibility.label | string | Example |
data[].form.lastUsedDate | string or null | Example |
data[].form.settings | object or null | |
data[].startsStep | integer or null | Example |
data[].groups | array of object | Field groups in render order; a single-step form has one. |
data[].groups[].label | string or null | Example |
data[].groups[].isRequired | boolean | Example |
data[].groups[].isArchived | boolean | Example |
data[].groups[].fields | array of object | |
data[].groups[].fields[].fieldKey | string | Example |
data[].groups[].fields[].label | string | Example |
data[].groups[].fields[].type | string | Example |
data[].groups[].fields[].isDefault | boolean | Example |
data[].groups[].fields[].isRequired | boolean | Example |
data[].groups[].fields[].isArchived | boolean | Example |
data[].groups[].fields[].value | any or null | The field's type-correct empty value in add mode: false, null, [] or the empty string. |
data[].groups[].fields[].usageCount | integer or null | Active forms this field appears on. Example |
data[].groups[].fields[].settings | object or null | |
data[].groups[].fields[].ui | object or null | |
data[].groups[].fields[].validation | object or null |
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
Unsupported module
{
"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: |