Certificates
put
Authorizations
Body
Responses
200
Revoking users certificate
application/json
put
PUT /api/v1/certificates/revoke_users_certificate HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 62
{
"certificate": {
"listing_id": "text",
"canvas_user_ids": "text"
}
}
200
Revoking users certificate
{
"revoked_certificates": [
{
"canvas_user_id": 1,
"canvas_course_id": 1001,
"listing_id": 28
}
]
}
get
Authorizations
Query parameters
listing_idintegerRequired
Id of the Listing
Responses
200
Getting a listing certificate
application/json
get
GET /api/v1/certificates HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
200
Getting a listing certificate
{
"certificate": {
"id": 4,
"listing_id": 31,
"name": "Certificate of Training",
"active": true,
"template": "Congrats, {{student_name}}!",
"pdf_settings": {},
"created_at": "2025/06/10 13:42:07 +0000",
"updated_at": "2025/06/10 13:42:07 +0000",
"days_to_expire": null,
"expires_at": null
}
}
post
Authorizations
Body
days_to_expirestringOptional
Days until the certificate expires after it is awarded. Defaults to null. Must not be present when expires_at is present.
expires_atstringOptional
Date of certificate expiration. Defaults to null. Must not be present when days_to_expire is present.
Responses
201
Creating a certificate
application/json
post
POST /api/v1/certificates HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 180
{
"certificate": {
"listing_id": "text",
"name": "text",
"active": "text",
"template": "text"
},
"certificate[pdf_settings]": {
"orientation": "text"
},
"days_to_expire": "text",
"expires_at": "text"
}
201
Creating a certificate
{
"certificate": {
"id": 3,
"listing_id": 30,
"name": "API Name",
"active": true,
"template": "<H1>This is a template</h1>",
"pdf_settings": {
"orientation": "Landscape"
},
"created_at": "2025/06/10 13:42:07 +0000",
"updated_at": "2025/06/10 13:42:07 +0000",
"days_to_expire": null,
"expires_at": null
}
}
delete
Authorizations
Body
nullify_requirements_completed_atstringOptional
Should nullify the requirements_completed_at for the enrollments, defaults to false
Responses
204
Deleting a certificate
*/*
Responseobject
delete
DELETE /api/v1/certificates HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 80
{
"certificate": {
"listing_id": "text"
},
"nullify_requirements_completed_at": "text"
}
204
Deleting a certificate
{}
Last updated
Was this helpful?