Public API

Forms

1 endpoint.

GET/api/v1/public/forms/{form_type}

Get form by type

Get a live form definition by identity (built-in or custom) for the business.

Returns the form's fields and settings needed to render it client-side. Only ``live`` forms are served; an unknown identity or a non-live form returns a typed 404 (``FORM_NOT_AVAILABLE``), never a 500. Auth via X-API-Key header.

Parameters

Name	In	Type	Description
`form_type`required	path	`string`
`X-API-Key`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_PublicForm_

Field Type Description

request_idrequired string

success true default true

datarequired

PublicForm

PublicForm fields

Field Type Description

idrequired string

namerequired string

form_typerequired string

fields

(FormFieldSchema | FormFieldSchema[])[]

(FormFieldSchema | FormFieldSchema[])[] fields

Nested object (not expanded)

settings

FormSettingsSchema

FormSettingsSchema fields

Field	Type	Description
`send_events`	`string[]`	string[] fields Nested object (not expanded)
`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

created_atrequired string (date-time)

updated_atrequired 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.