Skip to main content
GOV.UK
Register trainee teachers
Beta
Menu
API
Help
Table of contents
Search (via Google)
Search
Register API documentation
What this API is for
How do I connect to this API?
Authentication and authorisation
Design principles
Trainee identifiers
Reference data and data encoding
Dates
Nationalities
Degrees
Placements
API versioning strategy
Breaking changes
Non-breaking changes
How the API version number reflects the changes we’ve made
Using the correct version of the API
Testing
Release notes
v2025.0-rc — 13 May 2025
Changes
v1.0-pre — 12 August 2024
Changes
v0.1 — 22 April 2024
Known issues
v2025.0-rc
Contents
API versioning strategy
Developing on the API
OpenAPI
Authentication
Endpoints
GET /info
Request
Possible responses
GET /trainees
Request
Parameters
Possible responses
GET /trainees/{trainee_id}
Request
Parameters
Possible responses
GET /trainees/{trainee_id}/placements
Request
Parameters
Possible responses
GET /trainees/{trainee_id}/placements/{placement_id}
Request
Parameters
Possible responses
GET /trainees/{trainee_id}/degrees
Request
Parameters
Possible responses
GET /trainees/{trainee_id}/degrees/{degree_id}
Request
Parameters
Possible responses
POST /trainees
Request
Request body
Possible responses
Trainee duplication validations
POST /trainees/{trainee_id}/placements
Request
Parameters
Request body
Possible responses
POST /trainees/{trainee_id}/degrees
Request
Parameters
Request body
Possible responses
Degree duplication validations
POST /trainees/{trainee_id}/recommend-for-qts
Request
Parameters
Request body
Possible responses
POST /trainees/{trainee_id}/defer
Request
Parameters
Request body
Possible responses
POST /trainees/{trainee_id}/withdraw
Request
Parameters
Request body
Possible responses
PUT|PATCH /trainees/{trainee_id}
Request
Parameters
Request body
Possible responses
PUT|PATCH /trainees/{trainee_id}/placements/{placement_id}
Request
Parameters
Request body
Possible responses
PUT|PATCH /trainees/{trainee_id}/degrees/{degree_id}
Request
Parameters
Request body
Possible responses
Degree duplication validations
DELETE /trainees/{trainee_id}/placements/{placement_id}
Request
Parameters
Possible responses
DELETE /trainees/{trainee_id}/degrees/{degree_id}
Request
Parameters
Possible responses
Objects
Trainee object
Placement object
Degree object
Field lengths summary
v1.0-pre
Contents
API versioning strategy
Developing on the API
OpenAPI
Authentication
Endpoints
GET /info
Request
Possible responses
GET /trainees
Request
Parameters
Possible responses
GET /trainees/{trainee_id}
Request
Parameters
Possible responses
GET /trainees/{trainee_id}/placements
Request
Parameters
Possible responses
GET /trainees/{trainee_id}/placements/{placement_id}
Request
Parameters
Possible responses
GET /trainees/{trainee_id}/degrees
Request
Parameters
Possible responses
GET /trainees/{trainee_id}/degrees/{degree_id}
Request
Parameters
Possible responses
POST /trainees
Request
Request body
Possible responses
Trainee duplication validations
POST /trainees/{trainee_id}/placements
Request
Parameters
Request body
Possible responses
POST /trainees/{trainee_id}/degrees
Request
Parameters
Request body
Possible responses
Degree duplication validations
POST /trainees/{trainee_id}/recommend-for-qts
Request
Parameters
Request body
Possible responses
POST /trainees/{trainee_id}/defer
Request
Parameters
Request body
Possible responses
POST /trainees/{trainee_id}/withdraw
Request
Parameters
Request body
Possible responses
PUT|PATCH /trainees/{trainee_id}
Request
Parameters
Request body
Possible responses
PUT|PATCH /trainees/{trainee_id}/placements/{placement_id}
Request
Parameters
Request body
Possible responses
PUT|PATCH /trainees/{trainee_id}/degrees/{degree_id}
Request
Parameters
Request body
Possible responses
Degree duplication validations
DELETE /trainees/{trainee_id}/placements/{placement_id}
Request
Parameters
Possible responses
DELETE /trainees/{trainee_id}/degrees/{degree_id}
Request
Parameters
Possible responses
Objects
Trainee object
Placement object
Degree object
Field lengths summary
v0.1
Contents
API versioning strategy
Draft version 0.1
Developing on the API
Reference spreadsheet
OpenAPI
Authentication
Endpoints
GET /info
Request
Possible responses
GET /trainees
Request
Parameters
Possible responses
GET /trainees/{trainee_id}
Request
Parameters
Possible responses
GET /trainees/{trainee_id}/placements
Request
Parameters
Possible responses
GET /trainees/{trainee_id}/placements/{placement_id}
Request
Parameters
Possible responses
GET /trainees/{trainee_id}/degrees
Request
Parameters
Possible responses
GET /trainees/{trainee_id}/degrees/{degree_id}
Request
Parameters
Possible responses
POST /trainees
Request
Request body
Possible responses
POST /trainees/{trainee_id}/placements
Request
Parameters
Request body
Possible responses
POST /trainees/{trainee_id}/degrees
Request
Parameters
Request body
Possible responses
POST /trainees/{trainee_id}/recommend-for-qts
Request
Parameters
Request body
Possible responses
POST /trainees/{trainee_id}/defer
Request
Parameters
Request body
Possible responses
POST /trainees/{trainee_id}/withdraw
Request
Parameters
Request body
Possible responses
PUT|PATCH /trainees/{trainee_id}
Request
Parameters
Request body
Possible responses
PUT|PATCH /trainees/{trainee_id}/placements/{placement_id}
Request
Parameters
Request body
Possible responses
PUT|PATCH /trainees/{trainee_id}/degrees/{degree_id}
Request
Parameters
Request body
Possible responses
DELETE /trainees/{trainee_id}/placements/{placement_id}
Request
Parameters
Possible responses
DELETE /trainees/{trainee_id}/degrees/{degree_id}
Request
Parameters
Possible responses
Objects
Trainee object
Placement object
Degree object
Field lengths summary
Objects