Learn how to develop new experiences with our APIs.
Overview
ApprentiScope's developer platform is a core part of our mission to empower organizations to scale Apprenticeships and Work-Based Learning. Our APIs are designed to enable teams of any shape or size to build robust integrations and new experiences with our products.
All ApprentiScope APIs are built using REST conventions and designed to have a predictable URL structure. They use many standard HTTP features, including methods (POST, GET, PUT, DELETE) and error response codes.
All API reference docs include an overview section and an endpoint section. The API overview includes a brief summary of its functionality, use cases, and any special considerations for creating an integration. The endpoints section lists each endpoint, its parameters, and request examples. Once you’ve received your API Credentials from ApprentiScope, you can use Postman or make test calls right from an endpoint reference page.
Locating your API Credentials
Once your API Access Request has been approved, you'll be able to access your credentials from the API Credentials section of your Profile page, as shown below.
API Reference
Notes
1. The base URI for all API calls is https://api.apprentiscope.com
2. All responses return standard JSON.
3. If you need additional functionality, let us know by submitting a Feature Request.
1. User Management
Create Managed User
Create a new user. Returns the user's ID upon completion.
Endpoint
POST
/create-user/
Headers
Authorization: YOUR_AUTH_TOKEN
Example
https://api.apprentiscope.com/create-user
Body:
{
first_name: "Johnny",
last_name: "Appleseed",
email: "johnny.appleseed@apprentiscope.com",
user_type: "apprentice",
program_id: occupation_id, //apprentices, applicants & mentors only
company_id: company_id,
//optional
phone: "8022272728",
middle_name: "B",
suffix: "Mr."
View all fields here: https://support.apprentiscope.com/rapids-validation-rules
}
Create Invitation
Send an invitation via email for account creation. Returns the Invitation ID upon completion.
Endpoint
POST
/create-invitation/
Headers
Authorization: YOUR_AUTH_TOKEN
Example
https://api.apprentiscope.com/create-invitation
Body:
{
first_name: "Johnny",
last_name: "Appleseed",
email: "johnny.appleseed@apprentiscope.com",
user_type: "apprentice",
program_id: occupation_id, //apprentices, applicants & mentors only
company_id: company_id
}
Read Users by User Type
Returns a list of all users in your ApprentiScope account across all user types.
Endpoint
GET
/read-users/:user_type
Param Options
applicant, apprentice, mentor, supervisor, provider, admin, sponsor, regulator, all
Headers
Authorization: YOUR_AUTH_TOKEN
Example
https://api.apprentiscope.com/read-users/apprentice
Read User by ID
Returns a user under a specified identifier.
Endpoint
GET
/read-user/:id
Headers
Authorization: YOUR_AUTH_TOKEN
Example
https://api.apprentiscope.com/read-user/user_id
Update User by ID
Update fields for an individual user by ID.
Endpoint
PUT
/update-user/:id
Headers
Authorization: YOUR_AUTH_TOKEN
Example
https://api.apprentiscope.com/update-user/user_id
Body:
{
first_name: "Johnny",
last_name: "Appleseed"
}
Delete User by ID
Remove a user from your account using their ID.
Endpoint
DELETE
/delete-user/:id
Headers
Authorization: YOUR_AUTH_TOKEN
Example
https://api.apprentiscope.com/delete-user/user_id
2. Partner Management
Create Partner
Create a new Partner. Returns the partner's ID upon completion.
Endpoint
POST
/create-partner/
Headers
Authorization: YOUR_AUTH_TOKEN
Example
URI
https://api.apprentiscope.com/create-partner
Body
{
title: "ApprentiScope, Inc.",
type: "employer",
street: "123 Bowling Avenue",
city: "Nashville",
state: "Tennessee",
}
Read Partners by Type
Returns a list of partners in your ApprentiScope account for a given type.
Endpoint
GET
/read-partners/:type
Param Options
employer, sponsor, education_provider
Headers
Authorization: YOUR_AUTH_TOKEN
Example
https://api.apprentiscope.com/read-partners/employer
Read Partner by ID
Returns a partner under a specified identifier.
Endpoint
GET
/read-partner/:id
Headers
Authorization: YOUR_AUTH_TOKEN
Example
https://api.apprentiscope.com/read-partner/partner_id
Update Partner by ID
Update fields for a partner by ID.
Endpoint
PUT
/update-partner/:id
Headers
Authorization: YOUR_AUTH_TOKEN
Example
https://api.apprentiscope.com/update-partner/partner_id
Body:
{
title: "ApprentiScope",
contact_name: "Johnny Appleseed"
}
Delete Partner by ID
Remove a partner from your account using their ID.
Endpoint
DELETE
/delete-partner/:id
Headers
Authorization: YOUR_AUTH_TOKEN
Example
https://api.apprentiscope.com/delete-partner/partner_id
3. Occupation Management
Read Occupations by Type
Returns a list of occupations in your ApprentiScope account for a given type.
Endpoint
GET
/read-occupation/:type
Param Options
1 (Time-Based), 2 (Competency-Based), 3 (Hybrid), all
Headers
Authorization: YOUR_AUTH_TOKEN
Example
https://api.apprentiscope.com/read-occupations/2
Read Occupation by ID
Returns an occupation under a specified identifier.
Endpoint
GET
/read-occupation/:id
Headers
Authorization: YOUR_AUTH_TOKEN
Example
https://api.apprentiscope.com/read-occupation/occupation_id
Update Occupation by ID
Update fields for an occupation by ID.
Endpoint
PUT
/update-occupation/:id
Headers
Authorization: YOUR_AUTH_TOKEN
Example
https://api.apprentiscope.com/update-occupation/occupation_id
Body:
{
title: "Application Developer"
}
Delete Occupation by ID
Remove an occupation from your account using their ID.
Endpoint
DELETE
/delete-occupation/:id
Headers
Authorization: YOUR_AUTH_TOKEN
Example
https://api.apprentiscope.com/delete-occupation/occupation_id
4. Program Management
Submit Hours
Submit OJT or RTI hours on behalf of a user.
Endpoint
POST
/submit-hours/:id/:type
Param Options
id: user_id
type: 1 (OJT Hours), 2 (RTI Hours)
Headers
Authorization: YOUR_AUTH_TOKEN
Example
Submit OJT hours for an apprentice.
URI
https://api.apprentiscope.com/submit-hours/user_id/1
Body
{
date_obj: JS DATE
competencies: [
{ id: competency_id, hours_worked: 3 },
{ id: competency_id_2, hours_worked: 3 },
etc...
]
}
Submit File
Add files to an Apprentices' profile.
Endpoint
POST
/submit-file/:id
Param Options
id: user_id
Headers
Authorization: YOUR_AUTH_TOKEN
Example
Submit a file called Fall Semester Transcript to an apprentice's profile.
URI
https://api.apprentiscope.com/submit-file/user_id
Body
{
title: "Fall Semester Transcript",
url: file_url
}
Don't see the endpoint you're looking for? Let us know how we can improve our APIs by submitting a Feature Request.