Skip to main content
GET
/
v3
/
orgs
/
{org_id}
/
data-capture
/
forms
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/orgs/{org_id}/data-capture/forms \
  --header 'X-Session-Token: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "name": "<string>",
        "description": "<string>",
        "status": "draft"
      },
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "counts": {
          "schemas": 0,
          "categories": 0,
          "submissions": 0,
          "submission_versions": 0
        }
      },
      "relationships": {
        "organisation": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "categories": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "schemas": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "author": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "latest_schema": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "submissions": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "counts": {
        "pages": 123,
        "resources": 123
      },
      "current_page": 123,
      "offsets": {
        "next": 123,
        "previous": 123
      },
      "requested": {
        "limit": 123,
        "offset": 123
      }
    },
    "features": {
      "include": {
        "options": [
          "<string>"
        ]
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "model": {},
        "view": {
          "title": "<string>",
          "sections": [
            {
              "title": "<string>",
              "description": "<string>",
              "rows": [
                {
                  "title": "<string>",
                  "description": "<string>",
                  "span": 6,
                  "columns": [
                    {
                      "span": 6,
                      "order": 1,
                      "blocks": [
                        {}
                      ],
                      "title": "<string>",
                      "description": "<string>"
                    }
                  ],
                  "order": 1
                }
              ],
              "order": 1,
              "conditions": {}
            }
          ]
        },
        "version": "<string>"
      },
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "latest": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "version": "<string>"
        }
      },
      "relationships": {
        "form": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        }
      }
    }
  ]
}

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

org_id
string<uuid>
required

The unique identifier for the organisation.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
author,
categories,
organisation,
latest_schema,
schemas
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • id_in: Filter by ID(s)
  • category_in: Filter forms by category ID(s)
  • uncategorised: Filter for uncategorised forms

For more information on using named filters, see the docs

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0

Response

Get a list of forms.

JSON API response object

data
A list of forms · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

Related resources that can be included when a form is returned

A form schema