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

# List Availabilities

> List the recurring weekly availability rules of the org's tutors.

`tutor_availability_rules` has no org column, so rules are scoped to this
org's accepted members. `day_of_week` is 0–6 (Sunday=0).



## OpenAPI

````yaml /openapi.json get /v1/availabilities
openapi: 3.1.0
info:
  title: ClassQuill Public API
  description: >-
    REST API for ClassQuill tutoring organisations. Pipe your sessions,
    invoices, payments, tutor earnings, students, and more into your own tools.
    Most endpoints are reads; a focused set of writes (each gated by a *:write
    scope) create or update data, including creating student/tutor/parent
    accounts.


    Authenticate every request with an org API key:

        Authorization: Token token=ei_live_...

    Mint keys in the ClassQuill app under Settings → Developers.
  version: 1.0.0
servers: []
security:
  - ApiKeyAuth: []
tags:
  - name: General
  - name: Sessions
  - name: Tutors
  - name: Students & Parents
  - name: Billing
  - name: Curriculum
  - name: Coursework
  - name: Operations
  - name: Pricing
  - name: Bookings
  - name: Blog
  - name: Reports
paths:
  /v1/availabilities:
    get:
      tags:
        - Tutors
      summary: List Availabilities
      description: >-
        List the recurring weekly availability rules of the org's tutors.


        `tutor_availability_rules` has no org column, so rules are scoped to
        this

        org's accepted members. `day_of_week` is 0–6 (Sunday=0).
      operationId: list_availabilities_v1_availabilities_get
      parameters:
        - name: tutor_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by tutor UUID
            title: Tutor Id
          description: Filter by tutor UUID
        - name: day_of_week
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                maximum: 6
                minimum: 0
              - type: 'null'
            description: Filter by day of week (0=Sunday … 6=Saturday)
            title: Day Of Week
          description: Filter by day of week (0=Sunday … 6=Saturday)
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Opaque cursor from a previous response's meta.next_cursor, or the
              literal 'start' to begin cursor paging from the newest record.
              When set, offset is ignored and results page by a stable
              (created_at, id) keyset — recommended for large or incremental
              syncs.
            title: Cursor
          description: >-
            Opaque cursor from a previous response's meta.next_cursor, or the
            literal 'start' to begin cursor paging from the newest record. When
            set, offset is ignored and results page by a stable (created_at, id)
            keyset — recommended for large or incremental syncs.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Records per page (default 20, max 100)
            default: 20
            title: Limit
          description: Records per page (default 20, max 100)
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            description: Pagination offset (ignored when cursor is set)
            default: 0
            title: Offset
          description: Pagination offset (ignored when cursor is set)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_Availability_'
        '401':
          description: Missing, malformed, revoked, or expired credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: The credential lacks the scope this endpoint requires.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: Validation error — `error.details.errors` lists the fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: >-
            Rate limit exceeded — honour Retry-After and the RateLimit-*
            headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    Page_Availability_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/Availability'
          type: array
          title: Data
        meta:
          $ref: '#/components/schemas/PageMeta'
      type: object
      required:
        - data
        - meta
      title: Page[Availability]
    ApiError:
      description: Canonical error envelope for every /v1 error response (4xx/5xx).
      properties:
        error:
          $ref: '#/components/schemas/ApiErrorBody'
      required:
        - error
      title: ApiError
      type: object
    Availability:
      properties:
        id:
          type: string
          title: Id
        tutor_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Tutor Id
        day_of_week:
          anyOf:
            - type: integer
            - type: 'null'
          title: Day Of Week
        start_time:
          anyOf:
            - type: string
            - type: 'null'
          title: Start Time
        end_time:
          anyOf:
            - type: string
            - type: 'null'
          title: End Time
        timezone:
          anyOf:
            - type: string
            - type: 'null'
          title: Timezone
        schedule_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Schedule Id
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
      type: object
      required:
        - id
      title: Availability
      description: >-
        A tutor's recurring weekly availability rule. `day_of_week` is 0–6
        (Sunday=0).
    PageMeta:
      properties:
        limit:
          type: integer
          title: Limit
        offset:
          anyOf:
            - type: integer
            - type: 'null'
          title: Offset
        count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Count
        total:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
          description: >-
            Cursor-mode only: pass as ?cursor= to fetch the next page; null when
            this is the last page.
      type: object
      required:
        - limit
      title: PageMeta
      description: |-
        Pagination envelope metadata. `count` is the size of the returned page;
        `total` (when present) is the full result-set size for offset paging.
        In cursor mode `offset`/`total` are absent and `next_cursor` carries the
        opaque token for the next page (null on the last page).
    ApiErrorBody:
      description: The `error` object every /v1 error response carries.
      properties:
        code:
          description: >-
            Stable machine-readable error code: bad_request, unauthorized,
            forbidden, not_found, conflict, validation_error, rate_limited, or
            internal_error.
          examples:
            - not_found
          title: Code
          type: string
        message:
          description: Human-readable explanation, safe to surface to end users.
          examples:
            - Session not found
          title: Message
          type: string
        status:
          description: The HTTP status code, repeated in the body.
          examples:
            - 404
          title: Status
          type: integer
        details:
          additionalProperties: true
          description: >-
            Error-specific context. 422 carries the field errors under `errors`;
            429 carries `retry_after_seconds`.
          title: Details
          type: object
      required:
        - code
        - message
        - status
      title: ApiErrorBody
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Org API key as `Token token=ei_live_...`

````

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