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

# List call bookings

> Returns booking details for a business, including scheduled, completed, and cancelled calls. Cancelled bookings are excluded by default. Use this endpoint when you need meeting links, attendance, or bookkeeper contact details. Authenticate with a platform access token or a business-scoped token authorized for this business.



## OpenAPI

````yaml get /v1/businesses/{businessId}/call-bookings
openapi: 3.0.1
info:
  title: API
  version: latest
servers: []
security:
  - BearerAuth: []
tags: []
externalDocs:
  url: /
paths:
  /v1/businesses/{businessId}/call-bookings:
    get:
      summary: List call bookings
      description: >-
        Returns booking details for a business, including scheduled, completed,
        and cancelled calls. Cancelled bookings are excluded by default. Use
        this endpoint when you need meeting links, attendance, or bookkeeper
        contact details. Authenticate with a platform access token or a
        business-scoped token authorized for this business.
      operationId: call-bookings.list
      parameters:
        - $ref: '#/components/parameters/CallListBusinessId'
        - name: status
          in: query
          description: >-
            Filter by scheduled, completed, or cancelled booking state
            (case-insensitive). When supplied, this filter takes precedence over
            include_deleted, so status=cancelled returns cancelled bookings even
            when include_deleted is false.
          schema:
            type: string
            example: cancelled
        - name: include_deleted
          in: query
          description: Include cancelled bookings when no status filter is supplied.
          schema:
            type: boolean
            default: false
        - name: sort_by
          in: query
          description: >-
            Sort by a timestamp or derived booking state. Ascending state order
            is scheduled, completed, then cancelled.
          schema:
            type: string
            enum:
              - event_start_at
              - created_at
              - updated_at
              - status
              - state
            default: event_start_at
        - name: sort_order
          in: query
          schema:
            type: string
            enum:
              - ASC
              - DESC
            default: ASC
        - $ref: '#/components/parameters/CallListCursor'
        - $ref: '#/components/parameters/CallListLimit'
        - $ref: '#/components/parameters/CallListShowTotalCount'
      responses:
        '200':
          description: A page of call bookings.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - meta
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ApiCallBooking'
                  meta:
                    $ref: '#/components/schemas/RequestMetadata'
components:
  parameters:
    CallListBusinessId:
      name: businessId
      in: path
      required: true
      description: The UUID of the business.
      schema:
        type: string
        format: uuid
    CallListCursor:
      name: cursor
      in: query
      description: >-
        Opaque cursor from meta.pagination.cursor. Omit for the first page. Keep
        filters and sort settings unchanged between pages.
      schema:
        type: string
    CallListLimit:
      name: limit
      in: query
      description: Maximum number of results per page.
      schema:
        type: integer
        minimum: 1
        maximum: 1000
        default: 100
    CallListShowTotalCount:
      name: show_total_count
      in: query
      description: >-
        Include the total number of matching results in
        meta.pagination.total_count.
      schema:
        type: boolean
        default: false
  schemas:
    ApiCallBooking:
      type: object
      description: >-
        A bookkeeping call booking. COMPLETED means the start time has passed;
        it does not confirm attendance.
      required:
        - id
        - business_id
        - external_id
        - purpose
        - state
        - call_type
        - event_start_at
        - call_link
        - cancellation_reason
        - did_attend
        - invitee_email
        - bookkeeper_name
        - bookkeeper_email
        - created_at
        - updated_at
        - deleted_at
      properties:
        type:
          type: string
          enum:
            - call_booking
        id:
          type: string
          format: uuid
        business_id:
          type: string
          format: uuid
          nullable: true
        external_id:
          type: string
          description: The external Calendly event identifier.
        purpose:
          type: string
          enum:
            - BOOKKEEPING_ONBOARDING
            - ADHOC
        state:
          type: string
          enum:
            - SCHEDULED
            - CANCELLED
            - COMPLETED
        call_type:
          type: string
          enum:
            - ZOOM
            - GOOGLE_MEET
        event_start_at:
          type: string
          format: date-time
        call_link:
          type: string
          description: The meeting link.
        cancellation_reason:
          type: string
          nullable: true
        did_attend:
          type: boolean
          nullable: true
        invitee_email:
          type: string
          nullable: true
        bookkeeper_name:
          type: string
        bookkeeper_email:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        deleted_at:
          type: string
          format: date-time
          nullable: true
          description: The cancellation timestamp, or null if the booking is not cancelled.
    RequestMetadata:
      type: object
      description: Request metadata. Present on paginated list responses.
      properties:
        type:
          type: string
          description: Metadata type discriminator. Value will be `request_metadata`.
          example: request_metadata
        pagination:
          $ref: '#/components/schemas/PaginationMetadata'
    PaginationMetadata:
      type: object
      description: >-
        Cursor-based pagination metadata returned alongside paginated list
        responses.
      properties:
        sort_by:
          type: string
          nullable: true
          description: Field the result set is sorted by.
        sort_order:
          type: string
          enum:
            - ASC
            - DESC
          description: Sort direction applied to the result set.
          example: ASC
        cursor:
          type: string
          nullable: true
          description: >-
            Opaque cursor for the next page. Pass it using the query parameter
            documented for the endpoint. Null when there are no further pages.
        has_more:
          type: boolean
          description: Whether additional pages are available after the current one.
        total_count:
          type: integer
          format: int64
          nullable: true
          description: Total number of records across all pages, when available.
      required:
        - sort_by
        - sort_order
        - cursor
        - has_more
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.