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

# List availabilities

> Get current user availability



## OpenAPI

````yaml /openapi.json get /availability/
openapi: 3.1.0
info:
  title: Cal ID API
  description: >-
    API documentation for external developers integrating with Cal ID. This
    documentation is auto-generated from our OpenAPI specification and includes
    details on all available endpoints, request/response schemas, and
    authentication methods.


    Authentication is required for all endpoints and can be done using API key
    generated from the Cal ID dashboard under the `settings/developer/api-keys`
    page. Use the Authorization header with the Bearer scheme to authenticate
    your requests.


    Example:

    - API Key: `Authorization: Bearer calid_xxxxx`


    Note: To manage Team's resources use the Team's owner/admin API key
  version: 1.0.0
  contact:
    name: API Support
    email: support@cal.id
    url: https://cal.id
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.cal.id
    description: 'Production server '
security:
  - bearerAuth: []
tags:
  - name: Health
    description: Health check endpoints
  - name: Users
    description: User management endpoints
  - name: Event Types
    description: Event type management endpoints
  - name: Teams
    description: Team management endpoints
  - name: Team Event Types
    description: Event type management endpoints for teams
  - name: Team Memberships
    description: Membership management endpoints for teams
  - name: Team Schedules
    description: Schedule management endpoints for teams
  - name: Availability
    description: User availability management endpoints
  - name: Schedule
    description: User schedule management endpoints
  - name: Slots
    description: Available slots retrieval endpoints
  - name: Booking
    description: Event booking endpoints
paths:
  /availability/:
    get:
      tags:
        - Availability
      summary: List availabilities
      description: Get current user availability
      operationId: list_availabilities
      parameters:
        - schema:
            type: string
            minLength: 1
            example: '2026-05-01T00:00:00.000Z'
          in: query
          name: dateFrom
          required: true
          description: Availability window start timestamp (ISO-8601).
        - schema:
            type: string
            minLength: 1
            example: '2026-05-07T23:59:59.000Z'
          in: query
          name: dateTo
          required: true
          description: Availability window end timestamp (ISO-8601).
        - schema:
            type: integer
            exclusiveMinimum: 0
            example: 123
            minimum: 1
          in: query
          name: eventTypeId
          required: false
          description: Optional event type identifier to scope returned availability.
      responses:
        '200':
          description: Current user availability
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    properties:
                      busy:
                        type: array
                        items:
                          type: object
                          properties:
                            start:
                              type: string
                            end:
                              type: string
                            title:
                              type: string
                            source:
                              type:
                                - 'null'
                                - string
                          required:
                            - start
                            - end
                          additionalProperties: false
                      timeZone:
                        type: string
                      dateRanges:
                        type: array
                        items:
                          type: object
                          properties:
                            start:
                              type: string
                            end:
                              type: string
                          required:
                            - start
                            - end
                          additionalProperties: false
                      oooExcludedDateRanges:
                        type: array
                        items:
                          type: object
                          description: Schema reference was unavailable in the source spec.
                      workingHours:
                        type: array
                        items:
                          type: object
                          properties:
                            days:
                              type: array
                              items:
                                type: number
                            startTime:
                              type: number
                            endTime:
                              type: number
                            userId:
                              type: number
                          required:
                            - days
                            - startTime
                            - endTime
                            - userId
                          additionalProperties: false
                      dateOverrides:
                        type: array
                      currentSeats:
                        anyOf:
                          - type: array
                          - type: 'null'
                      datesOutOfOffice:
                        type: object
                        additionalProperties: {}
                    required:
                      - busy
                      - timeZone
                      - dateRanges
                      - oooExcludedDateRanges
                      - workingHours
                      - dateOverrides
                      - currentSeats
                    additionalProperties: false
                  message:
                    type: string
                  meta:
                    type: object
                    properties:
                      pagination:
                        type: object
                        properties:
                          page:
                            type: number
                          limit:
                            type: number
                          total:
                            type: number
                          totalPages:
                            type: number
                        required:
                          - page
                          - limit
                          - total
                          - totalPages
                        additionalProperties: false
                    additionalProperties: {}
                required:
                  - success
                additionalProperties: false
                description: Current user availability
        '400':
          description: Invalid availability query parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  message:
                    type: string
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details: {}
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - success
                  - message
                  - error
                additionalProperties: false
                description: Invalid availability query parameters
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  message:
                    type: string
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details: {}
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - success
                  - message
                  - error
                additionalProperties: false
                description: Unauthorized
        '500':
          description: Failed to retrieve availability
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  message:
                    type: string
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details: {}
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - success
                  - message
                  - error
                additionalProperties: false
                description: Failed to retrieve availability
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT | API Key
      description: |-

        Use the Authorization header with Bearer scheme.

        Examples:
        - API Key: Authorization: Bearer calid_xxxxx
            

````

## Related topics

- [How to Set Your Internal Time Format](/docs/settings/time-format.md)
- [List schedules](/docs/api-reference/schedule/list-schedules.md)
- [Manage availability schedules](/docs/developers/guides/manage-schedules.md)
- [Managing Your Contacts in Cal ID](/docs/getting-started/contacts.md)
- [List team schedules](/docs/api-reference/team-schedules/list-team-schedules.md)
