API reference › Forms

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

NameTypeDescription
form requiredinteger

Form ID

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Example request

Shell
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

JSON
{
  "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)
FieldTypeDescription
successboolean

Example true.

dataobject
data.formobject
data.form.idstring

Example FRM-E-SPR-AB12CD.

data.form.namestring

Example Form Name.

data.form.versioninteger

Example 3.

data.form.multiStepboolean

Example true.

data.form.reviewStepboolean

Example false.

data.groupsarray of object
data.groups[].idinteger

Example 12.

data.groups[].namestring

Example About you.

data.groups[].orderinteger

Example 1.

data.groups[].startsStepboolean

Example true.

data.groups[].stepTitlestring

Example About you.

data.groups[].fieldsarray of object
data.scopestring

Example string.

401 Not signed in

Missing, invalid or expired API key.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'forms:read' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

Form not found

JSON
{
  "success": false,
  "message": "The requested resource could not be found.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example The requested resource could not be found..

errorsany or null

Details when the handler has them — a field-keyed object, a single string, or null.

codestring

Empty unless the handler sets one.

Example .

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.