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

# List appointments

> Requires `read:appointments`. Calendar bookings only — for facility drop-off/intake with photos use `POST /cars/{id}/events` instead.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/appointments
openapi: 3.0.0
info:
  title: Car Storage Software API
  version: 1.1.0
  description: >-
    Team-scoped REST API for Car Storage Software. Authenticate with a team API
    key (`Authorization: Bearer <key>` or `x-api-key: <key>`) created under
    Settings → Integrations → API. Keys carry granular `read:*` / `write:*`
    scopes; read never implies write.
servers:
  - url: https://www.carstoragesoftware.com
security: []
paths:
  /api/v1/appointments:
    get:
      tags:
        - Appointments
      summary: List appointments
      description: >-
        Requires `read:appointments`. Calendar bookings only — for facility
        drop-off/intake with photos use `POST /cars/{id}/events` instead.
      parameters:
        - schema:
            type: integer
            minimum: 1
            default: 1
          required: false
          name: page
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
          required: false
          name: limit
          in: query
        - schema:
            type: string
            format: date-time
          required: false
          name: updatedAfter
          in: query
        - schema:
            type: string
          required: false
          name: ids
          in: query
        - schema:
            type: string
            enum:
              - scheduled
              - pending_approval
              - accepted
              - declined
              - checked_in
              - in_progress
              - completed
              - cancelled
              - no_show
          required: false
          name: status
          in: query
        - schema:
            type: string
            format: uuid
          required: false
          name: customerId
          in: query
        - schema:
            type: string
            format: uuid
          required: false
          name: carId
          in: query
      responses:
        '200':
          description: appointments returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1AppointmentsResponse'
        '401':
          description: Missing, invalid, revoked, or expired API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: API key missing required scope, or API disabled for team.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: Request validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    V1AppointmentsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/V1Appointment'
        page:
          type: integer
          minimum: 1
        limit:
          type: integer
          minimum: 1
          maximum: 200
        total:
          type: integer
          minimum: 0
      required:
        - data
        - page
        - limit
        - total
    ApiError:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
        details:
          nullable: true
      required:
        - error
    V1Appointment:
      type: object
      properties:
        id:
          type: string
          format: uuid
        teamId:
          type: string
        locationId:
          type: string
          nullable: true
          format: uuid
        appointmentTypeId:
          type: string
          nullable: true
          format: uuid
        optionId:
          type: string
          nullable: true
          format: uuid
        status:
          type: string
          enum:
            - scheduled
            - pending_approval
            - accepted
            - declined
            - checked_in
            - in_progress
            - completed
            - cancelled
            - no_show
        carId:
          type: string
          nullable: true
          format: uuid
        secondaryCarId:
          type: string
          nullable: true
          format: uuid
        customerId:
          type: string
          nullable: true
          format: uuid
        startAt:
          type: string
          nullable: true
          format: date-time
        endAt:
          type: string
          nullable: true
          format: date-time
        title:
          type: string
          nullable: true
        notes:
          type: string
          nullable: true
        recurrenceFrequency:
          type: string
          nullable: true
          enum:
            - daily
            - weekly
            - biweekly
            - monthly
            - quarterly
            - yearly
            - null
        recurrenceInterval:
          type: integer
          nullable: true
        recurrenceDaysOfWeek:
          type: array
          nullable: true
          items:
            type: integer
        recurrenceDayOfMonth:
          type: integer
          nullable: true
        recurrenceEndDate:
          type: string
          nullable: true
          format: date-time
        recurrenceCount:
          type: integer
          nullable: true
        recurrenceSeriesId:
          type: string
          nullable: true
          format: uuid
        createdAt:
          type: string
          nullable: true
          format: date-time
        updatedAt:
          type: string
          nullable: true
          format: date-time
      required:
        - id
        - teamId
        - locationId
        - appointmentTypeId
        - optionId
        - status
        - carId
        - secondaryCarId
        - customerId
        - startAt
        - endAt
        - title
        - notes
        - recurrenceFrequency
        - recurrenceInterval
        - recurrenceDaysOfWeek
        - recurrenceDayOfMonth
        - recurrenceEndDate
        - recurrenceCount
        - recurrenceSeriesId
        - createdAt
        - updatedAt
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Team API key from Settings → Integrations. Use `Authorization: Bearer
        <key>` or `x-api-key`.

````

## Related topics

- [Create an appointment](/docs/schedule/create-an-appointment.md)
- [List cars](/docs/api-reference/cars/list-cars.md)
- [List event types](/docs/api-reference/event-types/list-event-types.md)
- [Respond to reschedule requests in Inbox](/docs/inbox/respond-to-reschedule-requests-in-inbox.md)
- [Work with customer type lists](/docs/contacts/work-with-customer-type-lists.md)


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