GET
/
certificates
/
{certificateId}
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/certificates/123' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

{
    "id": 123,
    "name": "Course Completion Certificate",
    "description": "Certificate of completion for Advanced Marketing Course",
    "courseId": 2,
    "courseName": "Advanced Marketing",
    "imageUrl": "http://s3.amazonaws.com/qwerty/certificate.png",
    "achievedAt": 1234567890,
    "expiresAt": 1334567890,
    "user": {
    "id": "1234567890",
    "name": "John Smith",
    "email": "john@example.com",
    "language": "en",
    "timezone": "Europe/London",
    "occupation": "Marketing Manager",
    "location": "London",
    "isBanned": false,
    "role": {
    "alias": "learner"
},
    "fromApi": false,
    "image": null,
    "attributes": {}
}
}

Retrieve detailed information about a specific certificate.

​
Path Parameters

​
certificateId
integer
required

The unique identifier of the certificate

​
Request Headers

​
X-API-KEY
string
required

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

​
Response

​
id
integer
required
Certificate ID
​
name
string
required
Certificate name
​
description
string
required
Certificate description
​
courseId
integer
required
Course ID
​
courseName
string
required
Course name
​
imageUrl
string
required
URL to the certificate image
​
achievedAt
integer
required
Timestamp of certificate issue
​
expiresAt
integer
Timestamp when the certificate expires
​
user
object
required

User who has got the certificate

​
Error Responses

​
404
object

Returned when the certificate is not found

curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/certificates/123' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

{
    "id": 123,
    "name": "Course Completion Certificate",
    "description": "Certificate of completion for Advanced Marketing Course",
    "courseId": 2,
    "courseName": "Advanced Marketing",
    "imageUrl": "http://s3.amazonaws.com/qwerty/certificate.png",
    "achievedAt": 1234567890,
    "expiresAt": 1334567890,
    "user": {
    "id": "1234567890",
    "name": "John Smith",
    "email": "john@example.com",
    "language": "en",
    "timezone": "Europe/London",
    "occupation": "Marketing Manager",
    "location": "London",
    "isBanned": false,
    "role": {
    "alias": "learner"
},
    "fromApi": false,
    "image": null,
    "attributes": {}
}
}