Waitlist Applicants
get
Authorizations
Path parameters
idintegerRequired
Responses
200
Getting a specific applicant record
application/json
get
GET /api/v1/applicants/{id} HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
200
Getting a specific applicant record
{
"applicant": {
"id": 1,
"user": {
"id": 1,
"name": "Applicant",
"email": "[email protected]"
},
"listing": {
"id": 32,
"title": "Course 30"
},
"notified_of_opening_at": null,
"status": "waitlist",
"created_at": "2025/06/10 13:42:07 +0000",
"updated_at": "2025/06/10 13:42:07 +0000"
}
}
get
Authorizations
Query parameters
listing_idstringOptional
Only include applicants for the specified listing
statusstringOptional
Only include applicants for the specified status (waitlist, accepted, declined, or expired)
Responses
200
Listing applicants
application/json
Responseobject
get
GET /api/v1/applicants HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
200
Listing applicants
{
"applicants": [
{
"id": 3,
"user": {
"id": 3,
"name": "Applicant",
"email": "[email protected]"
},
"listing": {
"id": 34,
"title": "Course 32"
},
"notified_of_opening_at": null,
"status": "waitlist",
"created_at": "2025/06/10 13:42:07 +0000",
"updated_at": "2025/06/10 13:42:07 +0000"
}
]
}
delete
Authorizations
Body
listing_idintegerRequired
Only delete applicants for the specified listing
canvas_user_idstringOptional
Only delete applicants with the specified canvas user id if specified
Responses
204
Delete applicants
*/*
Responseobject
delete
DELETE /api/v1/applicants HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 40
"listing_id=1&canvas_user_id='text'"
204
Delete applicants
{}
Last updated
Was this helpful?