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

# List bookable appointment types

> Lists the appointment types your organization has adopted — the set you can book against — as `{ id, name }`. Your organization is read from the access token, so there is no org parameter. An organization that has adopted nothing gets an empty list.

The adopted set is bounded, so the whole list normally comes back in one page — no `after` cursor. It still takes `cursor` and `limit`, so you do not have to know which lists page.

Start here to obtain the `appointment_type_id` that every slot search requires.



## OpenAPI

````yaml /openapi.json get /appointment-types
openapi: 3.1.0
info:
  title: OpenLoop API
  version: 0.1.0
  description: >-
    Unified reference for the OpenLoop Patient (clinical) and Payments & Revenue
    APIs.
servers:
  - url: https://api.openloophealth.com/v0.1
    description: Production partner edge
  - url: https://api-staging.openloophealth.com/v0.1
    description: Staging partner edge (sandbox credentials)
security: []
paths:
  /appointment-types:
    get:
      tags:
        - Scheduling
      summary: List bookable appointment types
      description: >-
        Lists the appointment types your organization has adopted — the set you
        can book against — as `{ id, name }`. Your organization is read from the
        access token, so there is no org parameter. An organization that has
        adopted nothing gets an empty list.


        The adopted set is bounded, so the whole list normally comes back in one
        page — no `after` cursor. It still takes `cursor` and `limit`, so you do
        not have to know which lists page.


        Start here to obtain the `appointment_type_id` that every slot search
        requires.
      parameters:
        - name: cursor
          in: query
          required: false
          schema:
            type: string
            maxLength: 8192
            pattern: ^[A-Za-z0-9_-]+$
          description: >-
            Opaque `after` or `before` value from a previous response, passed
            back verbatim. It carries its own direction, so there is no separate
            paging parameter.
        - name: limit
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                minimum: 1
              - type: string
                pattern: ^\d+$
            default: 25
          description: >-
            Maximum appointment types per page. Defaults to 25. There is no
            declared maximum, so a larger value is accepted rather than
            rejected, but the page size is capped at 100 — ask for more and you
            get 100. Values below 1 return `400`.
      responses:
        '200':
          description: The appointment types your organization can book.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/SchedulingAppointmentType'
                  after:
                    type: string
                    description: >-
                      Cursor for the next page. Absent only when there are no
                      further pages.
                  before:
                    type: string
                    description: >-
                      Cursor for the previous page. Absent on the first page of
                      a walk.
                  request_id:
                    type: string
                required:
                  - items
                  - request_id
        '400':
          description: >-
            Query validation failed — a non-positive `limit`, a `cursor` longer
            than the accepted length, or a `cursor` that cannot be decoded
            (`appointment_type_list.cursor_invalid`).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/SchedulingProblem'
        '401':
          description: Missing or invalid bearer token.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/SchedulingProblem'
        '403':
          description: >-
            The access token carries no usable organization, or the organization
            is not one you may act for.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/SchedulingProblem'
      security:
        - serviceToken: []
        - userToken: []
components:
  schemas:
    SchedulingAppointmentType:
      type: object
      description: >-
        An appointment type your organization has adopted, as returned by the
        bookable-catalog list.
      properties:
        id:
          type: string
          format: uuid
          description: Pass as `appointment_type_id` when searching slots.
        name:
          type: string
          minLength: 1
      required:
        - id
        - name
    SchedulingProblem:
      type: object
      description: >-
        RFC 7807 problem detail. Scheduling endpoints return errors as
        `application/problem+json`, not the platform `{ error, request_id }`
        envelope. `code` is the stable machine-readable identifier — branch on
        it, not on `detail`.
      properties:
        type:
          type: string
          description: Problem type URI. `about:blank` for the codes below.
        title:
          type: string
          description: Short human-readable summary, e.g. `Bad Request`.
        status:
          type: integer
          description: The HTTP status code, repeated in the body.
        detail:
          type: string
          description: Human-readable explanation of this occurrence.
        instance:
          type: string
        code:
          type: string
          description: >-
            Stable error identifier, e.g. `slot_search.window_too_large`,
            `appointment_list.offset_required`, `slot_token.tampered`.
          examples:
            - slot_search.window_too_large
        errors:
          type: array
          description: >-
            Field-level validation failures, when the error is a body/query
            validation failure.
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
              code:
                type: string
            required:
              - field
              - message
              - code
      required:
        - type
        - title
        - status
        - code
  securitySchemes:
    serviceToken:
      type: oauth2
      description: >-
        Service (M2M) access token issued by POST /auth/token using the
        client_credentials grant. Required scopes, where known, are listed on
        each operation below.
      flows:
        clientCredentials:
          tokenUrl: https://api.openloophealth.com/v0.1/auth/token
          scopes: {}
    userToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        User access token issued by POST /auth/token via the verification-code
        grant (after Verify a one-time code) or the refresh_token grant.

````

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