> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getoliver.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Booking Session

> Get a booking session by ID



## OpenAPI

````yaml GET /services/core/open_api/v1/booking_sessions/{id}
openapi: 3.1.0
info:
  title: Oliver Partner API
  description: API for partners to interact with Oliver
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://partner-api.getoliver.com
security:
  - bearerAuth: []
paths:
  /services/core/open_api/v1/booking_sessions/{id}:
    get:
      description: Get a booking session by ID
      parameters:
        - name: X-Client-Id
          in: header
          description: The location id of the practice
          required: true
          schema:
            type: string
        - name: id
          in: path
          description: The ID of the booking session to get
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Booking session found
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                  data:
                    $ref: '#/components/schemas/BookingSession'
                  message:
                    type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralError'
components:
  schemas:
    BookingSession:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of the booking session
        status:
          type: string
          enum:
            - active
            - completed
            - abandoned
          description: >-
            The status of the session. 'active' = in progress, 'completed' =
            resulted in an appointment, 'abandoned' = expired without booking.
        stage:
          type: string
          enum:
            - started
            - client_identification
            - appointment_type_selection
            - scheduling
            - checkout
            - completed
          description: The furthest stage the user reached in the booking flow
        client_type:
          type:
            - string
            - 'null'
          enum:
            - new
            - returning
            - null
          description: Whether the client was new or returning. Null if not yet determined.
        appointment_id:
          type:
            - string
            - 'null'
          description: The ID of the appointment created by this session, if completed
        remote_appointment_id:
          type:
            - string
            - 'null'
          description: >-
            The ID of the remote appointment created by this session, if
            completed
        referral_source:
          type:
            - string
            - 'null'
          description: The referral source (utm_source) associated with this session
        referral_campaign:
          type:
            - string
            - 'null'
          description: The referral campaign (utm_campaign) associated with this session
        referral_medium:
          type:
            - string
            - 'null'
          description: The referral medium (utm_medium) associated with this session
        created_at:
          type: string
          format: date-time
          description: The date/time the session was created in ISO 8601 format
        updated_at:
          type: string
          format: date-time
          description: The date/time the session was last updated in ISO 8601 format
        last_activity_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            The date/time of the last user activity in the session in ISO 8601
            format
    GeneralError:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````