API reference › Forms

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

NameTypeDescription
pageinteger

Page number

searchstring

Search by name, description, or form code

scopestring

Filter by scope (internal, external)

One of: internal, external.

localSearchstring

Search within the current results.

formTypestring

Filter by form type.

One of: default, custom.

moduleTypestring

Filter by module (assignment, shift, client, consumer, …). Send all to ignore the filter.

statusstring

Filter by status id.

isPublishedboolean

Filter published (true) or draft (false) forms.

startDatestring (date)
endDatestring (date)
sortBystring
sortOrderstring

One of: asc, desc.

perPageinteger

Rows per page (default 10).

Example 10.

columnsstring

Comma-separated columns to search in.

assignedTostring

Filter by the Assign To column: forms bound to this client, consumer or provider ID. Blank means no filter.

Example CSM-12FGT4.

assignTostring

Older name for assignedTo, read only when assignedTo is blank.

Example CSM-12FGT4.

externalVisibilitystring

Filter by the External Visibility column. Returns external forms only.

One of: public, private. Example private.

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

Example request

Shell
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

JSON
{
  "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.

FieldTypeDescription
successboolean

Example true.

dataarray of object (21 nested)
metaobject (4 nested)

Nested fields

data 21 fields
FieldTypeDescription
data[].idstring

Example string.

data[].namestring

Example Example name.

data[].descriptionstring

Example Short human-readable description..

data[].isPublishedboolean

Example true.

data[].formTypestring

Example string.

data[].moduleTypeobject
data[].moduleType.idstring

Example string.

data[].moduleType.labelstring

Example Example label.

data[].statusobject
data[].status.idinteger

Example 1.

data[].status.labelstring

Example Example label.

data[].versioninteger

Example 1.

data[].scopestring

Example string.

data[].assignedTostring

Example string.

data[].usageinteger

Example 1.

data[].lastUsedDatestring (date)

Example 2026-01-15.

data[].customFieldsinteger

Example 1.

data[].lastUpdatedstring

Example string.

data[].externalVisibilityobject
data[].externalVisibility.idstring

Example private.

data[].externalVisibility.labelstring

Example Private.

meta 4 fields
FieldTypeDescription
meta.currentPageinteger

Example 1.

meta.lastPageinteger

Example 1.

meta.perPageinteger

Example 10.

meta.totalinteger

Example 2.

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 .

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.