> ## 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 Tutors > The org's tutors with their service-area coverage of `postcode`, covering-first. Each tutor carries `covers_area` — does their declared service (serves_all_areas, service_postcodes, or within max_travel_km) reach the postcode — and `distance_km`, the straight-line km from the postcode centroid to the tutor's home (null when either is unknown). Coverage is computed once, server-side, by the shared coverage RPC; it is never re-derived here. With no `postcode`, geography is ignored and every tutor is flagged covers_area=true. Postcode-level only — street addresses are never returned. Org-bound (the API key scopes the org). ## OpenAPI ````yaml /openapi.json get /v1/coverage/tutors 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/tutors: get: tags: - General summary: Coverage Tutors description: >- The org's tutors with their service-area coverage of `postcode`, covering-first. Each tutor carries `covers_area` — does their declared service (serves_all_areas, service_postcodes, or within max_travel_km) reach the postcode — and `distance_km`, the straight-line km from the postcode centroid to the tutor's home (null when either is unknown). Coverage is computed once, server-side, by the shared coverage RPC; it is never re-derived here. With no `postcode`, geography is ignored and every tutor is flagged covers_area=true. Postcode-level only — street addresses are never returned. Org-bound (the API key scopes the org). operationId: coverage_tutors_v1_coverage_tutors_get parameters: - name: subject in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter to tutors who teach this subject id title: Subject description: Filter to tutors who teach this subject id - name: mode in: query required: false schema: anyOf: - type: string - type: 'null' description: 'online | in_person | either (default: all)' title: Mode description: 'online | in_person | either (default: all)' - name: arrangement in: query required: false schema: anyOf: - type: string - type: 'null' description: In-person arrangement gate (applies only when mode=in_person) title: Arrangement description: In-person arrangement gate (applies only when mode=in_person) - name: postcode in: query required: false schema: anyOf: - type: string - type: 'null' description: >- Meeting-point postcode; sets each tutor's covers_area + distance_km title: Postcode description: Meeting-point postcode; sets each tutor's covers_area + distance_km - name: limit in: query required: false schema: type: integer maximum: 500 minimum: 1 description: Records per page (default 100, max 500) default: 100 title: Limit description: Records per page (default 100, max 500) - name: offset in: query required: false schema: type: integer minimum: 0 description: Pagination offset default: 0 title: Offset description: Pagination offset responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Page_Tutor_' '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_Tutor_: properties: data: items: $ref: '#/components/schemas/Tutor' type: array title: Data meta: $ref: '#/components/schemas/PageMeta' type: object required: - data - meta title: Page[Tutor] ApiError: description: Canonical error envelope for every /v1 error response (4xx/5xx). properties: error: $ref: '#/components/schemas/ApiErrorBody' required: - error title: ApiError type: object Tutor: properties: id: type: string title: Id first_name: anyOf: - type: string - type: 'null' title: First Name last_name: anyOf: - type: string - type: 'null' title: Last Name full_name: anyOf: - type: string - type: 'null' title: Full Name email: anyOf: - type: string - type: 'null' title: Email placeholder_email: anyOf: - type: boolean - type: 'null' title: Placeholder Email role: anyOf: - type: string - type: 'null' title: Role status: anyOf: - type: string - type: 'null' title: Status bio: anyOf: - type: string - type: 'null' title: Bio teaching_mode: anyOf: - type: string - type: 'null' title: Teaching Mode is_published: anyOf: - type: boolean - type: 'null' title: Is Published avatar_url: anyOf: - type: string - type: 'null' title: Avatar Url handle: anyOf: - type: string - type: 'null' title: Handle subjects: items: type: string type: array title: Subjects created_at: anyOf: - type: string - type: 'null' title: Created At home_suburb: anyOf: - type: string - type: 'null' title: Home Suburb home_postcode: anyOf: - type: string - type: 'null' title: Home Postcode home_lat: anyOf: - type: number - type: 'null' title: Home Lat home_lng: anyOf: - type: number - type: 'null' title: Home Lng service_postcodes: items: type: string type: array title: Service Postcodes default: [] serves_all_areas: anyOf: - type: boolean - type: 'null' title: Serves All Areas max_travel_km: anyOf: - type: integer - type: 'null' title: Max Travel Km in_person_arrangements: items: type: string type: array title: In Person Arrangements default: [] tutor_subjects: items: type: string type: array title: Tutor Subjects default: [] specialisations: items: type: string type: array title: Specialisations distance_km: anyOf: - type: number - type: 'null' title: Distance Km covers_area: anyOf: - type: boolean - type: 'null' title: Covers Area type: object required: - id title: Tutor 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.