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

# Get Bookable Usage

> Return all EventBookable segments for the given bookable IDs within [start, end].

Includes bookable usage from both appointments and bookable blocks (blocks that
reserve a bookable so the calendar preview can show when a bookable is blocked).
Excludes archived events and segments.



## OpenAPI

````yaml get /check-in/calendar/bookable/usage
openapi: 3.1.0
info:
  title: Decoda API
  description: External API documentation for the Decoda Health platform.
  version: '1.0'
servers: []
security: []
paths:
  /check-in/calendar/bookable/usage:
    get:
      tags:
        - Calendar and Appointments
      summary: Get Bookable Usage
      description: >-
        Return all EventBookable segments for the given bookable IDs within
        [start, end].


        Includes bookable usage from both appointments and bookable blocks
        (blocks that

        reserve a bookable so the calendar preview can show when a bookable is
        blocked).

        Excludes archived events and segments.
      operationId: get_bookable_usage_check_in_calendar_bookable_usage_get
      parameters:
        - name: TENANT
          in: header
          required: true
          schema:
            type: string
            title: Tenant
          description: The tenant you are making this request on behalf of
        - name: API-KEY
          in: header
          required: true
          schema:
            type: string
            title: Api-Key
          description: Your api key
        - name: bookable_ids
          in: query
          required: true
          schema:
            type: array
            items:
              type: string
            title: Bookable Ids
        - name: start
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date-time
              - type: 'null'
            title: Start
        - name: end
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date-time
              - type: 'null'
            title: End
        - name: location_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Location Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EventBookableSegmentTiny'
                title: >-
                  Response Get Bookable Usage Check In Calendar Bookable Usage
                  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    EventBookableSegmentTiny:
      properties:
        id:
          type: string
          title: Id
        type:
          type: string
          const: BOOKABLE
          title: Type
          default: BOOKABLE
        eventId:
          type: string
          title: Eventid
        start:
          type: string
          format: date-time
          title: Start
        end:
          type: string
          format: date-time
          title: End
        externalId:
          anyOf:
            - type: string
            - type: 'null'
          title: Externalid
        isArchived:
          type: boolean
          title: Isarchived
          default: false
        createdDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Createddate
        updatedDate:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updateddate
        bookableId:
          type: string
          title: Bookableid
        bookableGroupId:
          anyOf:
            - type: string
            - type: 'null'
          title: Bookablegroupid
        bookable:
          anyOf:
            - $ref: '#/components/schemas/BookableTiny'
            - type: 'null'
        eventType:
          anyOf:
            - $ref: '#/components/schemas/EventType'
            - type: 'null'
      type: object
      required:
        - id
        - eventId
        - start
        - end
        - bookableId
      title: EventBookableSegmentTiny
      description: >-
        Bookable segment response.


        ``bookable_group_id`` is set when this segment was picked from a

        :class:`BookableGroup` (OR-semantic alternatives). The frontend
        round-trips

        the group id so reschedules / edits can re-pick from the same group
        instead

        of pinning the originally-chosen member.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    BookableTiny:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
      type: object
      required:
        - id
        - name
      title: BookableTiny
      description: Lightweight bookable for list views.
    EventType:
      type: string
      enum:
        - APPOINTMENT
        - SHIFT
        - BLOCK
        - GOOGLE_CALENDAR
      title: EventType
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````