curl --request GET \
--url https://api.letsdothis.com/v0/booking-form-fields/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.letsdothis.com/v0/booking-form-fields/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.letsdothis.com/v0/booking-form-fields/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "6651a3e8f2b47c0019d3a8d4",
"publicId": "tshirt-size",
"type": "SELECT",
"name": "T-shirt size",
"nameByLocale": {
"en-GB": "T-shirt size"
},
"required": true,
"options": [
{
"id": "6651a3e8f2b47c0019d3a8e1",
"label": "Small",
"labelByLocale": {
"en-GB": "Small"
}
},
{
"id": "6651a3e8f2b47c0019d3a8e2",
"label": "Medium",
"labelByLocale": {
"en-GB": "Medium"
}
},
{
"id": "6651a3e8f2b47c0019d3a8e3",
"label": "Large",
"labelByLocale": {
"en-GB": "Large"
}
}
]
}{
"statusCode": 404,
"error": "<string>",
"message": "<string>"
}Get a booking form field by ID
Returns a single booking form field by ID if it belongs to the organizer associated with your Public API credentials.
curl --request GET \
--url https://api.letsdothis.com/v0/booking-form-fields/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.letsdothis.com/v0/booking-form-fields/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.letsdothis.com/v0/booking-form-fields/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "6651a3e8f2b47c0019d3a8d4",
"publicId": "tshirt-size",
"type": "SELECT",
"name": "T-shirt size",
"nameByLocale": {
"en-GB": "T-shirt size"
},
"required": true,
"options": [
{
"id": "6651a3e8f2b47c0019d3a8e1",
"label": "Small",
"labelByLocale": {
"en-GB": "Small"
}
},
{
"id": "6651a3e8f2b47c0019d3a8e2",
"label": "Medium",
"labelByLocale": {
"en-GB": "Medium"
}
},
{
"id": "6651a3e8f2b47c0019d3a8e3",
"label": "Large",
"labelByLocale": {
"en-GB": "Large"
}
}
]
}{
"statusCode": 404,
"error": "<string>",
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the resource to query by
Response
Default Response
A booking form field definition — the type, label, options, and required-ness of a single question a booker is asked.
The unique identifier of the field. Stable across the forms a field is used on. Use this as the :id when looking the field up.
The type of a booking form field, determining how it is rendered and what answer it collects.
TEXT, TEXT_AREA, EMAIL, PHONE_NUMBER, ADDRESS, DATE, DURATION, SELECT, GROUP_SELECT, RADIO_BUTTONS, CHECK_BOXES, WAIVER, CUSTOM_COMPONENT, CHARITY_MARKETING_OPT_INS, HTML The default label of the field.
Field label translated to multiple locales. Always includes the default name.
Show child attributes
Show child attributes
Whether an answer to this field is required to complete a booking.
A non-unique grouping key that correlates equivalent fields across forms and tickets. Informational only — not usable as a lookup :id.
The default description of the field, if any.
Field description translated to multiple locales. Present only when the field has a description.
Show child attributes
Show child attributes
The selectable options, for choice fields (select, radio, checkbox).
Show child attributes
Show child attributes
How to express an answer for this field in an import payload, and how to find it again on booking reads.
Show child attributes
Show child attributes
{
"placement": "participant",
"answerShape": "keyedValues",
"subKeys": [
"addressLine1",
"addressLine2",
"addressLineCity",
"addressLineCounty",
"addressLineCountry",
"addressLinePostcode"
]
}
Was this page helpful?

