Booking Flow

Intake Forms

Endpoints to manage IntakeFormSections and IntakeFormQuestions.

get/shop/intake-form-sections

List orderable IntakeFormSections

listOrderableIntakeFormSections

Returns a list of orderable IntakeFormSections for the given site.

Query parameters

site_idstringrequired
Filter results by the site they belong to

Responses

200
Successfully retrieved orderable IntakeFormSections.
401
The user is unauthenticated
403
The authenticated user does not have permission.

curl "https://api.playground.try.be/shop/intake-form-sections/order?site_id=site_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/intake-form-sections/order?site_id=site_abc123', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/intake-form-sections/order?site_id=site_abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/intake-form-sections/order?site_id=site_abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/intake-form-sections/order?site_id=site_abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

Successfully retrieved orderable `IntakeFormSection`s.

{
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "title": "string"
    }
  ]
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

put/shop/intake-form-sections/order

Update orderable IntakeFormSections

updateOrderableIntakeFormSections

Updates the order of IntakeFormSections for the given site.

Request body

intake_form_section_idsstring[]required
site_iduuidrequired
ID of the site whose intake form section order is being updated. The caller's API key must have access to this site.

Responses

200
Successfully retrieved orderable IntakeFormSections.
401
The user is unauthenticated
403
The authenticated user does not have permission.
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/intake-form-sections/order" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "intake_form_section_ids": [
    "64a9f3b2c3d8e1f4a5b6c7d8"
  ],
  "site_id": "00000000-0000-0000-0000-000000000000"
}'

const response = await fetch('https://api.playground.try.be/shop/intake-form-sections/order', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "intake_form_section_ids": [
      "64a9f3b2c3d8e1f4a5b6c7d8"
    ],
    "site_id": "00000000-0000-0000-0000-000000000000"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/shop/intake-form-sections/order",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "intake_form_section_ids": [
            "64a9f3b2c3d8e1f4a5b6c7d8"
        ],
        "site_id": "00000000-0000-0000-0000-000000000000"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/intake-form-sections/order', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'intake_form_section_ids' => [
                '64a9f3b2c3d8e1f4a5b6c7d8'
            ],
            'site_id' => '00000000-0000-0000-0000-000000000000'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"intake_form_section_ids": []interface{}{
			"64a9f3b2c3d8e1f4a5b6c7d8",
		},
		"site_id": "00000000-0000-0000-0000-000000000000",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/intake-form-sections/order", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

Successfully retrieved orderable `IntakeFormSection`s.

{
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "title": "string"
    }
  ]
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/shop/intake-form-sections/{intakeFormSectionId}

Retrieve an IntakeFormSection

getIntakeFormSection

Returns a paginated list of intake form sections for the authenticated site.

Path parameters

intakeFormSectionIdobject-idrequired
The ID of the IntakeFormSection.

Responses

200
Successfully retrieved IntakeFormSection.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/intake-form-sections/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/intake-form-sections/abc123', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/intake-form-sections/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/intake-form-sections/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/intake-form-sections/abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

Successfully retrieved `IntakeFormSection`.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "created_at": "2026-01-15T09:30:00+00:00",
    "deleted_at": "2026-01-15T09:30:00+00:00",
    "description": "Pre-treatment health questions and consent",
    "intro_text": "Please answer honestly — these questions help us tailor your\ntreatment safely.\n",
    "offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "outro_text": "Thank you. Please proceed to checkout when you're ready.\n",
    "questions": [
      {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "additional_details": false,
        "exact_number": "string",
        "multiple_choice_answers": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "text": "string"
          }
        ],
        "multiple_select_option": "string",
        "multiple_selection": false,
        "order": 1,
        "placeholder": "string",
        "question": "string",
        "range": [
          1
        ],
        "required": false,
        "terms_statement": "string",
        "type": "additional_details"
      }
    ],
    "title": "Health Declaration",
    "type": "mandatory",
    "updated_at": "2025-02-04T12:00:00+01:00"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

put/shop/intake-form-sections/{intakeFormSectionId}

Update an IntakeFormSection

updateIntakeFormSection

Use this endpoint to update an IntakeFormSection.

Path parameters

intakeFormSectionIdobject-idrequired
The ID of the IntakeFormSection.

Request body

descriptionstringoptional
Admin-facing description of what this intake form section captures. Visible in the questionnaire builder but not shown to customers.
intro_textstringoptionalnullable
Optional rich-text shown to the customer at the top of the section. Markdown is rendered.
offeringsobject[]optional
Offerings this intake form section is attached to.
orderintegeroptional
Zero-based display order of this section relative to others on the same form. Lower values appear first.
outro_textstringoptionalnullable
Optional rich-text shown to the customer at the foot of the section, after the questions.
titlestringoptional
Customer-facing heading for the section. Plain text only — HTML tags are stripped.
typestringoptionalnullable
Optional category flag. mandatory marks the section as non-skippable in the intake flow — the customer must complete it before checkout. Null (the default) makes the section advisory.
Possible values:mandatory

Responses

200
Successfully updated an IntakeFormSection.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/intake-form-sections/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "Pre-treatment health questions and consent",
  "intro_text": "Please answer honestly — these questions help us tailor your\ntreatment safely.\n",
  "offerings": [
    {
      "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "offering_name": "Twilight massage",
      "offering_type": "appointment"
    }
  ],
  "order": 0,
  "outro_text": "Thank you. Please proceed to checkout when you'\''re ready.\n",
  "title": "Health Declaration",
  "type": "mandatory"
}'

const response = await fetch('https://api.playground.try.be/shop/intake-form-sections/abc123', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "description": "Pre-treatment health questions and consent",
    "intro_text": "Please answer honestly — these questions help us tailor your\ntreatment safely.\n",
    "offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "order": 0,
    "outro_text": "Thank you. Please proceed to checkout when you're ready.\n",
    "title": "Health Declaration",
    "type": "mandatory"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/shop/intake-form-sections/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "description": "Pre-treatment health questions and consent",
        "intro_text": "Please answer honestly — these questions help us tailor your\ntreatment safely.\n",
        "offerings": [
            {
                "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
                "offering_name": "Twilight massage",
                "offering_type": "appointment"
            }
        ],
        "order": 0,
        "outro_text": "Thank you. Please proceed to checkout when you're ready.\n",
        "title": "Health Declaration",
        "type": "mandatory"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/intake-form-sections/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'description' => 'Pre-treatment health questions and consent',
            'intro_text' => 'Please answer honestly — these questions help us tailor your
treatment safely.
',
            'offerings' => [
                [
                    'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
                    'offering_name' => 'Twilight massage',
                    'offering_type' => 'appointment'
                ]
            ],
            'order' => 0,
            'outro_text' => 'Thank you. Please proceed to checkout when you\'re ready.
',
            'title' => 'Health Declaration',
            'type' => 'mandatory'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"description": "Pre-treatment health questions and consent",
		"intro_text": "Please answer honestly — these questions help us tailor your\ntreatment safely.\n",
		"offerings": []interface{}{
			map[string]interface{}{
				"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
				"offering_name": "Twilight massage",
				"offering_type": "appointment",
			},
		},
		"order": 0,
		"outro_text": "Thank you. Please proceed to checkout when you're ready.\n",
		"title": "Health Declaration",
		"type": "mandatory",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/intake-form-sections/abc123", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

Successfully updated an `IntakeFormSection`.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "created_at": "2026-01-15T09:30:00+00:00",
    "deleted_at": "2026-01-15T09:30:00+00:00",
    "description": "Pre-treatment health questions and consent",
    "intro_text": "Please answer honestly — these questions help us tailor your\ntreatment safely.\n",
    "offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "outro_text": "Thank you. Please proceed to checkout when you're ready.\n",
    "questions": [
      {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "additional_details": false,
        "exact_number": "string",
        "multiple_choice_answers": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "text": "string"
          }
        ],
        "multiple_select_option": "string",
        "multiple_selection": false,
        "order": 1,
        "placeholder": "string",
        "question": "string",
        "range": [
          1
        ],
        "required": false,
        "terms_statement": "string",
        "type": "additional_details"
      }
    ],
    "title": "Health Declaration",
    "type": "mandatory",
    "updated_at": "2025-02-04T12:00:00+01:00"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/shop/intake-form-sections/{intakeFormSectionId}

Delete an IntakeFormSection

deleteIntakeFormSection

Use this endpoint to delete an IntakeFormSection.

Path parameters

intakeFormSectionIdobject-idrequired
The ID of the IntakeFormSection.

Responses

204
Successfully deleted the IntakeFormSection.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/shop/intake-form-sections/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/intake-form-sections/abc123', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.delete(
    "https://api.playground.try.be/shop/intake-form-sections/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://api.playground.try.be/shop/intake-form-sections/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.playground.try.be/shop/intake-form-sections/abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

Successfully deleted the `IntakeFormSection`.

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

get/shop/intake-form-sections/{intakeFormSectionId}/questions

List IntakeFormQuestions

listIntakeFormQuestions

Use this endpoint to list paginated IntakeFormQuestions for an IntakeFormSection.

Path parameters

intakeFormSectionIdobject-idrequired
The ID of the IntakeFormSection.

Query parameters

pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page
site_idobject-idrequired
The ID of the Site associated with the IntakeFormQuestion.

Responses

200
Successfully retrieved IntakeFormQuestions.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/intake-form-sections/abc123/questions?site_id=site_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/intake-form-sections/abc123/questions?site_id=site_abc123', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/intake-form-sections/abc123/questions?site_id=site_abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/intake-form-sections/abc123/questions?site_id=site_abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/intake-form-sections/abc123/questions?site_id=site_abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

Successfully retrieved `IntakeFormQuestion`s.

{
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  },
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "additional_details": false,
      "exact_number": "string",
      "multiple_choice_answers": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "text": "string"
        }
      ],
      "multiple_select_option": "string",
      "multiple_selection": false,
      "order": 1,
      "placeholder": "string",
      "question": "string",
      "range": [
        1
      ],
      "required": false,
      "terms_statement": "string",
      "type": "additional_details"
    }
  ]
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

post/shop/intake-form-sections/{intakeFormSectionId}/questions

Creates a new IntakeFormQuestion in the parent section. The new question is appended to the end of the section's question list; use the intake-form-sections/{intakeFormSectionId}/questions/order endpoint to reposition it afterwards.

question and type are required. multiple_choice questions additionally require at least two entries in multiple_choice_answers. terms_statement HTML is sanitised against the site's allowed-tag list before persisting.

Requires the SETTINGS_MANAGE permission on the section's site.

Path parameters

intakeFormSectionIdobject-idrequired
The ID of the IntakeFormSection.

Query parameters

pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page
site_idobject-idrequired
The ID of the Site associated with the IntakeFormQuestion.

Request body

questionstringoptional
The question text.
typestringoptional
The type of question. Drives input rendering on the customer intake form and unlocks the type-specific fields below.
Possible values:additional_detailsdate_timeemailmultiple_choicephoneterms_conditionstext_longtextyes_no
multiple_choice_answersobject[]optionalnullable
Available answers when type=multiple_choice. Must contain at least two entries when the type is multiple_choice.
multiple_select_optionstringoptionalnullable
Optional bonus label rendered alongside the multiple-choice answers (e.g. "Other"). Only meaningful when type=multiple_choice.
multiple_selectionbooleanoptionalnullable
Whether the customer can pick more than one multiple_choice_answers entry. Only meaningful when type=multiple_choice.
additional_detailsbooleanoptionalnullable
When true, the customer is prompted for free-text "additional details" alongside the structured answer.
exact_numberstringoptionalnullable
Optional exact-number constraint for numeric questions.
rangeinteger[]optionalnullable
A two-element [min, max] constraint on multiple_choice_answers selections. Both bounds are inclusive; omit either to leave it unbounded.
terms_statementstringoptionalnullable
Terms text rendered alongside type=terms_conditions questions. HTML is sanitised to the site's allowed-tag list.
placeholderstringoptionalnullable
Placeholder text for the input field.
requiredbooleanoptionalnullable
Whether the customer must answer this question.

Responses

201
The question was created successfully.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/intake-form-sections/abc123/questions?site_id=site_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "question": "Do you have any allergies?",
  "type": "additional_details",
  "multiple_choice_answers": [
    {
      "id": 1,
      "text": "string"
    }
  ],
  "multiple_select_option": "string",
  "multiple_selection": false,
  "additional_details": false,
  "exact_number": "string",
  "range": [
    1
  ],
  "terms_statement": "string",
  "placeholder": "string",
  "required": false
}'

const response = await fetch('https://api.playground.try.be/shop/intake-form-sections/abc123/questions?site_id=site_abc123', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "question": "Do you have any allergies?",
    "type": "additional_details",
    "multiple_choice_answers": [
      {
        "id": 1,
        "text": "string"
      }
    ],
    "multiple_select_option": "string",
    "multiple_selection": false,
    "additional_details": false,
    "exact_number": "string",
    "range": [
      1
    ],
    "terms_statement": "string",
    "placeholder": "string",
    "required": false
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/intake-form-sections/abc123/questions?site_id=site_abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "question": "Do you have any allergies?",
        "type": "additional_details",
        "multiple_choice_answers": [
            {
                "id": 1,
                "text": "string"
            }
        ],
        "multiple_select_option": "string",
        "multiple_selection": False,
        "additional_details": False,
        "exact_number": "string",
        "range": [
            1
        ],
        "terms_statement": "string",
        "placeholder": "string",
        "required": False
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/intake-form-sections/abc123/questions?site_id=site_abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'question' => 'Do you have any allergies?',
            'type' => 'additional_details',
            'multiple_choice_answers' => [
                [
                    'id' => 1,
                    'text' => 'string'
                ]
            ],
            'multiple_select_option' => 'string',
            'multiple_selection' => false,
            'additional_details' => false,
            'exact_number' => 'string',
            'range' => [
                1
            ],
            'terms_statement' => 'string',
            'placeholder' => 'string',
            'required' => false
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"question": "Do you have any allergies?",
		"type": "additional_details",
		"multiple_choice_answers": []interface{}{
			map[string]interface{}{
				"id": 1,
				"text": "string",
			},
		},
		"multiple_select_option": "string",
		"multiple_selection": false,
		"additional_details": false,
		"exact_number": "string",
		"range": []interface{}{
			1,
		},
		"terms_statement": "string",
		"placeholder": "string",
		"required": false,
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/intake-form-sections/abc123/questions?site_id=site_abc123", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The question was created successfully.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "additional_details": false,
    "exact_number": "string",
    "multiple_choice_answers": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "text": "string"
      }
    ],
    "multiple_select_option": "string",
    "multiple_selection": false,
    "order": 1,
    "placeholder": "string",
    "question": "string",
    "range": [
      1
    ],
    "required": false,
    "terms_statement": "string",
    "type": "additional_details"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

put/shop/intake-form-sections/{intakeFormSectionId}/questions/order

Order IntakeFormQuestions

updateIntakeFormQuestionsOrder

Use this endpoint to order IntakeFormQuestions for an IntakeFormSection.

Path parameters

intakeFormSectionIdobject-idrequired
The ID of the IntakeFormSection.

Request body

intake_form_question_idsstring[]required
An ordered list of intake form question IDs. Must contain at least 2 items.
site_idstringrequired
ID of the site whose intake-form question order should be updated. The caller's API key must have access to this site and to the parent intake form section.

Responses

200
Successfully ordered IntakeFormQuestions.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/intake-form-sections/abc123/questions/order" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "intake_form_question_ids": [
    "string"
  ],
  "site_id": "9c7e0e8c-8d4d-4a6e-9f0c-3a4b5c6d7e8f"
}'

const response = await fetch('https://api.playground.try.be/shop/intake-form-sections/abc123/questions/order', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "intake_form_question_ids": [
      "string"
    ],
    "site_id": "9c7e0e8c-8d4d-4a6e-9f0c-3a4b5c6d7e8f"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/shop/intake-form-sections/abc123/questions/order",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "intake_form_question_ids": [
            "string"
        ],
        "site_id": "9c7e0e8c-8d4d-4a6e-9f0c-3a4b5c6d7e8f"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/intake-form-sections/abc123/questions/order', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'intake_form_question_ids' => [
                'string'
            ],
            'site_id' => '9c7e0e8c-8d4d-4a6e-9f0c-3a4b5c6d7e8f'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"intake_form_question_ids": []interface{}{
			"string",
		},
		"site_id": "9c7e0e8c-8d4d-4a6e-9f0c-3a4b5c6d7e8f",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/intake-form-sections/abc123/questions/order", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

Successfully ordered `IntakeFormQuestion`s.

{
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "additional_details": false,
      "exact_number": "string",
      "multiple_choice_answers": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "text": "string"
        }
      ],
      "multiple_select_option": "string",
      "multiple_selection": false,
      "order": 1,
      "placeholder": "string",
      "question": "string",
      "range": [
        1
      ],
      "required": false,
      "terms_statement": "string",
      "type": "additional_details"
    }
  ]
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/shop/intake-form-sections/{intakeFormSectionId}/questions/{intakeFormQuestionId}

Get an IntakeFormQuestion

getIntakeFormQuestion

Returns a single IntakeFormQuestion by ID, including its multiple-choice answers, range constraints, and terms statement where applicable.

Requires the SETTINGS_VIEW permission on the section's site.

Path parameters

intakeFormSectionIdobject-idrequired
The ID of the IntakeFormSection.
intakeFormQuestionIdobject-idrequired
The unique identifier of the IntakeFormQuestion.

Responses

200
The question was retrieved successfully.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/intake-form-sections/abc123/questions/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/intake-form-sections/abc123/questions/abc123', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/intake-form-sections/abc123/questions/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/intake-form-sections/abc123/questions/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/intake-form-sections/abc123/questions/abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The question was retrieved successfully.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "additional_details": false,
    "exact_number": "string",
    "multiple_choice_answers": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "text": "string"
      }
    ],
    "multiple_select_option": "string",
    "multiple_selection": false,
    "order": 1,
    "placeholder": "string",
    "question": "string",
    "range": [
      1
    ],
    "required": false,
    "terms_statement": "string",
    "type": "additional_details"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

put/shop/intake-form-sections/{intakeFormSectionId}/questions/{intakeFormQuestionId}

Update an IntakeFormQuestion

updateIntakeFormQuestion

Updates an existing IntakeFormQuestion in place. type is required and triggers the same conditional validation as on create (e.g. multiple_choice_answers must contain ≥ 2 items when type=multiple_choice).

terms_statement HTML is re-sanitised against the site's allowed-tag list before persisting.

Requires the SETTINGS_MANAGE permission on the section's site.

Path parameters

intakeFormSectionIdobject-idrequired
The ID of the IntakeFormSection.
intakeFormQuestionIdobject-idrequired
The unique identifier of the IntakeFormQuestion.

Request body

questionstringoptional
The question text.
typestringoptional
The type of question. Drives input rendering on the customer intake form and unlocks the type-specific fields below.
Possible values:additional_detailsdate_timeemailmultiple_choicephoneterms_conditionstext_longtextyes_no
multiple_choice_answersobject[]optionalnullable
Available answers when type=multiple_choice. Must contain at least two entries when the type is multiple_choice.
multiple_select_optionstringoptionalnullable
Optional bonus label rendered alongside the multiple-choice answers (e.g. "Other"). Only meaningful when type=multiple_choice.
multiple_selectionbooleanoptionalnullable
Whether the customer can pick more than one multiple_choice_answers entry. Only meaningful when type=multiple_choice.
additional_detailsbooleanoptionalnullable
When true, the customer is prompted for free-text "additional details" alongside the structured answer.
exact_numberstringoptionalnullable
Optional exact-number constraint for numeric questions.
rangeinteger[]optionalnullable
A two-element [min, max] constraint on multiple_choice_answers selections. Both bounds are inclusive; omit either to leave it unbounded.
terms_statementstringoptionalnullable
Terms text rendered alongside type=terms_conditions questions. HTML is sanitised to the site's allowed-tag list.
placeholderstringoptionalnullable
Placeholder text for the input field.
requiredbooleanoptionalnullable
Whether the customer must answer this question.

Responses

200
The question was updated successfully.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/intake-form-sections/abc123/questions/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "question": "Do you have any allergies?",
  "type": "additional_details",
  "multiple_choice_answers": [
    {
      "id": 1,
      "text": "string"
    }
  ],
  "multiple_select_option": "string",
  "multiple_selection": false,
  "additional_details": false,
  "exact_number": "string",
  "range": [
    1
  ],
  "terms_statement": "string",
  "placeholder": "string",
  "required": false
}'

const response = await fetch('https://api.playground.try.be/shop/intake-form-sections/abc123/questions/abc123', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "question": "Do you have any allergies?",
    "type": "additional_details",
    "multiple_choice_answers": [
      {
        "id": 1,
        "text": "string"
      }
    ],
    "multiple_select_option": "string",
    "multiple_selection": false,
    "additional_details": false,
    "exact_number": "string",
    "range": [
      1
    ],
    "terms_statement": "string",
    "placeholder": "string",
    "required": false
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/shop/intake-form-sections/abc123/questions/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "question": "Do you have any allergies?",
        "type": "additional_details",
        "multiple_choice_answers": [
            {
                "id": 1,
                "text": "string"
            }
        ],
        "multiple_select_option": "string",
        "multiple_selection": False,
        "additional_details": False,
        "exact_number": "string",
        "range": [
            1
        ],
        "terms_statement": "string",
        "placeholder": "string",
        "required": False
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/intake-form-sections/abc123/questions/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'question' => 'Do you have any allergies?',
            'type' => 'additional_details',
            'multiple_choice_answers' => [
                [
                    'id' => 1,
                    'text' => 'string'
                ]
            ],
            'multiple_select_option' => 'string',
            'multiple_selection' => false,
            'additional_details' => false,
            'exact_number' => 'string',
            'range' => [
                1
            ],
            'terms_statement' => 'string',
            'placeholder' => 'string',
            'required' => false
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"question": "Do you have any allergies?",
		"type": "additional_details",
		"multiple_choice_answers": []interface{}{
			map[string]interface{}{
				"id": 1,
				"text": "string",
			},
		},
		"multiple_select_option": "string",
		"multiple_selection": false,
		"additional_details": false,
		"exact_number": "string",
		"range": []interface{}{
			1,
		},
		"terms_statement": "string",
		"placeholder": "string",
		"required": false,
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/intake-form-sections/abc123/questions/abc123", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The question was updated successfully.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "additional_details": false,
    "exact_number": "string",
    "multiple_choice_answers": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "text": "string"
      }
    ],
    "multiple_select_option": "string",
    "multiple_selection": false,
    "order": 1,
    "placeholder": "string",
    "question": "string",
    "range": [
      1
    ],
    "required": false,
    "terms_statement": "string",
    "type": "additional_details"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/shop/intake-form-sections/{intakeFormSectionId}/questions/{intakeFormQuestionId}

Delete an IntakeFormQuestion

deleteIntakeFormQuestion

Deletes the question and removes it from the parent section's rendered intake form. Submitted answers from existing visits are preserved on the underlying VisitIntakeForm records (the question is no longer fillable, but historical answers remain addressable by question ID).

Requires the SETTINGS_MANAGE permission on the section's site.

Path parameters

intakeFormSectionIdobject-idrequired
The ID of the IntakeFormSection.
intakeFormQuestionIdobject-idrequired
The unique identifier of the IntakeFormQuestion.

Responses

204
The question was deleted successfully.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/shop/intake-form-sections/abc123/questions/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/intake-form-sections/abc123/questions/abc123', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.delete(
    "https://api.playground.try.be/shop/intake-form-sections/abc123/questions/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://api.playground.try.be/shop/intake-form-sections/abc123/questions/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.playground.try.be/shop/intake-form-sections/abc123/questions/abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The question was deleted successfully.

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

get/shop/order-intake-forms/{orderIntakeFormId}/guests

List guests requiring an intake form for an order

listOrderIntakeFormGuests

Returns the guests on an order who still need to complete an intake form, with their display name and customer ID. Used by customer-facing UIs to prompt the right person to fill out the next outstanding form before their visit.

Path parameters

orderIntakeFormIdobject-idrequired
The unique identifier of the Order whose intake forms are being listed. (The route parameter is named for the resource it surfaces; the underlying lookup keys on order/basket ID.)

Responses

200
The guests requiring intake forms were successfully retrieved.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/order-intake-forms/abc123/guests" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/order-intake-forms/abc123/guests', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/order-intake-forms/abc123/guests",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/order-intake-forms/abc123/guests', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/order-intake-forms/abc123/guests", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The guests requiring intake forms were successfully retrieved.

{
  "data": [
    {
      "id": "634d6e9f413841226003acc4",
      "name": "John Doe",
      "customer_id": "634d6e9f413841226003acc3"
    }
  ]
}

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}

get/shop/visit-intake-forms

List completed visit intake forms

listVisitIntakeForms

Returns a paginated list of completed VisitIntakeForms, filtered by the supplied site, customer, basket or type. Use this to surface a guest's prior intake responses in customer-service flows and on the visit log.

Query parameters

site_iduuidrequired
The site to scope the search to.
customer_iduuidoptional
Limit to intake forms filled out for this customer.
basket_iduuidoptional
Limit to intake forms relating to this basket.
typestringoptional
Limit to intake forms of the given type (e.g. mandatory).
pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page

Responses

200
A paginated list of VisitIntakeForms.
401
The user is unauthenticated

curl "https://api.playground.try.be/shop/visit-intake-forms?site_id=00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/visit-intake-forms?site_id=00000000-0000-0000-0000-000000000000', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/visit-intake-forms?site_id=00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/visit-intake-forms?site_id=00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/visit-intake-forms?site_id=00000000-0000-0000-0000-000000000000", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A paginated list of `VisitIntakeForm`s.

{
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  },
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "data": [
    {
      "id": "634d6e9f413841226003acc2",
      "basket_id": "634d6e9f413841226003acc3",
      "customer_id": "634d6e9f413841226003acc3",
      "order_ref": "TRY123",
      "guest_id": "634d6e9f413841226003acc4",
      "type": "mandatory",
      "completed_at": "2026-11-30T11:52:00+00:00",
      "anonymised_at": "2027-11-30T11:52:00+00:00"
    }
  ]
}

{
  "message": "Unauthenticated"
}

post/shop/visit-intake-forms-for-orders

Get visit intake forms for an order

getVisitIntakeFormsForOrders

Returns the IDs of the VisitIntakeForms associated with an order. Although the operation is read-only the request uses POST so a complex order/basket selector can be supplied without fitting it into a URL query string.

Query parameters

basket_idstringrequired
The basket to look up intake forms for.
site_idstringrequired
The site the basket belongs to.

Responses

200
A paginated list of VisitIntakeForms.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X POST "https://api.playground.try.be/shop/visit-intake-forms-for-orders?basket_id=abc123&site_id=site_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/visit-intake-forms-for-orders?basket_id=abc123&site_id=site_abc123', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/visit-intake-forms-for-orders?basket_id=abc123&site_id=site_abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/visit-intake-forms-for-orders?basket_id=abc123&site_id=site_abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/visit-intake-forms-for-orders?basket_id=abc123&site_id=site_abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A paginated list of `VisitIntakeForm`s.

{
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  },
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "data": [
    {
      "id": "634d6e9f413841226003acc2",
      "basket_id": "634d6e9f413841226003acc3",
      "customer_id": "634d6e9f413841226003acc3",
      "order_ref": "TRY123",
      "guest_id": "634d6e9f413841226003acc4",
      "type": "mandatory",
      "completed_at": "2026-11-30T11:52:00+00:00",
      "anonymised_at": "2027-11-30T11:52:00+00:00"
    }
  ]
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

post/shop/visit-intake-forms-for-orders/pdf

Build a PDF of visit intake forms for an order

getVisitIntakeFormsForOrdersPdf

Queues the construction of a combined PDF containing every completed VisitIntakeForm attached to the order. The response carries a temporary url from which the rendered PDF can be downloaded once the build completes.

Query parameters

basket_idstringrequired
The basket to look up intake forms for.
site_idstringrequired
The site the basket belongs to.

Responses

200
The PDF download URL was successfully generated.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X POST "https://api.playground.try.be/shop/visit-intake-forms-for-orders/pdf?basket_id=abc123&site_id=site_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/visit-intake-forms-for-orders/pdf?basket_id=abc123&site_id=site_abc123', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/visit-intake-forms-for-orders/pdf?basket_id=abc123&site_id=site_abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/visit-intake-forms-for-orders/pdf?basket_id=abc123&site_id=site_abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/visit-intake-forms-for-orders/pdf?basket_id=abc123&site_id=site_abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The PDF download URL was successfully generated.

{
  "url": "https://files.trybe.app/visit-intake/..."
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

get/shop/visit-intake-forms/{visitIntakeFormId}

Get a completed visit intake form

getVisitIntakeForm

Returns the captured-data record of a single completed VisitIntakeForm by ID.

Path parameters

visitIntakeFormIdobject-idrequired
The ID of the VisitIntakeForm.

Responses

200
A single VisitIntakeForm.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/visit-intake-forms/634d6e9f413841226003acc2" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/visit-intake-forms/634d6e9f413841226003acc2', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/visit-intake-forms/634d6e9f413841226003acc2",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/visit-intake-forms/634d6e9f413841226003acc2', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/visit-intake-forms/634d6e9f413841226003acc2", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A single `VisitIntakeForm`.

{
  "data": {
    "id": "634d6e9f413841226003acc2",
    "basket_id": "634d6e9f413841226003acc3",
    "customer_id": "634d6e9f413841226003acc3",
    "order_ref": "TRY123",
    "guest_id": "634d6e9f413841226003acc4",
    "type": "mandatory",
    "completed_at": "2026-11-30T11:52:00+00:00",
    "anonymised_at": "2027-11-30T11:52:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}

get/shop/visit-intake-forms/{visitIntakeFormId}/html

Get the rendered HTML of a visit intake form

getVisitIntakeFormHtml

Returns the rendered HTML representation of a completed VisitIntakeForm — suitable for embedding in admin UIs or converting to PDF. The questions and the guest's answers are laid out in a print-ready format.

Path parameters

visitIntakeFormIdobject-idrequired
The ID of the VisitIntakeForm.

Responses

200
The intake form HTML was successfully retrieved.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/visit-intake-forms/634d6e9f413841226003acc2/html" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/visit-intake-forms/634d6e9f413841226003acc2/html', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/visit-intake-forms/634d6e9f413841226003acc2/html",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/visit-intake-forms/634d6e9f413841226003acc2/html', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/visit-intake-forms/634d6e9f413841226003acc2/html", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The intake form HTML was successfully retrieved.

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}