[BETA] List companies

List the companies of your school, most recently created first. search matches a literal substring of name, displayName or businessIdentifier; businessIdentifier is an exact match. To find companies by your own references, use POST /companies:search with filters.externalReferenceIds.

includeStudents and includeExternals add the full, unpaginated students and externals arrays to each company: active people only; learners attached directly or through an apprenticeship contract, each once; external contacts counted once per email, the ones without an email left out. Learners are ordered by last name, first name, then ID; external contacts by last name, first name, then email. Each array is empty when nobody is attached.

Several learners and external contacts can be attached to one company, and a change to the company applies to all of them.

Attach a learner with companyId on PATCH /students/{id} (or its by-reference-id twin): it is the "Company" field of the learner record in the School app. That call also copies the company display name into the learner's historical company text; updating the company later does not rewrite that text.

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 across company names and registration identifiers

string
length between 1 and 64

Filter companies by exact registration identifier

boolean
Defaults to false

When true, include a students[] array on each company: every active learner it hosts

boolean
Defaults to false

When true, include an externals[] array on each company: every active external contact attached to it

Responses

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