> ## 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.

# Org Join Link

> The org's reusable self-signup join links + codes (student + tutor). Share these via
Facebook/Instagram/WhatsApp — anyone who opens one is added to your org when they sign up, no
email needed from you. READ-ONLY: returns the existing codes (a field is null if that code
hasn't been minted yet — call POST /v1/invites {scope:"organization"} to mint one). This GET
never writes, so it's safe under the read scope.



## OpenAPI

````yaml /openapi.json get /v1/org/join-link
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/org/join-link:
    get:
      tags:
        - General
      summary: Org Join Link
      description: >-
        The org's reusable self-signup join links + codes (student + tutor).
        Share these via

        Facebook/Instagram/WhatsApp — anyone who opens one is added to your org
        when they sign up, no

        email needed from you. READ-ONLY: returns the existing codes (a field is
        null if that code

        hasn't been minted yet — call POST /v1/invites {scope:"organization"} to
        mint one). This GET

        never writes, so it's safe under the read scope.
      operationId: org_join_link_v1_org_join_link_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgJoinLink'
        '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:
    OrgJoinLink:
      properties:
        student_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Student Code
        student_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Student Url
        tutor_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Tutor Code
        tutor_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Tutor Url
      type: object
      title: OrgJoinLink
      description: >-
        GET /v1/org/join-link — the org's reusable self-signup join links/codes
        (share via

        Facebook/Instagram/WhatsApp; no email needed from you). `student_*` adds
        the person as a

        student, `tutor_*` as a tutor. This GET is read-only and never mints: a
        field is null until

        its code has been minted via `POST /v1/invites {scope:"organization"}`
        (omit `email`).
    ApiError:
      description: Canonical error envelope for every /v1 error response (4xx/5xx).
      properties:
        error:
          $ref: '#/components/schemas/ApiErrorBody'
      required:
        - error
      title: ApiError
      type: object
    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.