curl --request GET \
--url https://YOURSITE.konstant.ly/openapi/v1/courses/123/certificates \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'
{
"certificates": [
{
"id": 123,
"name": "Course Completion Certificate",
"description": "Certificate of completion",
"courseId": 2,
"courseName": "Advanced Sales Techniques",
"imageUrl": "http://s3.amazonaws.com/certificates/cert123.png",
"achievedAt": 1234567890,
"expiresAt": 1334567890,
"user": {
"id": "1234567890",
"name": "John Doe",
"email": "john@example.com",
"role": {
"alias": "learner"
}
}
}
],
"totalCount": 1
}
Courses
List Course Certificates
Get a list of certificates for the course (20 per page)
GET
/
courses
/
{courseId}
/
certificates
curl --request GET \
--url https://YOURSITE.konstant.ly/openapi/v1/courses/123/certificates \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'
{
"certificates": [
{
"id": 123,
"name": "Course Completion Certificate",
"description": "Certificate of completion",
"courseId": 2,
"courseName": "Advanced Sales Techniques",
"imageUrl": "http://s3.amazonaws.com/certificates/cert123.png",
"achievedAt": 1234567890,
"expiresAt": 1334567890,
"user": {
"id": "1234567890",
"name": "John Doe",
"email": "john@example.com",
"role": {
"alias": "learner"
}
}
}
],
"totalCount": 1
}
Retrieve a list of all certificates issued for a specific course.
Path Parameters
integer
required
The unique identifier of the course
Request Headers
string
required
API Key. Go to your Konstantly site > Settings > API and copy the value from there.
Query Parameters
integer
Entry number to start listing from
integer
default:"20"
The number of entries to be listed
Response
array
required
Array of certificate objects
Show Certificate object properties
Show Certificate object properties
integer
required
Certificate ID
string
required
Certificate name
string
required
Certificate description
integer
required
Course ID
string
required
Course name
string
required
URL to the certificate image
integer
required
Timestamp of certificate issue
integer
Timestamp when certificate expires
integer
required
Total number of certificates
Error Responses
object
curl --request GET \
--url https://YOURSITE.konstant.ly/openapi/v1/courses/123/certificates \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'
{
"certificates": [
{
"id": 123,
"name": "Course Completion Certificate",
"description": "Certificate of completion",
"courseId": 2,
"courseName": "Advanced Sales Techniques",
"imageUrl": "http://s3.amazonaws.com/certificates/cert123.png",
"achievedAt": 1234567890,
"expiresAt": 1334567890,
"user": {
"id": "1234567890",
"name": "John Doe",
"email": "john@example.com",
"role": {
"alias": "learner"
}
}
}
],
"totalCount": 1
}
Was this page helpful?