curl --request GET \
--url https://api.example.com/v1/coverage/tutors \
--header 'Authorization: <api-key>'import requests
url = "https://api.example.com/v1/coverage/tutors"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.example.com/v1/coverage/tutors', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/coverage/tutors",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/coverage/tutors"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/coverage/tutors")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/coverage/tutors")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"full_name": "<string>",
"email": "<string>",
"placeholder_email": true,
"role": "<string>",
"status": "<string>",
"bio": "<string>",
"teaching_mode": "<string>",
"is_published": true,
"avatar_url": "<string>",
"handle": "<string>",
"subjects": [
"<string>"
],
"created_at": "<string>",
"home_suburb": "<string>",
"home_postcode": "<string>",
"home_lat": 123,
"home_lng": 123,
"service_postcodes": [],
"serves_all_areas": true,
"max_travel_km": 123,
"in_person_arrangements": [],
"tutor_subjects": [],
"specialisations": [
"<string>"
],
"distance_km": 123,
"covers_area": true
}
],
"meta": {
"limit": 123,
"offset": 123,
"count": 123,
"total": 123,
"next_cursor": "<string>"
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}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).
curl --request GET \
--url https://api.example.com/v1/coverage/tutors \
--header 'Authorization: <api-key>'import requests
url = "https://api.example.com/v1/coverage/tutors"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.example.com/v1/coverage/tutors', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/coverage/tutors",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/coverage/tutors"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/coverage/tutors")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/coverage/tutors")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"full_name": "<string>",
"email": "<string>",
"placeholder_email": true,
"role": "<string>",
"status": "<string>",
"bio": "<string>",
"teaching_mode": "<string>",
"is_published": true,
"avatar_url": "<string>",
"handle": "<string>",
"subjects": [
"<string>"
],
"created_at": "<string>",
"home_suburb": "<string>",
"home_postcode": "<string>",
"home_lat": 123,
"home_lng": 123,
"service_postcodes": [],
"serves_all_areas": true,
"max_travel_km": 123,
"in_person_arrangements": [],
"tutor_subjects": [],
"specialisations": [
"<string>"
],
"distance_km": 123,
"covers_area": true
}
],
"meta": {
"limit": 123,
"offset": 123,
"count": 123,
"total": 123,
"next_cursor": "<string>"
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}Authorizations
Org API key as Token token=ei_live_...
Query Parameters
Filter to tutors who teach this subject id
online | in_person | either (default: all)
In-person arrangement gate (applies only when mode=in_person)
Meeting-point postcode; sets each tutor's covers_area + distance_km
Records per page (default 100, max 500)
1 <= x <= 500Pagination offset
x >= 0Response
Successful Response
Show child attributes
Show child attributes
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).
Show child attributes
Show child attributes
Was this page helpful?