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

courseId
integer
required

The unique identifier of the course

Request Headers

X-API-KEY
string
required

API Key. Go to your Konstantly site > Settings > API and copy the value from there.

Query Parameters

offset
integer

Entry number to start listing from

limit
integer
default:"20"

The number of entries to be listed

Response

certificates
array
required

Array of certificate objects

totalCount
integer
required

Total number of certificates

Error Responses

404
object

Returned when the course is not found

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
}