Skip to main content
GET
/
v3
/
orgs
/
{org_id}
/
data-capture
/
form-categories
/
{form_category_id}
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/orgs/{org_id}/data-capture/form-categories/{form_category_id} \
  --header 'X-Session-Token: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "<string>",
  "attributes": {
    "name": "<string>"
  },
  "meta": {
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "counts": {
      "forms": 0
    }
  },
  "relationships": {
    "forms": {
      "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.

​
form_category_id
string<uuid>
required

The unique identifier for the form category.

Query Parameters

​
include
enum<string>[]

A comma separated list of related resources to include.

Available options:
forms,
organisation

Response

Get a form category.

A form category

​
id
string<uuid>
required

The unique identifier of the form category.

​
type
string
required
Allowed value: "form-categories"
​
attributes
object
required

Attributes for a form category

​
meta
object
required

Metadata for a form category

​
relationships
object
required

Relationships for a form category