IntakeForms

List intake form sections

Use this endpoint to return a paginated list of IntakeFormSections.

get/shop/intake-form-sections

Query parameters

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

site_idstring

Filter results by the site they belong to

type'mandatory'

Filter sections by type. Omitting this parameter returns sections where type is null.

Response

A paginated list of IntakeFormSections.

Example response

{
  "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": [
    {
      "description": "Pre-treatment health questions and consent",
      "intro_text": "Please answer honestly — these questions help us tailor your\ntreatment safely.\n",
      "offerings": [
        {
          "offering_name": "Twilight massage",
          "offering_type": "appointment"
        }
      ],
      "outro_text": "Thank you. Please proceed to checkout when you're ready.\n",
      "title": "Health Declaration",
      "updated_at": "2025-02-04T12:00:00+01:00"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.