Get form details
GET /v1/forms/{form}
- Scope
forms:read- Roles
- admin, scheduler
Retrieve details of a specific form including groups, fields, and locations. For a Contact form (moduleType contact) data.form also carries notifyTo and notifyCc (string lists), notifyBcc (admin role only; the key is absent for anyone else), notifyGroupEligibleCount, emailNoticesAvailable and hasSubmissions. These keys are never returned by the public GET /embed/{formid}.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
form required | integer | Form ID |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/forms/{form}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Successful operation
Successful operation
{
"success": true,
"data": {
"form": {
"id": "FRM-E-SPR-AB12CD",
"name": "Form Name",
"version": 3,
"multiStep": true,
"reviewStep": false
},
"groups": [
{
"id": 12,
"name": "About you",
"order": 1,
"startsStep": true,
"stepTitle": "About you",
"fields": []
}
],
"scope": "string"
}
}Response fields (16)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | object | |
data.form | object | |
data.form.id | string | Example |
data.form.name | string | Example |
data.form.version | integer | Example |
data.form.multiStep | boolean | Example |
data.form.reviewStep | boolean | Example |
data.groups | array of object | |
data.groups[].id | integer | Example |
data.groups[].name | string | Example |
data.groups[].order | integer | Example |
data.groups[].startsStep | boolean | Example |
data.groups[].stepTitle | string | Example |
data.groups[].fields | array of object | |
data.scope | string | 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 |
404 Not found
Form not found
{
"success": false,
"message": "The requested resource could not be found.",
"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: |