v1

latestOpenAPI 3.0.4MIT License2026-07-236622149.8 KB
Get into Teaching

Retrieves a pre-populated GetIntoTeachingCallback for the candidate.

                    Retrieves a pre-populated GetIntoTeachingCallback for the candidate. The `accessToken` is obtained from a 
                    `POST /candidates/access_tokens` request (you must also ensure the `ExistingCandidateRequest` payload you 
                    exchanged for your token matches the request payload here).
post/api/get_into_teaching/callbacks/exchange_access_token/{accessToken}

Path parameters

accessTokenstring required

Access token (PIN code).

Request body

firstNamestring nullable
lastNamestring nullable
emailstring email required
dateOfBirthstring date-time nullable
referencestring nullable

Response

OK

candidateIdstring uuid nullable
acceptedPolicyIdstring uuid required
emailstring required
firstNamestring required
lastNamestring required
addressTelephonestring required
phoneCallScheduledAtstring date-time required
talkingPointsstring required
creationChannelSourceIdinteger nullable
creationChannelServiceIdinteger nullable
creationChannelActivityIdinteger nullable
defaultContactCreationChannelinteger nullable
defaultCreationChannelSourceIdinteger nullable
defaultCreationChannelServiceIdinteger nullable
defaultCreationChannelActivityIdinteger nullable