> ## 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 Gaps > Where the org is short on tutors: postcodes with booking demand but too few IN-PERSON tutors covering them, ranked worst-first. Delegates to the get_org_coverage_gaps RPC — the single source of truth shared with the in-app coverage map. Demand comes from this org's booking requests, status-weighted in SQL (pending weighs most; declined/expired/matched less) and placed by `preferred_postcode`. Supply counts IN-PERSON covering tutors only: an online all-areas tutor "covers" everywhere but cannot physically be in the area, so it must not mask a geographic gap. Aggregated per postcode (filter by `subject` for a single subject). Read-only intelligence: it recommends where to recruit, it changes nothing. ## OpenAPI ````yaml /openapi.json get /v1/coverage/gaps 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/gaps: get: tags: - General summary: Coverage Gaps description: >- Where the org is short on tutors: postcodes with booking demand but too few IN-PERSON tutors covering them, ranked worst-first. Delegates to the get_org_coverage_gaps RPC — the single source of truth shared with the in-app coverage map. Demand comes from this org's booking requests, status-weighted in SQL (pending weighs most; declined/expired/matched less) and placed by `preferred_postcode`. Supply counts IN-PERSON covering tutors only: an online all-areas tutor "covers" everywhere but cannot physically be in the area, so it must not mask a geographic gap. Aggregated per postcode (filter by `subject` for a single subject). Read-only intelligence: it recommends where to recruit, it changes nothing. operationId: coverage_gaps_v1_coverage_gaps_get parameters: - name: subject in: query required: false schema: anyOf: - type: string - type: 'null' description: Restrict demand + supply to this subject id title: Subject description: Restrict demand + supply to this subject id - name: min_tutors in: query required: false schema: type: integer maximum: 20 minimum: 1 description: A postcode is a gap when fewer than this many tutors cover it default: 1 title: Min Tutors description: A postcode is a gap when fewer than this many tutors cover it - name: limit in: query required: false schema: type: integer maximum: 200 minimum: 1 description: Max gap rows to return (default 50, max 200) default: 50 title: Limit description: Max gap rows to return (default 50, max 200) responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Page_CoverageGapItem_' '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_CoverageGapItem_: properties: data: items: $ref: '#/components/schemas/CoverageGapItem' type: array title: Data meta: $ref: '#/components/schemas/PageMeta' type: object required: - data - meta title: Page[CoverageGapItem] ApiError: description: Canonical error envelope for every /v1 error response (4xx/5xx). properties: error: $ref: '#/components/schemas/ApiErrorBody' required: - error title: ApiError type: object CoverageGapItem: properties: postcode: type: string title: Postcode suburb: anyOf: - type: string - type: 'null' title: Suburb subject_id: anyOf: - type: string - type: 'null' title: Subject Id demand_score: type: number title: Demand Score default: 0 request_count: type: integer title: Request Count default: 0 supply_count: type: integer title: Supply Count default: 0 type: object required: - postcode title: CoverageGapItem description: >- One under-served (postcode, subject) cell from /v1/coverage/gaps: demand outweighing covering supply. `demand_score` is the status-weighted booking-request signal (pending weighs most; declined/expired/matched less); `supply_count` is the number of distinct tutors who cover this postcode for the subject. 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.