Form Model

type

enum<string>

The resource type

Available options:

forms

Example:

"forms"

string<uuid>

The ID of the form

Example:

"92dbb844-8524-60bf-c12e-1eaf5c04"

attributes

object

Show child attributes

attributes.name

string

The name of the form

Example:

"My Form"

attributes.description

string

Additional description of the form, for example, what it is used for

Example:

"This is a form which captures lots of useful information"

attributes.status

enum<string>

The current status of the form

Available options:

published,

draft,

hidden,

archived

Example:

"published"

meta

object

Show child attributes

meta.created_at

string

The time the form was created (RFC 3339)

Example:

"2024-06-13T08:28:17.000Z"

relationships

object

Show child attributes

relationships.categories

object

Show child attributes

relationships.categories.data

object[]

Show child attributes

relationships.categories.data.type

enum<string>

The resource type

Available options:

form_categories

Example:

"form_categories"

relationships.categories.data.id

string<uuid>

The ID of the form category

Example:

"b60e2af5-6a84-0eb0-feaa-84384a94"

links

object

Show child attributes

links.self

string

Example:

"https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721/data-capture/forms/92dbb844-8524-60bf-c12e-1eaf5c04"

API Documentation

Governance

Data Capture

Operations

Assets

Admin