Recommend Tutors
curl --request GET \
--url https://api.example.com/v1/booking-requests/{request_id}/recommended-tutors \
--header 'Authorization: <api-key>'import requests
url = "https://api.example.com/v1/booking-requests/{request_id}/recommended-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/booking-requests/{request_id}/recommended-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/booking-requests/{request_id}/recommended-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/booking-requests/{request_id}/recommended-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/booking-requests/{request_id}/recommended-tutors")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/booking-requests/{request_id}/recommended-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{
"request_id": "<string>",
"data": [
{
"tutor_id": "<string>",
"breakdown": {
"subject": 0,
"availability": 0,
"mode": 0,
"capacity": 0,
"distance": 0
},
"first_name": "<string>",
"last_name": "<string>",
"score": 0,
"reasons": [],
"upcoming_sessions_count": 0,
"teaches_subject": false,
"distance_km": 123,
"nearby": false,
"road_km": 123,
"road_minutes": 123
}
],
"subject_id": "<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": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}Bookings
Recommend Tutors
Rank the org’s tutors for a booking request, best fit first.
Each tutor is scored 0–100 on subject match, availability overlap with the
requested days/times, teaching mode, spare capacity, and — for an in-person
request with a known suburb — proximity (via the shared match_org_tutors RPC,
which also powers the in-app matcher). Tutors who can’t do the requested
arrangement or are beyond their travel radius are omitted. Includes a
per-signal breakdown, distance_km/nearby, and human-readable reasons.
Read-only — this recommends, it never assigns. 404 if the request isn’t this org’s.
GET
/
v1
/
booking-requests
/
{request_id}
/
recommended-tutors
Recommend Tutors
curl --request GET \
--url https://api.example.com/v1/booking-requests/{request_id}/recommended-tutors \
--header 'Authorization: <api-key>'import requests
url = "https://api.example.com/v1/booking-requests/{request_id}/recommended-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/booking-requests/{request_id}/recommended-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/booking-requests/{request_id}/recommended-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/booking-requests/{request_id}/recommended-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/booking-requests/{request_id}/recommended-tutors")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/booking-requests/{request_id}/recommended-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{
"request_id": "<string>",
"data": [
{
"tutor_id": "<string>",
"breakdown": {
"subject": 0,
"availability": 0,
"mode": 0,
"capacity": 0,
"distance": 0
},
"first_name": "<string>",
"last_name": "<string>",
"score": 0,
"reasons": [],
"upcoming_sessions_count": 0,
"teaches_subject": false,
"distance_km": 123,
"nearby": false,
"road_km": 123,
"road_minutes": 123
}
],
"subject_id": "<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": {}
}
}{
"error": {
"code": "not_found",
"message": "Session not found",
"status": 404,
"details": {}
}
}Authorizations
Org API key as Token token=ei_live_...
Path Parameters
Booking request UUID
Query Parameters
Max tutors to return (default 10, max 50)
Required range:
1 <= x <= 50Was this page helpful?