# List Practitioners

Retrieves a list of practitioners configured for online booking on Hero Health.

Endpoint: GET /v1/practitioners
Version: 1.0.0
Security: apiKeyAuth, practiceGroupId

## Security:

  - `apiKeyAuth` (unknown)
    apiKey in header x-api-key

  - `practiceGroupId` (unknown)
    apiKey in header x-practice-group-id

## Query parameters:

  - `location_ids` (array)

  - `appointment_type_ids` (array)

  - `has_availability` (boolean)

  - `search` (string)
    Case-insensitive partial match on the practitioner's first name, last name, the two together, or their `ehr_partner_name`, so a practitioner can be found either by the name patients see or by the session holder name they carry in the EHR.

  - `include[]` (array)
    Opts additional sets of practitioners into the response. Repeatable and combinable. By default only active practitioners are returned; `include[]=archived` adds archived practitioners, identifiable by a non-null `archived_at`.

  - `order_by` (string)
    Field to sort by. `name` sorts by last name then first name, ignoring case; `slot_count` sorts by the number of available slots. Defaults to `name`.

  - `order_descending` (string)
    Sort direction. To list the practitioners with the most availability first, use `order_by=slot_count&order_descending=true`.

## Response 200:

  - `200` (unknown)
    Ok

## Response 200 fields (application/json):

  - `data` (array, required)

  - `data.id` (string, required)

  - `data.name` (string, required)

  - `data.title` (string)

  - `data.first_name` (string, required)

  - `data.last_name` (string, required)

  - `data.ehr_partner_name` (string, required)

  - `data.slot_count` (number, required)

  - `data.next_available_at` (string, required)

  - `data.email` (string, required)

  - `data.contact_number` (string, required)

  - `data.type` (string, required)

  - `data.notifications` (object, required)

  - `data.notifications.appointment_confirmed` (object, required)

  - `data.notifications.appointment_confirmed.email` (boolean, required)

  - `data.notifications.appointment_confirmed.sms` (boolean, required)

  - `data.notifications.appointment_cancelled` (object, required)

  - `data.notifications.appointment_cancelled.email` (boolean, required)

  - `data.notifications.appointment_cancelled.sms` (boolean, required)

  - `data.notifications.appointment_rescheduled` (object, required)

  - `data.notifications.appointment_rescheduled.email` (boolean, required)

  - `data.notifications.appointment_rescheduled.sms` (boolean, required)

  - `data.notifications.video_appointment` (object, required)

  - `data.notifications.video_appointment.email` (boolean, required)

  - `data.archived_at` (string, required)

  - `count` (number, required)

## Response 400:

  - `400` (unknown)
    Validation error

## Response 400 fields (application/json):

  - `error` (boolean, required)
    Example: true

  - `statusCode` (number, required)
    Example: 400

  - `message` (array, required)

  - `message.code` (string, required)
    Example: invalid_type

  - `message.expected` (string, required)
    Example: string

  - `message.path` (array, required)
    Example: ["patient_id"]

  - `message.message` (string, required)
    Example: Required

## Response 401:

  - `401` (unknown)
    Unauthorised

## Response 404:

  - `404` (unknown)
    Not found

## Response 429:

  - `429` (unknown)
    Too Many Requests

## Response 500:

  - `500` (unknown)
    Unknown error