Get Scheduling Form

Overview

Returns the definition of the business's scheduling form - the fields a client must fill in when booking.

Why you need it

The field uids returned here are the keys of form_data.fields in POST /platform/v1/scheduling/bookings. Every field with required: true must be present in form_data.fields, otherwise the booking fails with 422 FORM_VALIDATION_ERROR. There is no fixed set of uids - they differ per business, so this endpoint must be called before booking.

Structure

data.sections is an array of sections. A section of type: "fields" carries fields as an array of arrays (rows of fields); a section of type: "policies" carries policy entries whose id (e.g. meetings_policy) is the key used in form_data.policies.

Accessible without authentication, as well as with Client, Staff and Directory tokens.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Business uid

string

Service uid, to get the form for a specific service. Omit it and the business-level form is returned, which can miss service-specific fields. Accepts a comma-separated list of uids for a multi-service booking (e.g. "vpa6mzkt11f1n2pc,x8enou59f38uy7kb").

Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json