Overview

Lead provier API for the Register Early Career Teachers system. TEST.

Documents

swagger.yaml
Uploaded schema

Environments

Environment Base URL
live https://pp-api.education.gov.uk/lead-providers-api-test-hosted

You need to sign in to subscribe to an API environment or view your existing subscriptions.

Sign in here using GOV.UK One Login

Current release

Release name Available from
v3 01 July 2026

Operations

POST Create a partnership with a school and delivery partner

Description

Create a partnership with a school and delivery partner

URL template
/api/v3/partnerships

POST Declare a participant has reached a milestone. Idempotent endpoint - submitting exact copy of a request will return the same response body as submitting it the first time.

Description

Declare a participant has reached a milestone. Idempotent endpoint - submitting exact copy of a request will return the same response body as submitting it the first time.

URL template
/api/v3/participant-declarations

PUT Notify that a participant has withdrawn from their course

Description

Notify that a participant has withdrawn from their course

URL template
/api/v3/participants/{id}/withdraw

PUT Notify that a participant is changing training schedule

Description

Notify that a participant is changing training schedule

URL template
/api/v3/participants/{id}/change-schedule

PUT Notify that a participant is resuming their course

Description

Notify that a participant is resuming their course

URL template
/api/v3/participants/{id}/resume

PUT Notify that a participant is taking a break from their course

Description

Notify that a participant is taking a break from their course

URL template
/api/v3/participants/{id}/defer

GET Retrieve a single declaration

Description

Retrieve a single declaration

URL template
/api/v3/participant-declarations/{id}

GET Retrieve a single delivery partner

Description

Retrieve a single delivery partner

URL template
/api/v3/delivery-partners/{id}

GET Retrieve a single financial statement details

Description

Retrieve a single financial statement details

URL template
/api/v3/statements/{id}

GET Retrieve a single participant

Description

Retrieve a single participant

URL template
/api/v3/participants/{id}

GET Retrieve a single partnership

Description

Retrieve a single partnership

URL template
/api/v3/partnerships/{id}

GET Retrieve a single school scoped to cohort

Description

Retrieve a single school scoped to cohort

URL template
/api/v3/schools/{id}

GET Retrieve a single unfunded mentor

Description

Retrieve a single unfunded mentor

URL template
/api/v3/unfunded-mentors/{id}

GET Retrieve all participants with transfers

Description

Retrieve all participants with transfers

URL template
/api/v3/participants/transfers

GET Retrieve multiple declarations

Description

Retrieve multiple declarations

URL template
/api/v3/participant-declarations

GET Retrieve multiple delivery partners

Description

Retrieve multiple delivery partners

URL template
/api/v3/delivery-partners

GET Retrieve multiple financial statement details

Description

Retrieve multiple financial statement details

URL template
/api/v3/statements

GET Retrieve multiple participants

Description

Retrieve multiple participants

URL template
/api/v3/participants

GET Retrieve multiple partnerships

Description

Retrieve multiple partnerships

URL template
/api/v3/partnerships

GET Retrieve multiple schools scoped to cohort

Description

Retrieve multiple schools scoped to cohort

URL template
/api/v3/schools

GET Retrieve multiple unfunded mentors

Description

Retrieve multiple unfunded mentors

URL template
/api/v3/unfunded-mentors

GET Retrieve transfers for a given participant

Description

Retrieve transfers for a given participant

URL template
/api/v3/participants/{id}/transfers

PUT Update the delivery partner for an existing partnership in a cohort

Description

Update the delivery partner for an existing partnership in a cohort

URL template
/api/v3/partnerships/{id}

PUT Void a declaration

Description

Void a declaration

URL template
/api/v3/participant-declarations/{id}/void
Back to top