Console API

Forms

8 endpoints.

GET/api/v1/admin/businesses/{business_id}/form_submissions

List all form submissions

List all form submissions; cursor is the last ``id`` from the previous page (UUID v7).

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`form_type`	query	`string \| null`	Filter by form identity (built-in or custom slug, e.g. lead, demo-request)
`limit`	query	`integer`	default 25
`cursor`	query	`string \| null`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_FormSubmissionSummary__

Field Type Description

request_idrequired string

success true default true

datarequired

FormSubmissionSummary[]

FormSubmissionSummary[] fields

Field	Type	Description
`id`required	`string`
`form_type`required	`string`
`data`	`FormSubmissionDataSchema`
`form`	`FormSummary \| null`	FormSummary fields FormSummary (not expanded)
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`

metadata

ResponseMetadata | null

ResponseMetadata fields

Field Type Description

pagination

PaginationMetadata | null

PaginationMetadata fields

Field	Type	Description
`limit`required	`integer`
`next_cursor`	`string \| null`
`prev_cursor`	`string \| null`
`has_more`required	`boolean`
`has_prev`	`boolean`	default false
`total_count`	`integer \| null`

status_counts

object | null

object | null fields

Map of string to integer

lifecycle_counts

LifecycleCounts | null

LifecycleCounts fields

Field	Type	Description
`lead`	`integer`	default 0
`prospect`	`integer`	default 0
`customer`	`integer`	default 0
`former_customer`	`integer`	default 0

classification_counts

ClassificationCounts | null

ClassificationCounts fields

Field	Type	Description
`signal`	`object`	object fields Nested object (not expanded)
`touch`	`object`	object fields Nested object (not expanded)
`stage`	`object`	object fields Nested object (not expanded)

meta

ResponseMeta | null

ResponseMeta fields

Field	Type	Description
`total`	`integer \| null`
`total_count`	`integer \| null`
`page`	`integer \| null`
`per_page`	`integer \| null`

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/form_submissions/{submission_id}

Get form submission details

Get detailed form submission including form info.

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`submission_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_FormSubmissionDetail_

Field Type Description

request_idrequired string

success true default true

datarequired

FormSubmissionDetail

FormSubmissionDetail fields

Field	Type	Description
`id`required	`string`
`business_id`required	`string`
`form_id`required	`string`
`form_type`required	`string`
`data`	`FormSubmissionDataSchema`
`form`	`FormSummary \| null`	FormSummary fields FormSummary, expanded above.
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

DELETE/api/v1/admin/businesses/{business_id}/form_submissions/{submission_id}

Delete form submission

Soft delete a form submission. 404 if not found.

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`submission_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

204Successful Response

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/forms

List forms

List forms for a business (optionally filtered by status) with submission counts.

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`status`	query	`string \| null`	Filter by status: draft, live, archived
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_FormSummary__

Field Type Description

request_idrequired string

success true default true

datarequired

FormSummary[]

FormSummary[] fields

Field	Type	Description
`id`required	`string`
`business_id`required	`string`
`name`required	`string`
`form_type`required	`string`
`status`	`FormStatus`	default "live"
`is_builtin`	`boolean`	default false
`field_count`	`integer`	default 0
`submissions_count`	`integer`	default 0
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/admin/businesses/{business_id}/forms

``form_type`` is the immutable per-business identity; when omitted it is slugified from ``name``. A reserved built-in identity (``lead``, …) is rejected (400 RESERVED_FORM_TYPE); a duplicate identity → 409 FORM_ALREADY_EXISTS. New forms default to ``draft``. Snapshots are lazy: a draft gets no snapshot; the first snapshot is created when the form is created (or later set) ``live``.

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonFormCreateRequest

Field Type Description

namerequired string

form_type string | null

fields

(FormFieldSchema | FormFieldSchema[])[]

(FormFieldSchema | FormFieldSchema[])[] fields

FormFieldSchema

FormFieldSchema (not expanded)

FormFieldSchema[]

Nested object (not expanded)

settings

FormSettingsSchema | null

FormSettingsSchema fields

Field	Type	Description
`send_events`	`string[]`	string[] fields
`show_transactional_sms_consent`	`boolean`	default false
`show_marketing_sms_consent`	`boolean`	default false
`show_tos_privacy_consent`	`boolean`	default false
`tos_privacy_required`	`boolean`	default false
`sync_contact`	`boolean`	default false
`sync_job`	`boolean`	default false
`enroll_conversation_ai`	`boolean`	default false
`allow_extra_fields`	`boolean`	default true

status FormStatus default "draft"

description string | null

submit_button_label string | null

confirmation_message string | null

Responses

201Successful Response

application/jsonSuccessResponse_FormData_

Field Type Description

request_idrequired string

success true default true

datarequired

FormData

FormData fields

Field	Type	Description
`id`required	`string`
`business_id`required	`string`
`name`required	`string`
`form_type`required	`string`
`status`	`FormStatus`	default "live"
`is_builtin`	`boolean`	default false
`fields`	`(FormFieldSchema \| FormFieldSchema[])[]`	(FormFieldSchema \| FormFieldSchema[])[] fields Nested object (not expanded)
`settings`	`FormSettingsSchema`	FormSettingsSchema fields FormSettingsSchema, expanded above.
`description`	`string \| null`
`submit_button_label`	`string \| null`
`confirmation_message`	`string \| null`
`submissions_count`	`integer`	default 0
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/forms/{form_id}

Get form details

Get detailed form including fields, settings, and submission count.

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`form_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_FormData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`FormData`	FormData fields FormData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

PUT/api/v1/admin/businesses/{business_id}/forms/{form_id}

Update form

Update a form's name, fields, and/or settings.

Partial update: omitted keys are left unchanged. ``form_type`` is immutable; fields marked ``fixed: true`` cannot be removed, modified, or unmarked unless ``bypass_fixed: true`` is sent — which requires the caller to be a **platform admin** (role_id == 100). Changing a **custom** form's ``settings`` likewise requires platform admin (a no-op settings payload is allowed). 404 if the form does not exist.

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`form_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonFormUpdateRequest

Field	Type	Description
`name`	`string \| null`
`fields`	`(FormFieldSchema \| FormFieldSchema[])[] \| null`	(FormFieldSchema \| FormFieldSchema[])[] \| null fields FormFieldSchema FormFieldSchema (not expanded) FormFieldSchema[] Nested object (not expanded)
`settings`	`FormSettingsSchema \| null`	FormSettingsSchema fields FormSettingsSchema, expanded above.
`status`	`FormStatus \| null`
`description`	`string \| null`
`submit_button_label`	`string \| null`
`confirmation_message`	`string \| null`
`bypass_fixed`	`boolean`	default false

Responses

200Successful Response

application/jsonSuccessResponse_FormData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`FormData`	FormData fields FormData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/forms/{form_id}/submissions

List submissions for a form

List submissions for a specific form; cursor is the last ``id`` from the previous page (UUID v7).

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`form_id`required	path	`string (uuid)`
`limit`	query	`integer`	default 25
`cursor`	query	`string \| null`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_FormSubmissionSummary__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`FormSubmissionSummary[]`	FormSubmissionSummary[] fields FormSubmissionSummary, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.