Keystone Developers
Open Keystone
API reference

Public API

Form submissions

1 endpoint.

POST/api/v1/public/form_submissions

Submit a form

Submit a form with field values.

Request body must include `formType` (not form id); the API resolves the form definition for this account and stores the matching `form_id` server-side.

Auth via X-API-Key header.

Returns submission confirmation with optional event_id for ad tracking deduplication.

Parameters

NameInTypeDescription
X-API-Keyheaderstring | null

Request bodyrequired

application/jsonobject

Responses

200Successful Response
application/jsonSuccessResponse_PublicFormSubmissionResponse_
FieldTypeDescription
request_idrequiredstring
successtruedefault true
datarequiredPublicFormSubmissionResponse
PublicFormSubmissionResponse fields
FieldTypeDescription
submission_idrequiredstring
form_typerequiredstring
messagestringdefault "Form submitted successfully."
event_idstring | null
metadataResponseMetadata | null
ResponseMetadata fields
FieldTypeDescription
paginationPaginationMetadata | null
PaginationMetadata fields
FieldTypeDescription
limitrequiredinteger
next_cursorstring | null
prev_cursorstring | null
has_morerequiredboolean
has_prevbooleandefault false
total_countinteger | null
status_countsobject | null
object | null fields

Map of string to integer

lifecycle_countsLifecycleCounts | null
LifecycleCounts fields
FieldTypeDescription
leadintegerdefault 0
prospectintegerdefault 0
customerintegerdefault 0
former_customerintegerdefault 0
classification_countsClassificationCounts | null
ClassificationCounts fields
FieldTypeDescription
signalobject
object fields

Nested object (not expanded)

touchobject
object fields

Nested object (not expanded)

stageobject
object fields

Nested object (not expanded)

metaResponseMeta | null
ResponseMeta fields
FieldTypeDescription
totalinteger | null
total_countinteger | null
pageinteger | null
per_pageinteger | null
  • 400Bad request
  • 401Unauthorized
  • 403Forbidden
  • 404Not found
  • 422Validation error
  • 500Internal server error
  • 503Service unavailable

Error bodies: ErrorResponse. See Errors.