List Earned Certificates
GET https://api.suger.cloud/ai/org/{orgId}/prm/issuedCertificate
List earned certificates, newest first, including expired ones and ones replaced by a renewal (`status` Expired or Renewed); count current certificates by `status` Active or Expires Soon. Each carries the learner (`userName`), the learner's organization (`organizationName`), the course and the organization that issued it as they were when it was issued, and the certified course version (`courseVersionNo`). With no filter: every certificate held by a user of this organization (certificates this organization's people earned on courses partners shared with it). `mine=true`: the calling user's own, after issuing any certificate the caller has earned and not yet received. `courseId`: the certified learners of one of this organization's own courses, across partner organizations (404 for a course it does not own). `mine=true` with `courseId` is a 400. To see how partners are doing on this organization's own courses, call GetPartnerTrainingProgress, with `partnerOrgId` for one partner. Needs partners.read.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | yes | Organization ID |
mine | query | boolean | no | true for the calling user's own certificates |
courseId | query | string | no | One of this organization's courses, for its certified learners (a ListCourses row's id) |
Responses
200 — Earned certificates
Content-Type: application/json
IssuedCertificateView fields:
| Field | Type | Required | Description |
|---|---|---|---|
certificateId | string | no | |
courseId | string | no | Course the learner passed |
courseVersionId | string | no | The pinned version the learner passed (part of the idempotency key) |
courseVersionNo | integer | no | CourseVersionNo is the human-readable number of the course version the learner was certified in (resolved from the embedded row's CourseVersionID, NOT snapshotted — version_no is immutable for a version, so there's nothing to freeze). Lets the artifact / lists show the certified curriculum edition ("{course} · v2"). 0 if the version row could not be resolved. |
createTime | string | no | Creation timestamp |
expired | boolean | no | Expired is derived: ExpiresAt != nil && now > *ExpiresAt. A certificate with no validity window is never expired. |
expiresAt | string | no | issued_at + validity_months if the definition had one; NULL = never expires |
id | string | no | ID of the ent. Unique issued-certificate identifier (UUID) |
issuedAt | string | no | Issue timestamp |
issuerOrgId | string | no | The issuing org: the certificate definition's sourceOrgId. Set by ListIssuedCertificates' org list only (not with mine=true); snapshot.issuerOrgName is a display name and is not unique across orgs. |
lastUpdateTime | string | no | Last update timestamp |
lifecycle | IssuedCertificateLifecycle | no | |
organizationId | string | no | Consumer org (the learner's org context) |
organizationName | string | no | OrganizationName is the RECIPIENT org's display name (the consumer org that holds the cert — organization_id), resolved on read so the rendered artifact can show the learner's organization. Distinct from snapshot.issuerOrgName (the GRANTING org). "" if unresolved. Note: on CertifiedLearnerView the outer OrganizationName (set per consumer org) shadows this in JSON. |
renewedFromId | string | no | The prior issued_certificate this instance renewed (history chain); NULL for a first issue |
snapshot | IssuedCertificateSnapshot | no | |
status | string | no | Status is the derived lifecycle state: "Active" | "Expires Soon" (within 30 days of ExpiresAt) | "Expired" | "Renewed" (superseded by a newer instance — kept as history). Never stored. |
supersededAt | string | no | Set when a newer instance of the same certificate renewed this one; the row stays as history. NULL = current instance. |
userId | string | no | The learner |
userName | string | no | Learner display name |
IssuedCertificateLifecycle fields:
| Field | Type | Required | Description |
|---|---|---|---|
autoReenrolledAt | string | no | AutoReenrolledAt — the Auto Re-enroll cron already re-enrolled the learner for this instance (never repeated). |
expiredNoticeSentAt | string | no | |
notice30SentAt | string | no | Notice30SentAt / Notice7SentAt / ExpiredNoticeSentAt — learner expiry notifications (30 days before, 7 days before, on/after expiry). |
notice7SentAt | string | no |
IssuedCertificateSnapshot fields:
| Field | Type | Required | Description |
|---|---|---|---|
branding | CertificateBranding | no | |
courseName | string | no | |
description | string | no | |
issuerOrgName | string | no | |
name | string | no |
CertificateBranding fields:
| Field | Type | Required | Description |
|---|---|---|---|
accentColor | string | no | |
backgroundColor | string | no | |
backgroundImageUrl | string | no | |
issuerName | string | no | |
logoUrl | string | no | |
textColor | string | no |
400 — mine=true with courseId, or a mine that is not true or false
Content-Type: text/plain
404 — The course is not this organization's
Content-Type: text/plain
500 — Internal server error
Content-Type: application/json
Example
Generated from this operation's schema. Values are placeholders —
substitute your own ids, and set SUGER_TOKEN to a bearer token
from the OAuth client-credentials exchange.
Request
curl -X GET 'https://api.suger.cloud/ai/org/{orgId}/prm/issuedCertificate' \
-H "Authorization: Bearer $SUGER_TOKEN" Response — 200
[
{
"certificateId": "01H0000000000000000000",
"courseId": "01H0000000000000000000",
"courseVersionId": "01H0000000000000000000",
"courseVersionNo": 1,
"createTime": "2026-01-31T12:00:00Z",
"expired": true,
"expiresAt": "string",
"id": "01H0000000000000000000",
"issuedAt": "string",
"issuerOrgId": "01H0000000000000000000",
"lastUpdateTime": "2026-01-31T12:00:00Z",
"lifecycle": {
"autoReenrolledAt": "string",
"expiredNoticeSentAt": "string",
"notice30SentAt": "string",
"notice7SentAt": "string"
}
}
] Error — 400
"string" View as Markdown · API reference overview
Spotted something wrong or out of date on this page? Tell us and we'll correct it.