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

# Coverage Summary

> Supply headcount for a subject and (optionally) a postcode in one call.

Returns `{ total, in_person, online, covering_area }`: `total` is the org's
subject-matched tutors, `in_person`/`online` split by delivery mode ('both' counts in
both), and `covering_area` is how many of them reach `postcode`. With no postcode,
`covering_area == total` (geography ignored). Same coverage RPC; no geometry recomputed.



## OpenAPI

````yaml /openapi.json get /v1/coverage/summary
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/coverage/summary:
    get:
      tags:
        - General
      summary: Coverage Summary
      description: >-
        Supply headcount for a subject and (optionally) a postcode in one call.


        Returns `{ total, in_person, online, covering_area }`: `total` is the
        org's

        subject-matched tutors, `in_person`/`online` split by delivery mode
        ('both' counts in

        both), and `covering_area` is how many of them reach `postcode`. With no
        postcode,

        `covering_area == total` (geography ignored). Same coverage RPC; no
        geometry recomputed.
      operationId: coverage_summary_v1_coverage_summary_get
      parameters:
        - name: subject
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Restrict the counts to this subject id
            title: Subject
          description: Restrict the counts to this subject id
        - name: postcode
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Meeting-point postcode; covering_area counts tutors within reach
            title: Postcode
          description: Meeting-point postcode; covering_area counts tutors within reach
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoverageSummaryResult'
        '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:
    CoverageSummaryResult:
      properties:
        subject_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Subject Id
        postcode:
          anyOf:
            - type: string
            - type: 'null'
          title: Postcode
        total:
          type: integer
          title: Total
          default: 0
        in_person:
          type: integer
          title: In Person
          default: 0
        online:
          type: integer
          title: Online
          default: 0
        covering_area:
          type: integer
          title: Covering Area
          default: 0
      type: object
      title: CoverageSummaryResult
      description: >-
        Counts for /v1/coverage/summary. `covering_area` is the subset of
        `total`

        within reach of `postcode` (equals `total` when no postcode is supplied
        —

        geography is then ignored). A tutor offering 'both' modes counts toward
        both

        `in_person` and `online`.
    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.