[BETA] Search the people outside the school

Find an apprenticeship master to attach to an apprentice. Results are grouped by normalised email address: one entry per person, with recordCount saying how many EXTERNALS records sit behind it — a school can hold dozens of records for the same address, and listing them all would make the screen unusable. Records with no email address are never returned: they cannot be reached, and matching them together would hand one person another person’s apprentices.

Pass companyId to list the people attached to ONE company — this is how a company sheet shows its apprenticeship masters, the mirror of GET /students?companyId=. The filter applies to the records BEFORE they are grouped, so recordCount then counts the records of that person attached to THAT company, and the entry returned is one of them.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number
Defaults to 1

Page number for pagination (min: 1)

number
Defaults to 100

Number of items per page (max: 100)

Free-text search over the address and the full name, in both orders ("Marie Dupont" and "Dupont Marie"). Absent = browse everyone.

string
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$

Return only the people attached to this company — how a company sheet lists its apprenticeship masters. Combines with search. The company must belong to your school: asking for another school’s company returns an empty page, never someone else’s people.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json