Sign in
Practitioners

Get all practitioners

Use this endpoint to retrieve all practitioners (paginated)

get/shop/practitioners

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

querystring

Filter practitioners by their name

zone_idsstring[]

Filter practitioners by a comma separated list of zone ids they are linked to

Response

A list of practitioners (paginated)

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": [
    {
      "id": "5dcb47800000000000000000",
      "appointment_restrictions": [
        {
          "id": "5dcb47800000000000000011",
          "appointment_type_ids": [
            "5dcb47800000000000000010"
          ],
          "category_ids": [
            "5dcb47800000000000000010"
          ],
          "date_from": "2020-06-20",
          "date_to": "2020-06-20",
          "max_duration": 180,
          "occupied_mins": 60
        }
      ],
      "avatar": {
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "original_url": "https://example.com/media/super-cool-photo.jpg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
      },
      "signature": {
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "original_url": "https://example.com/media/super-cool-photo.jpg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
      },
      "gender": "female",
      "name": "Jane Doe",
      "registration_number": "A123",
      "organisation_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
      "zones": [
        {
          "id": "5f1234567890abcdef123456",
          "name": "Pool Deck",
          "organisation_id": "22222222-2222-2222-2222-222222222222",
          "site_id": "11111111-1111-1111-1111-111111111111"
        }
      ],
      "external_id": "EXT-001",
      "user_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
      "created_at": "2025-02-04T12:00:00+01:00",
      "updated_at": "2025-02-04T12:00:00+01:00"
    }
  ]
}

Changes