> ## 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 Registry Subjects

> The subject registry visible to your org: platform subjects plus any your org created.

Each entry gives the `subject_id` to send when creating questions and whether a
curriculum tree exists (`GET /v1/curriculum/items?subject_id=...`). Active subjects
only unless `include_inactive`. Ordered by label then id.



## OpenAPI

````yaml /openapi.json get /v1/curriculum/subjects
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=cq_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/curriculum/subjects:
    get:
      tags:
        - General
      summary: List Registry Subjects
      description: >-
        The subject registry visible to your org: platform subjects plus any
        your org created.


        Each entry gives the `subject_id` to send when creating questions and
        whether a

        curriculum tree exists (`GET /v1/curriculum/items?subject_id=...`).
        Active subjects

        only unless `include_inactive`. Ordered by label then id.
      operationId: list_registry_subjects_v1_curriculum_subjects_get
      parameters:
        - name: q
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Case-insensitive match on the subject label.
            title: Q
          description: Case-insensitive match on the subject label.
        - name: has_curriculum
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            description: >-
              Only subjects that do (true) or do not (false) have a curriculum
              tree.
            title: Has Curriculum
          description: >-
            Only subjects that do (true) or do not (false) have a curriculum
            tree.
        - name: include_inactive
          in: query
          required: false
          schema:
            type: boolean
            description: Include deactivated subjects.
            default: false
            title: Include Inactive
          description: Include deactivated subjects.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 100
            title: Limit
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
            title: Offset
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_RegistrySubject_'
        '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_RegistrySubject_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/RegistrySubject'
          type: array
          title: Data
        meta:
          $ref: '#/components/schemas/PageMeta'
      type: object
      required:
        - data
        - meta
      title: Page[RegistrySubject]
    ApiError:
      description: Canonical error envelope for every /v1 error response (4xx/5xx).
      properties:
        error:
          $ref: '#/components/schemas/ApiErrorBody'
      required:
        - error
      title: ApiError
      type: object
    RegistrySubject:
      properties:
        subject_id:
          type: string
          title: Subject Id
          description: Send as `subject_id` when creating questions.
        label:
          anyOf:
            - type: string
            - type: 'null'
          title: Label
          description: Display name of the subject.
        curriculum_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Curriculum Code
        is_platform:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Platform
          description: >-
            True for a platform subject, false for one your organisation
            created.
        has_curriculum:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Has Curriculum
          description: >-
            True when the subject has a curriculum tree to browse via `GET
            /v1/curriculum/items`.
      type: object
      required:
        - subject_id
      title: RegistrySubject
      description: A subject from the registry, as listed by `GET /v1/curriculum/subjects`.
    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=cq_live_...`

````

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