> ## 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: EquateIt Public API
  description: >-
    REST API for EquateIt 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 EquateIt 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'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
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. Codes are minted on first read if unset.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Org API key as `Token token=ei_live_...`

````