get_certificate
Read-onlyIdempotent
Retrieve a single issued certificate by its obfuscated ID to access details such as its public verification code, expiry, score, and status.
Instructions
Fetch one issued certificate, including its public verification code.
`id` is the obfuscated certificate id, which is what `list_certificates`
returns - it is NOT the `code`.
`code` is the certificate's unique public identifier: the string a learner or
their employer quotes to verify the certificate. Treat it as the answer to "how
do I prove I completed this", and note that anyone holding it can look the
certificate up.
`expires_at` is null for a certificate that does not expire, which is not the
same as one whose expiry is unknown. `score_as_percent` is null when no score
was recorded rather than zero - do not report a missing score as a failure.
`status` reflects the certificate itself, not the enrolment; a revoked or
expired certificate can belong to a completed course. Use `get_enrollment` for
the learner's progress.
Requires the `certificates:read` OAuth scope.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| code | No | ||
| status | No | ||
| issued_at | No | ||
| expires_at | No | ||
| score_as_percent | No |