From 31494cf39257d388c3a41ff26b903a20a74edb14 Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Tue, 21 Jul 2026 20:30:31 +0000 Subject: [PATCH] Regenerate client from commit c1a4596 of spec repo --- config/_default/menus/api.en.yaml | 32 ++- .../latest/forms/list-form-versions/index.md | 3 + .../revert-a-form-to-a-prior-version/index.md | 3 + content/en/api/v2/forms/examples.json | 256 +++++++++++++++++- data/api/v2/full_spec.yaml | 222 ++++++++++++++- data/api/v2/translate_actions.json | 12 +- 6 files changed, 506 insertions(+), 22 deletions(-) create mode 100644 content/en/api/latest/forms/list-form-versions/index.md create mode 100644 content/en/api/latest/forms/revert-a-form-to-a-prior-version/index.md diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index a81f2a24757..7aac5deab90 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -12461,7 +12461,20 @@ menu: - UpsertAndPublishFormVersion unstable: - v2 - order: 10 + order: 11 + - name: Revert a form to a prior version + url: /api/latest/forms/revert-a-form-to-a-prior-version/ + identifier: forms-revert-a-form-to-a-prior-version + parent: forms + generated: true + params: + versions: + - v2 + operationids: + - RevertFormVersion + unstable: + - v2 + order: 9 - name: Create or update a form version url: /api/latest/forms/create-or-update-a-form-version/ identifier: forms-create-or-update-a-form-version @@ -12474,6 +12487,19 @@ menu: - UpsertFormVersion unstable: - v2 + order: 8 + - name: List form versions + url: /api/latest/forms/list-form-versions/ + identifier: forms-list-form-versions + parent: forms + generated: true + params: + versions: + - v2 + operationids: + - ListFormVersions + unstable: + - v2 order: 7 - name: Publish a form version url: /api/latest/forms/publish-a-form-version/ @@ -12487,7 +12513,7 @@ menu: - PublishForm unstable: - v2 - order: 8 + order: 10 - name: Clone a form url: /api/latest/forms/clone-a-form/ identifier: forms-clone-a-form @@ -12500,7 +12526,7 @@ menu: - CloneForm unstable: - v2 - order: 9 + order: 12 - name: Update a form url: /api/latest/forms/update-a-form/ identifier: forms-update-a-form diff --git a/content/en/api/latest/forms/list-form-versions/index.md b/content/en/api/latest/forms/list-form-versions/index.md new file mode 100644 index 00000000000..b91cd587d88 --- /dev/null +++ b/content/en/api/latest/forms/list-form-versions/index.md @@ -0,0 +1,3 @@ +--- +title: List form versions +--- diff --git a/content/en/api/latest/forms/revert-a-form-to-a-prior-version/index.md b/content/en/api/latest/forms/revert-a-form-to-a-prior-version/index.md new file mode 100644 index 00000000000..7734e224915 --- /dev/null +++ b/content/en/api/latest/forms/revert-a-form-to-a-prior-version/index.md @@ -0,0 +1,3 @@ +--- +title: Revert a form to a prior version +--- diff --git a/content/en/api/v2/forms/examples.json b/content/en/api/v2/forms/examples.json index aac3f692ed9..39f531cfbae 100644 --- a/content/en/api/v2/forms/examples.json +++ b/content/en/api/v2/forms/examples.json @@ -47,6 +47,7 @@ }, "definition_signature": "{\"signature\":\"b7f312957a80cea2c8c9950532b205a90a3f8a7ebb7e52fc25437a25d903d545\",\"version\":1}", "etag": "b51f08b698d88d8027a935d9db649774949f5fb41a0c559bfee6a9a13225c72d", + "has_ever_been_published": true, "id": "126", "modified_at": "2026-05-29T20:06:14.949163Z", "state": "frozen", @@ -66,7 +67,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

A list of form resource objects.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a form.

\n
\n
\n
\n
\n
\n

active [required]

\n
\n

boolean

\n

Whether the form is currently active.

\n
\n \n
\n
\n
\n
\n
\n

anonymous [required]

\n
\n

boolean

\n

Whether the form accepts anonymous submissions.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the form was created.

\n
\n \n
\n
\n
\n
\n
\n

datastore_config [required]

\n
\n

object

\n

The datastore configuration for a form.

\n
\n
\n
\n
\n
\n

datastore_id [required]

\n
\n

uuid

\n

The ID of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_column_name [required]

\n
\n

string

\n

The name of the primary column in the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_key_generation_strategy [required]

\n
\n

string

\n

The strategy used to generate primary keys in the datastore.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

The description of the form.

\n
\n \n
\n
\n
\n
\n
\n

end_date

\n
\n

date-time

\n

The date and time at which the form stops accepting responses.

\n
\n \n
\n
\n
\n
\n
\n

has_submitted

\n
\n

boolean

\n

Whether the current user has already submitted this form. Only present for forms with single_response set to true.

\n
\n \n
\n
\n
\n
\n
\n

idp_survey [required]

\n
\n

boolean

\n

Whether the form is an IDP survey.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the form was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the form.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this form.

\n
\n \n
\n
\n
\n
\n
\n

publication

\n
\n

object

\n

The attributes of a form publication.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the publication was created.

\n
\n \n
\n
\n
\n
\n
\n

form_id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

form_version [required]

\n
\n

int64

\n

The version number that was published.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form publication.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the publication was last modified.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this publication.

\n
\n \n
\n
\n
\n
\n
\n

publish_seq [required]

\n
\n

int64

\n

The sequential publication number for this form.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

self_service [required]

\n
\n

boolean

\n

Whether the form is available in the self-service catalog.

\n
\n \n
\n
\n
\n
\n
\n

single_response [required]

\n
\n

boolean

\n

Whether each user can only submit one response.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

object

\n

The attributes of a form version.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the version was created.

\n
\n \n
\n
\n
\n
\n
\n

data_definition [required]

\n
\n

object

\n

A JSON Schema definition that describes the form's data fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description shown to form respondents.

\n
\n \n
\n
\n
\n
\n
\n

properties

\n
\n

object

\n

A map of field names to their JSON Schema definitions.

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

[string]

\n

List of field names that must be answered.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the form schema.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The root schema type. \nAllowed enum values: object

default: object

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

definition_signature [required]

\n
\n

string

\n

The signature of the version definition.

\n
\n \n
\n
\n
\n
\n
\n

etag [required]

\n
\n

string

\n

The ETag for optimistic concurrency control.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form version.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the version was last modified.

\n
\n \n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

The state of a form version. \nAllowed enum values: draft,frozen

\n
\n \n
\n
\n
\n
\n
\n

ui_definition [required]

\n
\n

object

\n

UI configuration for rendering form fields, including widget overrides, field ordering, and themes.

\n
\n
\n
\n
\n
\n

ui:order

\n
\n

[string]

\n

The order in which form fields are displayed.

\n
\n \n
\n
\n
\n
\n
\n

ui:theme

\n
\n

object

\n

The visual theme applied to the form.

\n
\n
\n
\n
\n
\n

primaryColor

\n
\n

enum

\n

The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The sequential version number.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type for a form. \nAllowed enum values: forms

default: forms

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

A list of form resource objects.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a form.

\n
\n
\n
\n
\n
\n

active [required]

\n
\n

boolean

\n

Whether the form is currently active.

\n
\n \n
\n
\n
\n
\n
\n

anonymous [required]

\n
\n

boolean

\n

Whether the form accepts anonymous submissions.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the form was created.

\n
\n \n
\n
\n
\n
\n
\n

datastore_config [required]

\n
\n

object

\n

The datastore configuration for a form.

\n
\n
\n
\n
\n
\n

datastore_id [required]

\n
\n

uuid

\n

The ID of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_column_name [required]

\n
\n

string

\n

The name of the primary column in the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_key_generation_strategy [required]

\n
\n

string

\n

The strategy used to generate primary keys in the datastore.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

The description of the form.

\n
\n \n
\n
\n
\n
\n
\n

end_date

\n
\n

date-time

\n

The date and time at which the form stops accepting responses.

\n
\n \n
\n
\n
\n
\n
\n

has_submitted

\n
\n

boolean

\n

Whether the current user has already submitted this form. Only present for forms with\nsingle_response set to true.

\n
\n \n
\n
\n
\n
\n
\n

idp_survey [required]

\n
\n

boolean

\n

Whether the form is an IDP survey.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the form was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the form.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this form.

\n
\n \n
\n
\n
\n
\n
\n

publication

\n
\n

object

\n

The attributes of a form publication.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the publication was created.

\n
\n \n
\n
\n
\n
\n
\n

form_id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

form_version [required]

\n
\n

int64

\n

The version number that was published.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form publication.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the publication was last modified.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this publication.

\n
\n \n
\n
\n
\n
\n
\n

publish_seq [required]

\n
\n

int64

\n

The sequential publication number for this form.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

self_service [required]

\n
\n

boolean

\n

Whether the form is available in the self-service catalog.

\n
\n \n
\n
\n
\n
\n
\n

single_response [required]

\n
\n

boolean

\n

Whether each user can only submit one response.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

object

\n

The attributes of a form version.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the version was created.

\n
\n \n
\n
\n
\n
\n
\n

data_definition [required]

\n
\n

object

\n

A JSON Schema definition that describes the form's data fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description shown to form respondents.

\n
\n \n
\n
\n
\n
\n
\n

properties

\n
\n

object

\n

A map of field names to their JSON Schema definitions.

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

[string]

\n

List of field names that must be answered.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the form schema.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The root schema type. \nAllowed enum values: object

default: object

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

definition_signature [required]

\n
\n

string

\n

The signature of the version definition.

\n
\n \n
\n
\n
\n
\n
\n

etag [required]

\n
\n

string

\n

The ETag for optimistic concurrency control.

\n
\n \n
\n
\n
\n
\n
\n

has_ever_been_published

\n
\n

boolean

\n

Whether this version number has ever appeared in the form's publication history.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form version.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the version was last modified.

\n
\n \n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

The state of a form version. \nAllowed enum values: draft,frozen

\n
\n \n
\n
\n
\n
\n
\n

ui_definition [required]

\n
\n

object

\n

UI configuration for rendering form fields, including widget overrides, field ordering, and themes.

\n
\n
\n
\n
\n
\n

ui:order

\n
\n

[string]

\n

The order in which form fields are displayed.

\n
\n \n
\n
\n
\n
\n
\n

ui:theme

\n
\n

object

\n

The visual theme applied to the form.

\n
\n
\n
\n
\n
\n

primaryColor

\n
\n

enum

\n

The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The sequential version number.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type for a form. \nAllowed enum values: forms

default: forms

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -166,6 +167,7 @@ }, "definition_signature": "{\"signature\":\"b7f312957a80cea2c8c9950532b205a90a3f8a7ebb7e52fc25437a25d903d545\",\"version\":1}", "etag": "b51f08b698d88d8027a935d9db649774949f5fb41a0c559bfee6a9a13225c72d", + "has_ever_been_published": true, "id": "126", "modified_at": "2026-05-29T20:06:14.949163Z", "state": "frozen", @@ -184,7 +186,7 @@ "type": "forms" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A form resource object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a form.

\n
\n
\n
\n
\n
\n

active [required]

\n
\n

boolean

\n

Whether the form is currently active.

\n
\n \n
\n
\n
\n
\n
\n

anonymous [required]

\n
\n

boolean

\n

Whether the form accepts anonymous submissions.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the form was created.

\n
\n \n
\n
\n
\n
\n
\n

datastore_config [required]

\n
\n

object

\n

The datastore configuration for a form.

\n
\n
\n
\n
\n
\n

datastore_id [required]

\n
\n

uuid

\n

The ID of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_column_name [required]

\n
\n

string

\n

The name of the primary column in the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_key_generation_strategy [required]

\n
\n

string

\n

The strategy used to generate primary keys in the datastore.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

The description of the form.

\n
\n \n
\n
\n
\n
\n
\n

end_date

\n
\n

date-time

\n

The date and time at which the form stops accepting responses.

\n
\n \n
\n
\n
\n
\n
\n

has_submitted

\n
\n

boolean

\n

Whether the current user has already submitted this form. Only present for forms with single_response set to true.

\n
\n \n
\n
\n
\n
\n
\n

idp_survey [required]

\n
\n

boolean

\n

Whether the form is an IDP survey.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the form was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the form.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this form.

\n
\n \n
\n
\n
\n
\n
\n

publication

\n
\n

object

\n

The attributes of a form publication.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the publication was created.

\n
\n \n
\n
\n
\n
\n
\n

form_id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

form_version [required]

\n
\n

int64

\n

The version number that was published.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form publication.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the publication was last modified.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this publication.

\n
\n \n
\n
\n
\n
\n
\n

publish_seq [required]

\n
\n

int64

\n

The sequential publication number for this form.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

self_service [required]

\n
\n

boolean

\n

Whether the form is available in the self-service catalog.

\n
\n \n
\n
\n
\n
\n
\n

single_response [required]

\n
\n

boolean

\n

Whether each user can only submit one response.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

object

\n

The attributes of a form version.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the version was created.

\n
\n \n
\n
\n
\n
\n
\n

data_definition [required]

\n
\n

object

\n

A JSON Schema definition that describes the form's data fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description shown to form respondents.

\n
\n \n
\n
\n
\n
\n
\n

properties

\n
\n

object

\n

A map of field names to their JSON Schema definitions.

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

[string]

\n

List of field names that must be answered.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the form schema.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The root schema type. \nAllowed enum values: object

default: object

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

definition_signature [required]

\n
\n

string

\n

The signature of the version definition.

\n
\n \n
\n
\n
\n
\n
\n

etag [required]

\n
\n

string

\n

The ETag for optimistic concurrency control.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form version.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the version was last modified.

\n
\n \n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

The state of a form version. \nAllowed enum values: draft,frozen

\n
\n \n
\n
\n
\n
\n
\n

ui_definition [required]

\n
\n

object

\n

UI configuration for rendering form fields, including widget overrides, field ordering, and themes.

\n
\n
\n
\n
\n
\n

ui:order

\n
\n

[string]

\n

The order in which form fields are displayed.

\n
\n \n
\n
\n
\n
\n
\n

ui:theme

\n
\n

object

\n

The visual theme applied to the form.

\n
\n
\n
\n
\n
\n

primaryColor

\n
\n

enum

\n

The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The sequential version number.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type for a form. \nAllowed enum values: forms

default: forms

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A form resource object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a form.

\n
\n
\n
\n
\n
\n

active [required]

\n
\n

boolean

\n

Whether the form is currently active.

\n
\n \n
\n
\n
\n
\n
\n

anonymous [required]

\n
\n

boolean

\n

Whether the form accepts anonymous submissions.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the form was created.

\n
\n \n
\n
\n
\n
\n
\n

datastore_config [required]

\n
\n

object

\n

The datastore configuration for a form.

\n
\n
\n
\n
\n
\n

datastore_id [required]

\n
\n

uuid

\n

The ID of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_column_name [required]

\n
\n

string

\n

The name of the primary column in the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_key_generation_strategy [required]

\n
\n

string

\n

The strategy used to generate primary keys in the datastore.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

The description of the form.

\n
\n \n
\n
\n
\n
\n
\n

end_date

\n
\n

date-time

\n

The date and time at which the form stops accepting responses.

\n
\n \n
\n
\n
\n
\n
\n

has_submitted

\n
\n

boolean

\n

Whether the current user has already submitted this form. Only present for forms with\nsingle_response set to true.

\n
\n \n
\n
\n
\n
\n
\n

idp_survey [required]

\n
\n

boolean

\n

Whether the form is an IDP survey.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the form was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the form.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this form.

\n
\n \n
\n
\n
\n
\n
\n

publication

\n
\n

object

\n

The attributes of a form publication.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the publication was created.

\n
\n \n
\n
\n
\n
\n
\n

form_id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

form_version [required]

\n
\n

int64

\n

The version number that was published.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form publication.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the publication was last modified.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this publication.

\n
\n \n
\n
\n
\n
\n
\n

publish_seq [required]

\n
\n

int64

\n

The sequential publication number for this form.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

self_service [required]

\n
\n

boolean

\n

Whether the form is available in the self-service catalog.

\n
\n \n
\n
\n
\n
\n
\n

single_response [required]

\n
\n

boolean

\n

Whether each user can only submit one response.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

object

\n

The attributes of a form version.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the version was created.

\n
\n \n
\n
\n
\n
\n
\n

data_definition [required]

\n
\n

object

\n

A JSON Schema definition that describes the form's data fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description shown to form respondents.

\n
\n \n
\n
\n
\n
\n
\n

properties

\n
\n

object

\n

A map of field names to their JSON Schema definitions.

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

[string]

\n

List of field names that must be answered.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the form schema.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The root schema type. \nAllowed enum values: object

default: object

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

definition_signature [required]

\n
\n

string

\n

The signature of the version definition.

\n
\n \n
\n
\n
\n
\n
\n

etag [required]

\n
\n

string

\n

The ETag for optimistic concurrency control.

\n
\n \n
\n
\n
\n
\n
\n

has_ever_been_published

\n
\n

boolean

\n

Whether this version number has ever appeared in the form's publication history.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form version.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the version was last modified.

\n
\n \n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

The state of a form version. \nAllowed enum values: draft,frozen

\n
\n \n
\n
\n
\n
\n
\n

ui_definition [required]

\n
\n

object

\n

UI configuration for rendering form fields, including widget overrides, field ordering, and themes.

\n
\n
\n
\n
\n
\n

ui:order

\n
\n

[string]

\n

The order in which form fields are displayed.

\n
\n \n
\n
\n
\n
\n
\n

ui:theme

\n
\n

object

\n

The visual theme applied to the form.

\n
\n
\n
\n
\n
\n

primaryColor

\n
\n

enum

\n

The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The sequential version number.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type for a form. \nAllowed enum values: forms

default: forms

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -317,6 +319,7 @@ }, "definition_signature": "{\"signature\":\"b7f312957a80cea2c8c9950532b205a90a3f8a7ebb7e52fc25437a25d903d545\",\"version\":1}", "etag": "b51f08b698d88d8027a935d9db649774949f5fb41a0c559bfee6a9a13225c72d", + "has_ever_been_published": true, "id": "126", "modified_at": "2026-05-29T20:06:14.949163Z", "state": "frozen", @@ -335,7 +338,7 @@ "type": "forms" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A form resource object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a form.

\n
\n
\n
\n
\n
\n

active [required]

\n
\n

boolean

\n

Whether the form is currently active.

\n
\n \n
\n
\n
\n
\n
\n

anonymous [required]

\n
\n

boolean

\n

Whether the form accepts anonymous submissions.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the form was created.

\n
\n \n
\n
\n
\n
\n
\n

datastore_config [required]

\n
\n

object

\n

The datastore configuration for a form.

\n
\n
\n
\n
\n
\n

datastore_id [required]

\n
\n

uuid

\n

The ID of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_column_name [required]

\n
\n

string

\n

The name of the primary column in the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_key_generation_strategy [required]

\n
\n

string

\n

The strategy used to generate primary keys in the datastore.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

The description of the form.

\n
\n \n
\n
\n
\n
\n
\n

end_date

\n
\n

date-time

\n

The date and time at which the form stops accepting responses.

\n
\n \n
\n
\n
\n
\n
\n

has_submitted

\n
\n

boolean

\n

Whether the current user has already submitted this form. Only present for forms with single_response set to true.

\n
\n \n
\n
\n
\n
\n
\n

idp_survey [required]

\n
\n

boolean

\n

Whether the form is an IDP survey.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the form was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the form.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this form.

\n
\n \n
\n
\n
\n
\n
\n

publication

\n
\n

object

\n

The attributes of a form publication.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the publication was created.

\n
\n \n
\n
\n
\n
\n
\n

form_id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

form_version [required]

\n
\n

int64

\n

The version number that was published.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form publication.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the publication was last modified.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this publication.

\n
\n \n
\n
\n
\n
\n
\n

publish_seq [required]

\n
\n

int64

\n

The sequential publication number for this form.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

self_service [required]

\n
\n

boolean

\n

Whether the form is available in the self-service catalog.

\n
\n \n
\n
\n
\n
\n
\n

single_response [required]

\n
\n

boolean

\n

Whether each user can only submit one response.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

object

\n

The attributes of a form version.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the version was created.

\n
\n \n
\n
\n
\n
\n
\n

data_definition [required]

\n
\n

object

\n

A JSON Schema definition that describes the form's data fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description shown to form respondents.

\n
\n \n
\n
\n
\n
\n
\n

properties

\n
\n

object

\n

A map of field names to their JSON Schema definitions.

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

[string]

\n

List of field names that must be answered.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the form schema.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The root schema type. \nAllowed enum values: object

default: object

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

definition_signature [required]

\n
\n

string

\n

The signature of the version definition.

\n
\n \n
\n
\n
\n
\n
\n

etag [required]

\n
\n

string

\n

The ETag for optimistic concurrency control.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form version.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the version was last modified.

\n
\n \n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

The state of a form version. \nAllowed enum values: draft,frozen

\n
\n \n
\n
\n
\n
\n
\n

ui_definition [required]

\n
\n

object

\n

UI configuration for rendering form fields, including widget overrides, field ordering, and themes.

\n
\n
\n
\n
\n
\n

ui:order

\n
\n

[string]

\n

The order in which form fields are displayed.

\n
\n \n
\n
\n
\n
\n
\n

ui:theme

\n
\n

object

\n

The visual theme applied to the form.

\n
\n
\n
\n
\n
\n

primaryColor

\n
\n

enum

\n

The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The sequential version number.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type for a form. \nAllowed enum values: forms

default: forms

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A form resource object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a form.

\n
\n
\n
\n
\n
\n

active [required]

\n
\n

boolean

\n

Whether the form is currently active.

\n
\n \n
\n
\n
\n
\n
\n

anonymous [required]

\n
\n

boolean

\n

Whether the form accepts anonymous submissions.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the form was created.

\n
\n \n
\n
\n
\n
\n
\n

datastore_config [required]

\n
\n

object

\n

The datastore configuration for a form.

\n
\n
\n
\n
\n
\n

datastore_id [required]

\n
\n

uuid

\n

The ID of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_column_name [required]

\n
\n

string

\n

The name of the primary column in the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_key_generation_strategy [required]

\n
\n

string

\n

The strategy used to generate primary keys in the datastore.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

The description of the form.

\n
\n \n
\n
\n
\n
\n
\n

end_date

\n
\n

date-time

\n

The date and time at which the form stops accepting responses.

\n
\n \n
\n
\n
\n
\n
\n

has_submitted

\n
\n

boolean

\n

Whether the current user has already submitted this form. Only present for forms with\nsingle_response set to true.

\n
\n \n
\n
\n
\n
\n
\n

idp_survey [required]

\n
\n

boolean

\n

Whether the form is an IDP survey.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the form was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the form.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this form.

\n
\n \n
\n
\n
\n
\n
\n

publication

\n
\n

object

\n

The attributes of a form publication.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the publication was created.

\n
\n \n
\n
\n
\n
\n
\n

form_id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

form_version [required]

\n
\n

int64

\n

The version number that was published.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form publication.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the publication was last modified.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this publication.

\n
\n \n
\n
\n
\n
\n
\n

publish_seq [required]

\n
\n

int64

\n

The sequential publication number for this form.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

self_service [required]

\n
\n

boolean

\n

Whether the form is available in the self-service catalog.

\n
\n \n
\n
\n
\n
\n
\n

single_response [required]

\n
\n

boolean

\n

Whether each user can only submit one response.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

object

\n

The attributes of a form version.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the version was created.

\n
\n \n
\n
\n
\n
\n
\n

data_definition [required]

\n
\n

object

\n

A JSON Schema definition that describes the form's data fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description shown to form respondents.

\n
\n \n
\n
\n
\n
\n
\n

properties

\n
\n

object

\n

A map of field names to their JSON Schema definitions.

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

[string]

\n

List of field names that must be answered.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the form schema.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The root schema type. \nAllowed enum values: object

default: object

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

definition_signature [required]

\n
\n

string

\n

The signature of the version definition.

\n
\n \n
\n
\n
\n
\n
\n

etag [required]

\n
\n

string

\n

The ETag for optimistic concurrency control.

\n
\n \n
\n
\n
\n
\n
\n

has_ever_been_published

\n
\n

boolean

\n

Whether this version number has ever appeared in the form's publication history.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form version.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the version was last modified.

\n
\n \n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

The state of a form version. \nAllowed enum values: draft,frozen

\n
\n \n
\n
\n
\n
\n
\n

ui_definition [required]

\n
\n

object

\n

UI configuration for rendering form fields, including widget overrides, field ordering, and themes.

\n
\n
\n
\n
\n
\n

ui:order

\n
\n

[string]

\n

The order in which form fields are displayed.

\n
\n \n
\n
\n
\n
\n
\n

ui:theme

\n
\n

object

\n

The visual theme applied to the form.

\n
\n
\n
\n
\n
\n

primaryColor

\n
\n

enum

\n

The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The sequential version number.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type for a form. \nAllowed enum values: forms

default: forms

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -530,6 +533,7 @@ }, "definition_signature": "{\"signature\":\"b7f312957a80cea2c8c9950532b205a90a3f8a7ebb7e52fc25437a25d903d545\",\"version\":1}", "etag": "b51f08b698d88d8027a935d9db649774949f5fb41a0c559bfee6a9a13225c72d", + "has_ever_been_published": true, "id": "126", "modified_at": "2026-05-29T20:06:14.949163Z", "state": "frozen", @@ -548,7 +552,7 @@ "type": "forms" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A form resource object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a form.

\n
\n
\n
\n
\n
\n

active [required]

\n
\n

boolean

\n

Whether the form is currently active.

\n
\n \n
\n
\n
\n
\n
\n

anonymous [required]

\n
\n

boolean

\n

Whether the form accepts anonymous submissions.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the form was created.

\n
\n \n
\n
\n
\n
\n
\n

datastore_config [required]

\n
\n

object

\n

The datastore configuration for a form.

\n
\n
\n
\n
\n
\n

datastore_id [required]

\n
\n

uuid

\n

The ID of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_column_name [required]

\n
\n

string

\n

The name of the primary column in the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_key_generation_strategy [required]

\n
\n

string

\n

The strategy used to generate primary keys in the datastore.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

The description of the form.

\n
\n \n
\n
\n
\n
\n
\n

end_date

\n
\n

date-time

\n

The date and time at which the form stops accepting responses.

\n
\n \n
\n
\n
\n
\n
\n

has_submitted

\n
\n

boolean

\n

Whether the current user has already submitted this form. Only present for forms with single_response set to true.

\n
\n \n
\n
\n
\n
\n
\n

idp_survey [required]

\n
\n

boolean

\n

Whether the form is an IDP survey.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the form was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the form.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this form.

\n
\n \n
\n
\n
\n
\n
\n

publication

\n
\n

object

\n

The attributes of a form publication.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the publication was created.

\n
\n \n
\n
\n
\n
\n
\n

form_id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

form_version [required]

\n
\n

int64

\n

The version number that was published.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form publication.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the publication was last modified.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this publication.

\n
\n \n
\n
\n
\n
\n
\n

publish_seq [required]

\n
\n

int64

\n

The sequential publication number for this form.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

self_service [required]

\n
\n

boolean

\n

Whether the form is available in the self-service catalog.

\n
\n \n
\n
\n
\n
\n
\n

single_response [required]

\n
\n

boolean

\n

Whether each user can only submit one response.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

object

\n

The attributes of a form version.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the version was created.

\n
\n \n
\n
\n
\n
\n
\n

data_definition [required]

\n
\n

object

\n

A JSON Schema definition that describes the form's data fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description shown to form respondents.

\n
\n \n
\n
\n
\n
\n
\n

properties

\n
\n

object

\n

A map of field names to their JSON Schema definitions.

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

[string]

\n

List of field names that must be answered.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the form schema.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The root schema type. \nAllowed enum values: object

default: object

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

definition_signature [required]

\n
\n

string

\n

The signature of the version definition.

\n
\n \n
\n
\n
\n
\n
\n

etag [required]

\n
\n

string

\n

The ETag for optimistic concurrency control.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form version.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the version was last modified.

\n
\n \n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

The state of a form version. \nAllowed enum values: draft,frozen

\n
\n \n
\n
\n
\n
\n
\n

ui_definition [required]

\n
\n

object

\n

UI configuration for rendering form fields, including widget overrides, field ordering, and themes.

\n
\n
\n
\n
\n
\n

ui:order

\n
\n

[string]

\n

The order in which form fields are displayed.

\n
\n \n
\n
\n
\n
\n
\n

ui:theme

\n
\n

object

\n

The visual theme applied to the form.

\n
\n
\n
\n
\n
\n

primaryColor

\n
\n

enum

\n

The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The sequential version number.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type for a form. \nAllowed enum values: forms

default: forms

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A form resource object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a form.

\n
\n
\n
\n
\n
\n

active [required]

\n
\n

boolean

\n

Whether the form is currently active.

\n
\n \n
\n
\n
\n
\n
\n

anonymous [required]

\n
\n

boolean

\n

Whether the form accepts anonymous submissions.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the form was created.

\n
\n \n
\n
\n
\n
\n
\n

datastore_config [required]

\n
\n

object

\n

The datastore configuration for a form.

\n
\n
\n
\n
\n
\n

datastore_id [required]

\n
\n

uuid

\n

The ID of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_column_name [required]

\n
\n

string

\n

The name of the primary column in the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_key_generation_strategy [required]

\n
\n

string

\n

The strategy used to generate primary keys in the datastore.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

The description of the form.

\n
\n \n
\n
\n
\n
\n
\n

end_date

\n
\n

date-time

\n

The date and time at which the form stops accepting responses.

\n
\n \n
\n
\n
\n
\n
\n

has_submitted

\n
\n

boolean

\n

Whether the current user has already submitted this form. Only present for forms with\nsingle_response set to true.

\n
\n \n
\n
\n
\n
\n
\n

idp_survey [required]

\n
\n

boolean

\n

Whether the form is an IDP survey.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the form was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the form.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this form.

\n
\n \n
\n
\n
\n
\n
\n

publication

\n
\n

object

\n

The attributes of a form publication.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the publication was created.

\n
\n \n
\n
\n
\n
\n
\n

form_id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

form_version [required]

\n
\n

int64

\n

The version number that was published.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form publication.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the publication was last modified.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this publication.

\n
\n \n
\n
\n
\n
\n
\n

publish_seq [required]

\n
\n

int64

\n

The sequential publication number for this form.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

self_service [required]

\n
\n

boolean

\n

Whether the form is available in the self-service catalog.

\n
\n \n
\n
\n
\n
\n
\n

single_response [required]

\n
\n

boolean

\n

Whether each user can only submit one response.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

object

\n

The attributes of a form version.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the version was created.

\n
\n \n
\n
\n
\n
\n
\n

data_definition [required]

\n
\n

object

\n

A JSON Schema definition that describes the form's data fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description shown to form respondents.

\n
\n \n
\n
\n
\n
\n
\n

properties

\n
\n

object

\n

A map of field names to their JSON Schema definitions.

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

[string]

\n

List of field names that must be answered.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the form schema.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The root schema type. \nAllowed enum values: object

default: object

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

definition_signature [required]

\n
\n

string

\n

The signature of the version definition.

\n
\n \n
\n
\n
\n
\n
\n

etag [required]

\n
\n

string

\n

The ETag for optimistic concurrency control.

\n
\n \n
\n
\n
\n
\n
\n

has_ever_been_published

\n
\n

boolean

\n

Whether this version number has ever appeared in the form's publication history.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form version.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the version was last modified.

\n
\n \n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

The state of a form version. \nAllowed enum values: draft,frozen

\n
\n \n
\n
\n
\n
\n
\n

ui_definition [required]

\n
\n

object

\n

UI configuration for rendering form fields, including widget overrides, field ordering, and themes.

\n
\n
\n
\n
\n
\n

ui:order

\n
\n

[string]

\n

The order in which form fields are displayed.

\n
\n \n
\n
\n
\n
\n
\n

ui:theme

\n
\n

object

\n

The visual theme applied to the form.

\n
\n
\n
\n
\n
\n

primaryColor

\n
\n

enum

\n

The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The sequential version number.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type for a form. \nAllowed enum values: forms

default: forms

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -666,6 +670,7 @@ }, "definition_signature": "{\"signature\":\"b7f312957a80cea2c8c9950532b205a90a3f8a7ebb7e52fc25437a25d903d545\",\"version\":1}", "etag": "b51f08b698d88d8027a935d9db649774949f5fb41a0c559bfee6a9a13225c72d", + "has_ever_been_published": true, "id": "126", "modified_at": "2026-05-29T20:06:14.949163Z", "state": "frozen", @@ -684,7 +689,7 @@ "type": "forms" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A form resource object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a form.

\n
\n
\n
\n
\n
\n

active [required]

\n
\n

boolean

\n

Whether the form is currently active.

\n
\n \n
\n
\n
\n
\n
\n

anonymous [required]

\n
\n

boolean

\n

Whether the form accepts anonymous submissions.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the form was created.

\n
\n \n
\n
\n
\n
\n
\n

datastore_config [required]

\n
\n

object

\n

The datastore configuration for a form.

\n
\n
\n
\n
\n
\n

datastore_id [required]

\n
\n

uuid

\n

The ID of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_column_name [required]

\n
\n

string

\n

The name of the primary column in the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_key_generation_strategy [required]

\n
\n

string

\n

The strategy used to generate primary keys in the datastore.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

The description of the form.

\n
\n \n
\n
\n
\n
\n
\n

end_date

\n
\n

date-time

\n

The date and time at which the form stops accepting responses.

\n
\n \n
\n
\n
\n
\n
\n

has_submitted

\n
\n

boolean

\n

Whether the current user has already submitted this form. Only present for forms with single_response set to true.

\n
\n \n
\n
\n
\n
\n
\n

idp_survey [required]

\n
\n

boolean

\n

Whether the form is an IDP survey.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the form was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the form.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this form.

\n
\n \n
\n
\n
\n
\n
\n

publication

\n
\n

object

\n

The attributes of a form publication.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the publication was created.

\n
\n \n
\n
\n
\n
\n
\n

form_id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

form_version [required]

\n
\n

int64

\n

The version number that was published.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form publication.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the publication was last modified.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this publication.

\n
\n \n
\n
\n
\n
\n
\n

publish_seq [required]

\n
\n

int64

\n

The sequential publication number for this form.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

self_service [required]

\n
\n

boolean

\n

Whether the form is available in the self-service catalog.

\n
\n \n
\n
\n
\n
\n
\n

single_response [required]

\n
\n

boolean

\n

Whether each user can only submit one response.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

object

\n

The attributes of a form version.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the version was created.

\n
\n \n
\n
\n
\n
\n
\n

data_definition [required]

\n
\n

object

\n

A JSON Schema definition that describes the form's data fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description shown to form respondents.

\n
\n \n
\n
\n
\n
\n
\n

properties

\n
\n

object

\n

A map of field names to their JSON Schema definitions.

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

[string]

\n

List of field names that must be answered.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the form schema.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The root schema type. \nAllowed enum values: object

default: object

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

definition_signature [required]

\n
\n

string

\n

The signature of the version definition.

\n
\n \n
\n
\n
\n
\n
\n

etag [required]

\n
\n

string

\n

The ETag for optimistic concurrency control.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form version.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the version was last modified.

\n
\n \n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

The state of a form version. \nAllowed enum values: draft,frozen

\n
\n \n
\n
\n
\n
\n
\n

ui_definition [required]

\n
\n

object

\n

UI configuration for rendering form fields, including widget overrides, field ordering, and themes.

\n
\n
\n
\n
\n
\n

ui:order

\n
\n

[string]

\n

The order in which form fields are displayed.

\n
\n \n
\n
\n
\n
\n
\n

ui:theme

\n
\n

object

\n

The visual theme applied to the form.

\n
\n
\n
\n
\n
\n

primaryColor

\n
\n

enum

\n

The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The sequential version number.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type for a form. \nAllowed enum values: forms

default: forms

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A form resource object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a form.

\n
\n
\n
\n
\n
\n

active [required]

\n
\n

boolean

\n

Whether the form is currently active.

\n
\n \n
\n
\n
\n
\n
\n

anonymous [required]

\n
\n

boolean

\n

Whether the form accepts anonymous submissions.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the form was created.

\n
\n \n
\n
\n
\n
\n
\n

datastore_config [required]

\n
\n

object

\n

The datastore configuration for a form.

\n
\n
\n
\n
\n
\n

datastore_id [required]

\n
\n

uuid

\n

The ID of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_column_name [required]

\n
\n

string

\n

The name of the primary column in the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_key_generation_strategy [required]

\n
\n

string

\n

The strategy used to generate primary keys in the datastore.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

The description of the form.

\n
\n \n
\n
\n
\n
\n
\n

end_date

\n
\n

date-time

\n

The date and time at which the form stops accepting responses.

\n
\n \n
\n
\n
\n
\n
\n

has_submitted

\n
\n

boolean

\n

Whether the current user has already submitted this form. Only present for forms with\nsingle_response set to true.

\n
\n \n
\n
\n
\n
\n
\n

idp_survey [required]

\n
\n

boolean

\n

Whether the form is an IDP survey.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the form was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the form.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this form.

\n
\n \n
\n
\n
\n
\n
\n

publication

\n
\n

object

\n

The attributes of a form publication.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the publication was created.

\n
\n \n
\n
\n
\n
\n
\n

form_id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

form_version [required]

\n
\n

int64

\n

The version number that was published.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form publication.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the publication was last modified.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this publication.

\n
\n \n
\n
\n
\n
\n
\n

publish_seq [required]

\n
\n

int64

\n

The sequential publication number for this form.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

self_service [required]

\n
\n

boolean

\n

Whether the form is available in the self-service catalog.

\n
\n \n
\n
\n
\n
\n
\n

single_response [required]

\n
\n

boolean

\n

Whether each user can only submit one response.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

object

\n

The attributes of a form version.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the version was created.

\n
\n \n
\n
\n
\n
\n
\n

data_definition [required]

\n
\n

object

\n

A JSON Schema definition that describes the form's data fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description shown to form respondents.

\n
\n \n
\n
\n
\n
\n
\n

properties

\n
\n

object

\n

A map of field names to their JSON Schema definitions.

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

[string]

\n

List of field names that must be answered.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the form schema.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The root schema type. \nAllowed enum values: object

default: object

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

definition_signature [required]

\n
\n

string

\n

The signature of the version definition.

\n
\n \n
\n
\n
\n
\n
\n

etag [required]

\n
\n

string

\n

The ETag for optimistic concurrency control.

\n
\n \n
\n
\n
\n
\n
\n

has_ever_been_published

\n
\n

boolean

\n

Whether this version number has ever appeared in the form's publication history.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form version.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the version was last modified.

\n
\n \n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

The state of a form version. \nAllowed enum values: draft,frozen

\n
\n \n
\n
\n
\n
\n
\n

ui_definition [required]

\n
\n

object

\n

UI configuration for rendering form fields, including widget overrides, field ordering, and themes.

\n
\n
\n
\n
\n
\n

ui:order

\n
\n

[string]

\n

The order in which form fields are displayed.

\n
\n \n
\n
\n
\n
\n
\n

ui:theme

\n
\n

object

\n

The visual theme applied to the form.

\n
\n
\n
\n
\n
\n

primaryColor

\n
\n

enum

\n

The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The sequential version number.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type for a form. \nAllowed enum values: forms

default: forms

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -831,6 +836,7 @@ }, "definition_signature": "{\"signature\":\"b7f312957a80cea2c8c9950532b205a90a3f8a7ebb7e52fc25437a25d903d545\",\"version\":1}", "etag": "b51f08b698d88d8027a935d9db649774949f5fb41a0c559bfee6a9a13225c72d", + "has_ever_been_published": true, "id": "126", "modified_at": "2026-05-29T20:06:14.949163Z", "state": "frozen", @@ -849,7 +855,7 @@ "type": "forms" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A form resource object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a form.

\n
\n
\n
\n
\n
\n

active [required]

\n
\n

boolean

\n

Whether the form is currently active.

\n
\n \n
\n
\n
\n
\n
\n

anonymous [required]

\n
\n

boolean

\n

Whether the form accepts anonymous submissions.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the form was created.

\n
\n \n
\n
\n
\n
\n
\n

datastore_config [required]

\n
\n

object

\n

The datastore configuration for a form.

\n
\n
\n
\n
\n
\n

datastore_id [required]

\n
\n

uuid

\n

The ID of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_column_name [required]

\n
\n

string

\n

The name of the primary column in the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_key_generation_strategy [required]

\n
\n

string

\n

The strategy used to generate primary keys in the datastore.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

The description of the form.

\n
\n \n
\n
\n
\n
\n
\n

end_date

\n
\n

date-time

\n

The date and time at which the form stops accepting responses.

\n
\n \n
\n
\n
\n
\n
\n

has_submitted

\n
\n

boolean

\n

Whether the current user has already submitted this form. Only present for forms with single_response set to true.

\n
\n \n
\n
\n
\n
\n
\n

idp_survey [required]

\n
\n

boolean

\n

Whether the form is an IDP survey.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the form was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the form.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this form.

\n
\n \n
\n
\n
\n
\n
\n

publication

\n
\n

object

\n

The attributes of a form publication.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the publication was created.

\n
\n \n
\n
\n
\n
\n
\n

form_id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

form_version [required]

\n
\n

int64

\n

The version number that was published.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form publication.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the publication was last modified.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this publication.

\n
\n \n
\n
\n
\n
\n
\n

publish_seq [required]

\n
\n

int64

\n

The sequential publication number for this form.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

self_service [required]

\n
\n

boolean

\n

Whether the form is available in the self-service catalog.

\n
\n \n
\n
\n
\n
\n
\n

single_response [required]

\n
\n

boolean

\n

Whether each user can only submit one response.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

object

\n

The attributes of a form version.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the version was created.

\n
\n \n
\n
\n
\n
\n
\n

data_definition [required]

\n
\n

object

\n

A JSON Schema definition that describes the form's data fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description shown to form respondents.

\n
\n \n
\n
\n
\n
\n
\n

properties

\n
\n

object

\n

A map of field names to their JSON Schema definitions.

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

[string]

\n

List of field names that must be answered.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the form schema.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The root schema type. \nAllowed enum values: object

default: object

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

definition_signature [required]

\n
\n

string

\n

The signature of the version definition.

\n
\n \n
\n
\n
\n
\n
\n

etag [required]

\n
\n

string

\n

The ETag for optimistic concurrency control.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form version.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the version was last modified.

\n
\n \n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

The state of a form version. \nAllowed enum values: draft,frozen

\n
\n \n
\n
\n
\n
\n
\n

ui_definition [required]

\n
\n

object

\n

UI configuration for rendering form fields, including widget overrides, field ordering, and themes.

\n
\n
\n
\n
\n
\n

ui:order

\n
\n

[string]

\n

The order in which form fields are displayed.

\n
\n \n
\n
\n
\n
\n
\n

ui:theme

\n
\n

object

\n

The visual theme applied to the form.

\n
\n
\n
\n
\n
\n

primaryColor

\n
\n

enum

\n

The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The sequential version number.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type for a form. \nAllowed enum values: forms

default: forms

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A form resource object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a form.

\n
\n
\n
\n
\n
\n

active [required]

\n
\n

boolean

\n

Whether the form is currently active.

\n
\n \n
\n
\n
\n
\n
\n

anonymous [required]

\n
\n

boolean

\n

Whether the form accepts anonymous submissions.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the form was created.

\n
\n \n
\n
\n
\n
\n
\n

datastore_config [required]

\n
\n

object

\n

The datastore configuration for a form.

\n
\n
\n
\n
\n
\n

datastore_id [required]

\n
\n

uuid

\n

The ID of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_column_name [required]

\n
\n

string

\n

The name of the primary column in the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_key_generation_strategy [required]

\n
\n

string

\n

The strategy used to generate primary keys in the datastore.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

The description of the form.

\n
\n \n
\n
\n
\n
\n
\n

end_date

\n
\n

date-time

\n

The date and time at which the form stops accepting responses.

\n
\n \n
\n
\n
\n
\n
\n

has_submitted

\n
\n

boolean

\n

Whether the current user has already submitted this form. Only present for forms with\nsingle_response set to true.

\n
\n \n
\n
\n
\n
\n
\n

idp_survey [required]

\n
\n

boolean

\n

Whether the form is an IDP survey.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the form was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the form.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this form.

\n
\n \n
\n
\n
\n
\n
\n

publication

\n
\n

object

\n

The attributes of a form publication.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the publication was created.

\n
\n \n
\n
\n
\n
\n
\n

form_id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

form_version [required]

\n
\n

int64

\n

The version number that was published.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form publication.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the publication was last modified.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this publication.

\n
\n \n
\n
\n
\n
\n
\n

publish_seq [required]

\n
\n

int64

\n

The sequential publication number for this form.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

self_service [required]

\n
\n

boolean

\n

Whether the form is available in the self-service catalog.

\n
\n \n
\n
\n
\n
\n
\n

single_response [required]

\n
\n

boolean

\n

Whether each user can only submit one response.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

object

\n

The attributes of a form version.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the version was created.

\n
\n \n
\n
\n
\n
\n
\n

data_definition [required]

\n
\n

object

\n

A JSON Schema definition that describes the form's data fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description shown to form respondents.

\n
\n \n
\n
\n
\n
\n
\n

properties

\n
\n

object

\n

A map of field names to their JSON Schema definitions.

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

[string]

\n

List of field names that must be answered.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the form schema.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The root schema type. \nAllowed enum values: object

default: object

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

definition_signature [required]

\n
\n

string

\n

The signature of the version definition.

\n
\n \n
\n
\n
\n
\n
\n

etag [required]

\n
\n

string

\n

The ETag for optimistic concurrency control.

\n
\n \n
\n
\n
\n
\n
\n

has_ever_been_published

\n
\n

boolean

\n

Whether this version number has ever appeared in the form's publication history.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form version.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the version was last modified.

\n
\n \n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

The state of a form version. \nAllowed enum values: draft,frozen

\n
\n \n
\n
\n
\n
\n
\n

ui_definition [required]

\n
\n

object

\n

UI configuration for rendering form fields, including widget overrides, field ordering, and themes.

\n
\n
\n
\n
\n
\n

ui:order

\n
\n

[string]

\n

The order in which form fields are displayed.

\n
\n \n
\n
\n
\n
\n
\n

ui:theme

\n
\n

object

\n

The visual theme applied to the form.

\n
\n
\n
\n
\n
\n

primaryColor

\n
\n

enum

\n

The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The sequential version number.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type for a form. \nAllowed enum values: forms

default: forms

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -1036,6 +1042,115 @@ "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data for publishing a form version.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes for publishing a form version.

\n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The version number to publish.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type for a form publication. \nAllowed enum values: form_publications

default: form_publications

\n
\n \n
\n
\n
\n
" } }, + "ListFormVersions": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "versions": [ + { + "created_at": "2026-05-29T20:06:14.895921Z", + "data_definition": { + "description": "Welcome to the Engineering Experience Survey.", + "properties": {}, + "required": [], + "title": "Developer Experience Survey", + "type": "string" + }, + "definition_signature": "{\"signature\":\"b7f312957a80cea2c8c9950532b205a90a3f8a7ebb7e52fc25437a25d903d545\",\"version\":1}", + "etag": "b51f08b698d88d8027a935d9db649774949f5fb41a0c559bfee6a9a13225c72d", + "has_ever_been_published": true, + "id": "126", + "modified_at": "2026-05-29T20:06:14.949163Z", + "state": "frozen", + "ui_definition": { + "ui:order": [], + "ui:theme": { + "primaryColor": "string" + } + }, + "user_id": 10001, + "user_uuid": "1fc709aa-be19-4539-a47d-52a30d78a978", + "version": 1 + } + ] + }, + "id": "22f6006a-2302-4926-9396-d2dfcf7b0b34", + "type": "form_version_lists" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A list-of-form-versions resource object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes for a list of form versions.

\n
\n
\n
\n
\n
\n

versions [required]

\n
\n

[object]

\n

The list of versions for the form.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the version was created.

\n
\n \n
\n
\n
\n
\n
\n

data_definition [required]

\n
\n

object

\n

A JSON Schema definition that describes the form's data fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description shown to form respondents.

\n
\n \n
\n
\n
\n
\n
\n

properties

\n
\n

object

\n

A map of field names to their JSON Schema definitions.

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

[string]

\n

List of field names that must be answered.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the form schema.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The root schema type. \nAllowed enum values: object

default: object

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

definition_signature [required]

\n
\n

string

\n

The signature of the version definition.

\n
\n \n
\n
\n
\n
\n
\n

etag [required]

\n
\n

string

\n

The ETag for optimistic concurrency control.

\n
\n \n
\n
\n
\n
\n
\n

has_ever_been_published

\n
\n

boolean

\n

Whether this version number has ever appeared in the form's publication history.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form version.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the version was last modified.

\n
\n \n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

The state of a form version. \nAllowed enum values: draft,frozen

\n
\n \n
\n
\n
\n
\n
\n

ui_definition [required]

\n
\n

object

\n

UI configuration for rendering form fields, including widget overrides, field ordering, and themes.

\n
\n
\n
\n
\n
\n

ui:order

\n
\n

[string]

\n

The order in which form fields are displayed.

\n
\n \n
\n
\n
\n
\n
\n

ui:theme

\n
\n

object

\n

The visual theme applied to the form.

\n
\n
\n
\n
\n
\n

primaryColor

\n
\n

enum

\n

The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The sequential version number.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type for a list of form versions. \nAllowed enum values: form_version_lists

default: form_version_lists

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "401": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, "UpsertFormVersion": { "responses": { "200": { @@ -1052,6 +1167,7 @@ }, "definition_signature": "{\"signature\":\"b7f312957a80cea2c8c9950532b205a90a3f8a7ebb7e52fc25437a25d903d545\",\"version\":1}", "etag": "b51f08b698d88d8027a935d9db649774949f5fb41a0c559bfee6a9a13225c72d", + "has_ever_been_published": true, "id": "126", "modified_at": "2026-05-29T20:06:14.949163Z", "state": "frozen", @@ -1069,7 +1185,7 @@ "type": "form_versions" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A form version resource object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a form version.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the version was created.

\n
\n \n
\n
\n
\n
\n
\n

data_definition [required]

\n
\n

object

\n

A JSON Schema definition that describes the form's data fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description shown to form respondents.

\n
\n \n
\n
\n
\n
\n
\n

properties

\n
\n

object

\n

A map of field names to their JSON Schema definitions.

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

[string]

\n

List of field names that must be answered.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the form schema.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The root schema type. \nAllowed enum values: object

default: object

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

definition_signature [required]

\n
\n

string

\n

The signature of the version definition.

\n
\n \n
\n
\n
\n
\n
\n

etag [required]

\n
\n

string

\n

The ETag for optimistic concurrency control.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form version.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the version was last modified.

\n
\n \n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

The state of a form version. \nAllowed enum values: draft,frozen

\n
\n \n
\n
\n
\n
\n
\n

ui_definition [required]

\n
\n

object

\n

UI configuration for rendering form fields, including widget overrides, field ordering, and themes.

\n
\n
\n
\n
\n
\n

ui:order

\n
\n

[string]

\n

The order in which form fields are displayed.

\n
\n \n
\n
\n
\n
\n
\n

ui:theme

\n
\n

object

\n

The visual theme applied to the form.

\n
\n
\n
\n
\n
\n

primaryColor

\n
\n

enum

\n

The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The sequential version number.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the form version.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type for a form version. \nAllowed enum values: form_versions

default: form_versions

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A form version resource object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a form version.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the version was created.

\n
\n \n
\n
\n
\n
\n
\n

data_definition [required]

\n
\n

object

\n

A JSON Schema definition that describes the form's data fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description shown to form respondents.

\n
\n \n
\n
\n
\n
\n
\n

properties

\n
\n

object

\n

A map of field names to their JSON Schema definitions.

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

[string]

\n

List of field names that must be answered.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the form schema.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The root schema type. \nAllowed enum values: object

default: object

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

definition_signature [required]

\n
\n

string

\n

The signature of the version definition.

\n
\n \n
\n
\n
\n
\n
\n

etag [required]

\n
\n

string

\n

The ETag for optimistic concurrency control.

\n
\n \n
\n
\n
\n
\n
\n

has_ever_been_published

\n
\n

boolean

\n

Whether this version number has ever appeared in the form's publication history.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form version.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the version was last modified.

\n
\n \n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

The state of a form version. \nAllowed enum values: draft,frozen

\n
\n \n
\n
\n
\n
\n
\n

ui_definition [required]

\n
\n

object

\n

UI configuration for rendering form fields, including widget overrides, field ordering, and themes.

\n
\n
\n
\n
\n
\n

ui:order

\n
\n

[string]

\n

The order in which form fields are displayed.

\n
\n \n
\n
\n
\n
\n
\n

ui:theme

\n
\n

object

\n

The visual theme applied to the form.

\n
\n
\n
\n
\n
\n

primaryColor

\n
\n

enum

\n

The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The sequential version number.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the form version.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type for a form version. \nAllowed enum values: form_versions

default: form_versions

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -1177,6 +1293,129 @@ "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data for creating or updating a form version.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes for creating or updating a form version.

\n
\n
\n
\n
\n
\n

data_definition [required]

\n
\n

object

\n

A JSON Schema definition that describes the form's data fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description shown to form respondents.

\n
\n \n
\n
\n
\n
\n
\n

properties

\n
\n

object

\n

A map of field names to their JSON Schema definitions.

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

[string]

\n

List of field names that must be answered.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the form schema.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The root schema type. \nAllowed enum values: object

default: object

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

The state of a form version. \nAllowed enum values: draft,frozen

\n
\n \n
\n
\n
\n
\n
\n

ui_definition [required]

\n
\n

object

\n

UI configuration for rendering form fields, including widget overrides, field ordering, and themes.

\n
\n
\n
\n
\n
\n

ui:order

\n
\n

[string]

\n

The order in which form fields are displayed.

\n
\n \n
\n
\n
\n
\n
\n

ui:theme

\n
\n

object

\n

The visual theme applied to the form.

\n
\n
\n
\n
\n
\n

primaryColor

\n
\n

enum

\n

The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

upsert_params [required]

\n
\n

object

\n

Concurrency control parameters for the form version upsert operation.

\n
\n
\n
\n
\n
\n

etag

\n
\n

string

\n

The ETag of the latest version. Required when match_policy is if_etag_match.

\n
\n \n
\n
\n
\n
\n
\n

insert_only

\n
\n

boolean

\n

If true, only a new version may be inserted; updating the current draft is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

match_policy [required]

\n
\n

enum

\n

The policy for matching the latest form version during an upsert operation. \nAllowed enum values: none,if_etag_match

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type for a form version. \nAllowed enum values: form_versions

default: form_versions

\n
\n \n
\n
\n
\n
" } }, + "RevertFormVersion": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "created_at": "2026-05-29T20:06:14.895921Z", + "data_definition": { + "description": "Welcome to the Engineering Experience Survey.", + "properties": {}, + "required": [], + "title": "Developer Experience Survey", + "type": "string" + }, + "definition_signature": "{\"signature\":\"b7f312957a80cea2c8c9950532b205a90a3f8a7ebb7e52fc25437a25d903d545\",\"version\":1}", + "etag": "b51f08b698d88d8027a935d9db649774949f5fb41a0c559bfee6a9a13225c72d", + "has_ever_been_published": true, + "id": "126", + "modified_at": "2026-05-29T20:06:14.949163Z", + "state": "frozen", + "ui_definition": { + "ui:order": [], + "ui:theme": { + "primaryColor": "string" + } + }, + "user_id": 10001, + "user_uuid": "1fc709aa-be19-4539-a47d-52a30d78a978", + "version": 1 + }, + "id": "126", + "type": "form_versions" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A form version resource object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a form version.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the version was created.

\n
\n \n
\n
\n
\n
\n
\n

data_definition [required]

\n
\n

object

\n

A JSON Schema definition that describes the form's data fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description shown to form respondents.

\n
\n \n
\n
\n
\n
\n
\n

properties

\n
\n

object

\n

A map of field names to their JSON Schema definitions.

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

[string]

\n

List of field names that must be answered.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the form schema.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The root schema type. \nAllowed enum values: object

default: object

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

definition_signature [required]

\n
\n

string

\n

The signature of the version definition.

\n
\n \n
\n
\n
\n
\n
\n

etag [required]

\n
\n

string

\n

The ETag for optimistic concurrency control.

\n
\n \n
\n
\n
\n
\n
\n

has_ever_been_published

\n
\n

boolean

\n

Whether this version number has ever appeared in the form's publication history.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form version.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the version was last modified.

\n
\n \n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

The state of a form version. \nAllowed enum values: draft,frozen

\n
\n \n
\n
\n
\n
\n
\n

ui_definition [required]

\n
\n

object

\n

UI configuration for rendering form fields, including widget overrides, field ordering, and themes.

\n
\n
\n
\n
\n
\n

ui:order

\n
\n

[string]

\n

The order in which form fields are displayed.

\n
\n \n
\n
\n
\n
\n
\n

ui:theme

\n
\n

object

\n

The visual theme applied to the form.

\n
\n
\n
\n
\n
\n

primaryColor

\n
\n

enum

\n

The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The sequential version number.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the form version.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type for a form version. \nAllowed enum values: form_versions

default: form_versions

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "401": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "409": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, "UpsertAndPublishFormVersion": { "responses": { "200": { @@ -1224,6 +1463,7 @@ }, "definition_signature": "{\"signature\":\"b7f312957a80cea2c8c9950532b205a90a3f8a7ebb7e52fc25437a25d903d545\",\"version\":1}", "etag": "b51f08b698d88d8027a935d9db649774949f5fb41a0c559bfee6a9a13225c72d", + "has_ever_been_published": true, "id": "126", "modified_at": "2026-05-29T20:06:14.949163Z", "state": "frozen", @@ -1242,7 +1482,7 @@ "type": "forms" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A form resource object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a form.

\n
\n
\n
\n
\n
\n

active [required]

\n
\n

boolean

\n

Whether the form is currently active.

\n
\n \n
\n
\n
\n
\n
\n

anonymous [required]

\n
\n

boolean

\n

Whether the form accepts anonymous submissions.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the form was created.

\n
\n \n
\n
\n
\n
\n
\n

datastore_config [required]

\n
\n

object

\n

The datastore configuration for a form.

\n
\n
\n
\n
\n
\n

datastore_id [required]

\n
\n

uuid

\n

The ID of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_column_name [required]

\n
\n

string

\n

The name of the primary column in the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_key_generation_strategy [required]

\n
\n

string

\n

The strategy used to generate primary keys in the datastore.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

The description of the form.

\n
\n \n
\n
\n
\n
\n
\n

end_date

\n
\n

date-time

\n

The date and time at which the form stops accepting responses.

\n
\n \n
\n
\n
\n
\n
\n

has_submitted

\n
\n

boolean

\n

Whether the current user has already submitted this form. Only present for forms with single_response set to true.

\n
\n \n
\n
\n
\n
\n
\n

idp_survey [required]

\n
\n

boolean

\n

Whether the form is an IDP survey.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the form was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the form.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this form.

\n
\n \n
\n
\n
\n
\n
\n

publication

\n
\n

object

\n

The attributes of a form publication.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the publication was created.

\n
\n \n
\n
\n
\n
\n
\n

form_id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

form_version [required]

\n
\n

int64

\n

The version number that was published.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form publication.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the publication was last modified.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this publication.

\n
\n \n
\n
\n
\n
\n
\n

publish_seq [required]

\n
\n

int64

\n

The sequential publication number for this form.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

self_service [required]

\n
\n

boolean

\n

Whether the form is available in the self-service catalog.

\n
\n \n
\n
\n
\n
\n
\n

single_response [required]

\n
\n

boolean

\n

Whether each user can only submit one response.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

object

\n

The attributes of a form version.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the version was created.

\n
\n \n
\n
\n
\n
\n
\n

data_definition [required]

\n
\n

object

\n

A JSON Schema definition that describes the form's data fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description shown to form respondents.

\n
\n \n
\n
\n
\n
\n
\n

properties

\n
\n

object

\n

A map of field names to their JSON Schema definitions.

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

[string]

\n

List of field names that must be answered.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the form schema.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The root schema type. \nAllowed enum values: object

default: object

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

definition_signature [required]

\n
\n

string

\n

The signature of the version definition.

\n
\n \n
\n
\n
\n
\n
\n

etag [required]

\n
\n

string

\n

The ETag for optimistic concurrency control.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form version.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the version was last modified.

\n
\n \n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

The state of a form version. \nAllowed enum values: draft,frozen

\n
\n \n
\n
\n
\n
\n
\n

ui_definition [required]

\n
\n

object

\n

UI configuration for rendering form fields, including widget overrides, field ordering, and themes.

\n
\n
\n
\n
\n
\n

ui:order

\n
\n

[string]

\n

The order in which form fields are displayed.

\n
\n \n
\n
\n
\n
\n
\n

ui:theme

\n
\n

object

\n

The visual theme applied to the form.

\n
\n
\n
\n
\n
\n

primaryColor

\n
\n

enum

\n

The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The sequential version number.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type for a form. \nAllowed enum values: forms

default: forms

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

A form resource object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a form.

\n
\n
\n
\n
\n
\n

active [required]

\n
\n

boolean

\n

Whether the form is currently active.

\n
\n \n
\n
\n
\n
\n
\n

anonymous [required]

\n
\n

boolean

\n

Whether the form accepts anonymous submissions.

\n
\n \n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the form was created.

\n
\n \n
\n
\n
\n
\n
\n

datastore_config [required]

\n
\n

object

\n

The datastore configuration for a form.

\n
\n
\n
\n
\n
\n

datastore_id [required]

\n
\n

uuid

\n

The ID of the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_column_name [required]

\n
\n

string

\n

The name of the primary column in the datastore.

\n
\n \n
\n
\n
\n
\n
\n

primary_key_generation_strategy [required]

\n
\n

string

\n

The strategy used to generate primary keys in the datastore.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

The description of the form.

\n
\n \n
\n
\n
\n
\n
\n

end_date

\n
\n

date-time

\n

The date and time at which the form stops accepting responses.

\n
\n \n
\n
\n
\n
\n
\n

has_submitted

\n
\n

boolean

\n

Whether the current user has already submitted this form. Only present for forms with\nsingle_response set to true.

\n
\n \n
\n
\n
\n
\n
\n

idp_survey [required]

\n
\n

boolean

\n

Whether the form is an IDP survey.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the form was last modified.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the form.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this form.

\n
\n \n
\n
\n
\n
\n
\n

publication

\n
\n

object

\n

The attributes of a form publication.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the publication was created.

\n
\n \n
\n
\n
\n
\n
\n

form_id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

form_version [required]

\n
\n

int64

\n

The version number that was published.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form publication.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the publication was last modified.

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization that owns this publication.

\n
\n \n
\n
\n
\n
\n
\n

publish_seq [required]

\n
\n

int64

\n

The sequential publication number for this form.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this publication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

self_service [required]

\n
\n

boolean

\n

Whether the form is available in the self-service catalog.

\n
\n \n
\n
\n
\n
\n
\n

single_response [required]

\n
\n

boolean

\n

Whether each user can only submit one response.

\n
\n \n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this form.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

object

\n

The attributes of a form version.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time at which the version was created.

\n
\n \n
\n
\n
\n
\n
\n

data_definition [required]

\n
\n

object

\n

A JSON Schema definition that describes the form's data fields.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

A description shown to form respondents.

\n
\n \n
\n
\n
\n
\n
\n

properties

\n
\n

object

\n

A map of field names to their JSON Schema definitions.

\n
\n \n
\n
\n
\n
\n
\n

required

\n
\n

[string]

\n

List of field names that must be answered.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

The title of the form schema.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The root schema type. \nAllowed enum values: object

default: object

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

definition_signature [required]

\n
\n

string

\n

The signature of the version definition.

\n
\n \n
\n
\n
\n
\n
\n

etag [required]

\n
\n

string

\n

The ETag for optimistic concurrency control.

\n
\n \n
\n
\n
\n
\n
\n

has_ever_been_published

\n
\n

boolean

\n

Whether this version number has ever appeared in the form's publication history.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the form version.

\n
\n \n
\n
\n
\n
\n
\n

modified_at [required]

\n
\n

date-time

\n

The time at which the version was last modified.

\n
\n \n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

The state of a form version. \nAllowed enum values: draft,frozen

\n
\n \n
\n
\n
\n
\n
\n

ui_definition [required]

\n
\n

object

\n

UI configuration for rendering form fields, including widget overrides, field ordering, and themes.

\n
\n
\n
\n
\n
\n

ui:order

\n
\n

[string]

\n

The order in which form fields are displayed.

\n
\n \n
\n
\n
\n
\n
\n

ui:theme

\n
\n

object

\n

The visual theme applied to the form.

\n
\n
\n
\n
\n
\n

primaryColor

\n
\n

enum

\n

The primary color of the form theme. \nAllowed enum values: gray,red,orange,yellow,green,light-blue,dark-blue,magenta,indigo

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

user_id [required]

\n
\n

int64

\n

The ID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

user_uuid [required]

\n
\n

uuid

\n

The UUID of the user who created this version.

\n
\n \n
\n
\n
\n
\n
\n

version [required]

\n
\n

int64

\n

The sequential version number.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The ID of the form.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The resource type for a form. \nAllowed enum values: forms

default: forms

\n
\n \n
\n
\n
\n
" }, "400": { "json": { diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 42ba30a4062..8c5627832df 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -39990,7 +39990,9 @@ components: nullable: true type: string has_submitted: - description: Whether the current user has already submitted this form. Only present for forms with `single_response` set to `true`. + description: |- + Whether the current user has already submitted this form. Only present for forms with + `single_response` set to `true`. nullable: true type: boolean idp_survey: @@ -40305,6 +40307,10 @@ components: example: b51f08b698d88d8027a935d9db649774949f5fb41a0c559bfee6a9a13225c72d nullable: true type: string + has_ever_been_published: + description: Whether this version number has ever appeared in the form's publication history. + example: true + type: boolean id: description: The ID of the form version. example: "126" @@ -40361,6 +40367,15 @@ components: - type - attributes type: object + FormVersionListType: + default: form_version_lists + description: The resource type for a list of form versions. + enum: + - form_version_lists + example: form_version_lists + type: string + x-enum-varnames: + - FORM_VERSION_LISTS FormVersionResponse: description: A response containing a single form version. properties: @@ -59560,6 +59575,41 @@ components: - data - meta type: object + ListFormVersionsData: + description: A list-of-form-versions resource object. + properties: + attributes: + $ref: "#/components/schemas/ListFormVersionsDataAttributes" + id: + description: The ID of the form. + example: 22f6006a-2302-4926-9396-d2dfcf7b0b34 + type: string + type: + $ref: "#/components/schemas/FormVersionListType" + required: + - id + - type + - attributes + type: object + ListFormVersionsDataAttributes: + description: The attributes for a list of form versions. + properties: + versions: + description: The list of versions for the form. + items: + $ref: "#/components/schemas/FormVersionAttributes" + type: array + required: + - versions + type: object + ListFormVersionsResponse: + description: A response containing the list of versions for a form. + properties: + data: + $ref: "#/components/schemas/ListFormVersionsData" + required: + - data + type: object ListHistoricalJobsResponse: description: List of historical jobs. properties: @@ -140601,7 +140651,9 @@ paths: **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: - description: Create a new form. The form is created in draft mode and must be published before it can be used. This also creates a new datastore for form responses and links it to the form. + description: |- + Create a new form. The form is created in draft mode and must be published before it can be used. This + also creates a new datastore for form responses and links it to the form. operationId: CreateForm requestBody: content: @@ -140676,7 +140728,9 @@ paths: If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/forms/create_and_publish: post: - description: Creates a new form and immediately publishes its initial version. This also creates a new datastore for form responses and links it to the form. + description: |- + Creates a new form and immediately publishes its initial version. This also creates a new datastore for + form responses and links it to the form. operationId: CreateAndPublishForm requestBody: content: @@ -140808,7 +140862,9 @@ paths: schema: format: uuid type: string - - description: The version of the form to retrieve. Use 'latest' for the most recent draft, 'published' for the last published version, or a specific version number. + - description: |- + The version of the form to retrieve. Use 'latest' for the most recent draft, 'published' for the + last published version, or a specific version number. in: query name: version required: false @@ -141038,7 +141094,7 @@ paths: summary: Clone a form tags: - Forms - x-menu-order: 9 + x-menu-order: 12 x-unstable: |- **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). @@ -141114,11 +141170,78 @@ paths: summary: Publish a form version tags: - Forms - x-menu-order: 8 + x-menu-order: 10 x-unstable: |- **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/forms/{form_id}/versions: + get: + description: List all versions of a form. + operationId: ListFormVersions + parameters: + - description: The ID of the form. + example: 22f6006a-2302-4926-9396-d2dfcf7b0b34 + in: path + name: form_id + required: true + schema: + format: uuid + type: string + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + versions: + - created_at: "2026-05-29T20:06:14.895921Z" + data_definition: {} + definition_signature: >- + {"signature":"b7f312957a80cea2c8c9950532b205a90a3f8a7ebb7e52fc25437a25d903d545", "version":1} + etag: b51f08b698d88d8027a935d9db649774949f5fb41a0c559bfee6a9a13225c72d + has_ever_been_published: true + id: "126" + modified_at: "2026-05-29T20:06:14.949163Z" + state: draft + ui_definition: {} + user_id: 10001 + user_uuid: 1fc709aa-be19-4539-a47d-52a30d78a978 + version: 2 + id: 22f6006a-2302-4926-9396-d2dfcf7b0b34 + type: form_version_lists + schema: + $ref: "#/components/schemas/ListFormVersionsResponse" + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "401": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: List form versions + tags: + - Forms + x-menu-order: 7 + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). post: description: |- Create or update the latest draft version of a form. The `upsert_params` field controls @@ -141162,7 +141285,8 @@ paths: created_at: "2026-05-29T20:06:14.895921Z" data_definition: $ref: "#/components/schemas/FormDataDefinition" - definition_signature: '{"signature":"b7f312957a80cea2c8c9950532b205a90a3f8a7ebb7e52fc25437a25d903d545","version":1}' + definition_signature: >- + {"signature":"b7f312957a80cea2c8c9950532b205a90a3f8a7ebb7e52fc25437a25d903d545", "version":1} etag: b51f08b698d88d8027a935d9db649774949f5fb41a0c559bfee6a9a13225c72d modified_at: "2026-05-29T20:06:14.949163Z" state: draft @@ -141198,7 +141322,87 @@ paths: summary: Create or update a form version tags: - Forms - x-menu-order: 7 + x-menu-order: 8 + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/forms/{form_id}/versions/revert: + post: + description: Revert a form to a prior version by creating a new draft version copied from it. + operationId: RevertFormVersion + parameters: + - description: The ID of the form. + example: 22f6006a-2302-4926-9396-d2dfcf7b0b34 + in: path + name: form_id + required: true + schema: + format: uuid + type: string + - description: The version number to revert to. + example: 1 + in: query + name: version + required: true + schema: + format: int64 + type: integer + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + created_at: "2026-05-29T20:10:14.895921Z" + data_definition: + $ref: "#/components/schemas/FormDataDefinition" + definition_signature: >- + {"signature":"c8f312957a80cea2c8c9950532b205a90a3f8a7ebb7e52fc25437a25d903d545", "version":1} + etag: c61f08b698d88d8027a935d9db649774949f5fb41a0c559bfee6a9a13225c72d + modified_at: "2026-05-29T20:10:14.949163Z" + state: draft + ui_definition: {} + user_id: 10001 + user_uuid: 1fc709aa-be19-4539-a47d-52a30d78a978 + version: 3 + id: "127" + type: form_versions + schema: + $ref: "#/components/schemas/FormVersionResponse" + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "401": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Not Found + "409": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Conflict + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: Revert a form to a prior version + tags: + - Forms + x-menu-order: 9 x-unstable: |- **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). @@ -141285,7 +141489,7 @@ paths: summary: Upsert and publish a form version tags: - Forms - x-menu-order: 10 + x-menu-order: 11 x-unstable: |- **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index 4bf4eba6157..b80a5b90bbb 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -1931,13 +1931,13 @@ "summary": "List forms" }, "CreateForm": { - "description": "Create a new form. The form is created in draft mode and must be published before it can be used. This also creates a new datastore for form responses and links it to the form.", + "description": "Create a new form. The form is created in draft mode and must be published before it can be used. This\nalso creates a new datastore for form responses and links it to the form.", "summary": "Create a form", "request_description": "", "request_schema_description": "A request to create a form." }, "CreateAndPublishForm": { - "description": "Creates a new form and immediately publishes its initial version. This also creates a new datastore for form responses and links it to the form.", + "description": "Creates a new form and immediately publishes its initial version. This also creates a new datastore for\nform responses and links it to the form.", "summary": "Create and publish a form", "request_description": "", "request_schema_description": "A request to create a form." @@ -1968,12 +1968,20 @@ "request_description": "", "request_schema_description": "A request to publish a form version." }, + "ListFormVersions": { + "description": "List all versions of a form.", + "summary": "List form versions" + }, "UpsertFormVersion": { "description": "Create or update the latest draft version of a form. The `upsert_params` field controls\noptimistic concurrency behavior.", "summary": "Create or update a form version", "request_description": "", "request_schema_description": "A request to create or update a form version." }, + "RevertFormVersion": { + "description": "Revert a form to a prior version by creating a new draft version copied from it.", + "summary": "Revert a form to a prior version" + }, "UpsertAndPublishFormVersion": { "description": "Upsert the latest form version and publish it in a single atomic transaction.", "summary": "Upsert and publish a form version",