Cliniko Practitioners API

openapi: 3.2.0
info:
  title: Cliniko Practitioners API
  description: Cliniko is practice management software for allied health practices and clinics.
  version: v1
  contact:
    name: Cliniko API Support
    url: https://docs.api.cliniko.com/
  license:
    name: Proprietary
    url: https://www.cliniko.com/terms/
servers:
- url: https://api.{shard}.cliniko.com/v1
  description: Cliniko region-sharded API. The shard is the suffix on your API key.
  variables:
    shard:
      default: au1
      enum:
      - au1
      - au2
      - au3
      - au4
      - uk1
      - eu1
      - us1
      - ca1
      description: Region shard derived from the API key suffix. Keys without a suffix use au1.
security:
- basicAuth: []
tags:
- name: Practitioners
  description: Practitioners and the businesses (locations) they work from.
paths:
  /practitioners:
    parameters:
    - $ref: '#/components/parameters/UserAgent'
    get:
      operationId: listPractitioners
      tags:
      - Practitioners
      summary: Get practitioners
      description: Returns a paginated list of all active practitioners.
      parameters:
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PerPage'
      responses:
        '200':
          description: A paginated list of practitioners.
          content:
            application/json:
              schema:
                type: object
                properties:
                  practitioners:
                    type: array
                    items:
                      $ref: '#/components/schemas/Practitioner'
                  total_entries:
                    type: integer
                  links:
                    $ref: '#/components/schemas/Links'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /practitioners/{id}:
    parameters:
    - $ref: '#/components/parameters/UserAgent'
    - $ref: '#/components/parameters/Id'
    get:
      operationId: getPractitioner
      tags:
      - Practitioners
      summary: Get practitioner
      description: Returns a single practitioner by ID.
      responses:
        '200':
          description: The requested practitioner.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Practitioner'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    Id:
      name: id
      in: path
      required: true
      description: The unique identifier of the resource.
      schema:
        type: string
    PerPage:
      name: per_page
      in: query
      required: false
      description: Items per page. Default 50, maximum 100.
      schema:
        type: integer
        default: 50
        maximum: 100
    Page:
      name: page
      in: query
      required: false
      description: Page number (pagination).
      schema:
        type: integer
        default: 1
    UserAgent:
      name: User-Agent
      in: header
      required: true
      description: Must be of the form `APP_VENDOR_NAME (APP_VENDOR_EMAIL)` and include a valid contact email. Requests without a compliant User-Agent may be automatically blocked.
      schema:
        type: string
        example: MyClinicApp (dev@myclinic.example)
  schemas:
    Error:
      type: object
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties: true
    Links:
      type: object
      description: HAL-style pagination and self links.
      properties:
        self:
          type: string
          format: uri
        next:
          type: string
          format: uri
        previous:
          type: string
          format: uri
    Practitioner:
      type: object
      properties:
        id:
          type: string
        title:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        label:
          type: string
        designation:
          type: string
        description:
          type:
          - string
          - 'null'
        show_in_online_bookings:
          type: boolean
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        default_appointment_type:
          $ref: '#/components/schemas/Reference'
        user:
          $ref: '#/components/schemas/Reference'
        appointments:
          $ref: '#/components/schemas/Reference'
        invoices:
          $ref: '#/components/schemas/Reference'
        links:
          $ref: '#/components/schemas/Links'
    Reference:
      type: object
      description: A link to a related resource.
      properties:
        links:
          type: object
          properties:
            self:
              type: string
              format: uri
  responses:
    Unauthorized:
      description: Missing or invalid credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: 'HTTP Basic authentication. The API key is the username and the password is left empty (curl: `-u API_KEY:`). The shard suffix on the key selects the base host.'