Zum Inhalt springen
Docs
Deutsch
Esc
navigateopen⌘Jpreview

Look up course completion certificates

Returns completion status and issued certificates for a user in a course. When no certificate has been issued yet, returns an empty certificates array with completion status populated.

GET/certificates
Query parameters
courseIdstringrequired
Course entity ID (CUID)
userIdstringrequired
User ID (CUID)
Responses
200Certificate lookup result
dataCertificateLookupResultrequired
Show properties
courseIdstringrequired
userIdstringrequired
completionCertificateCompletionrequired
Show properties
isCompletebooleanrequired
progressPercentintegerrequired
certificatesCertificateItem[]required
Show properties
Array of CertificateItem
idstringrequired
namestring | nullrequired
studentNamestringrequired
issuedAtstring<date-time>required
publicUrlstring<uri>required
metaResponseMetarequired
Show properties
requestIdstringrequired
timestampstring<date-time>required
versionstringrequired
Allowed:v4
400Bad Request
typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
401Unauthorized
typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
404Not Found
typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
422Unprocessable Entity — validation or business rule error
typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
429Too Many Requests
typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
500Internal Server Error
typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
Request
curl -X GET "https://fuxam.app/api/v4/certificates?courseId=string&userId=string"
Response
{
  "data": {
    "courseId": "clx1234567890",
    "userId": "user_abc123",
    "completion": {
      "isComplete": true,
      "progressPercent": 100
    },
    "certificates": [
      {
        "id": "cm123cm456user_abc",
        "name": "Introduction to Biology",
        "studentName": "Jane Doe",
        "issuedAt": "2026-06-02T07:00:00.000Z",
        "publicUrl": "https://fuxam.app/en/certificate/cm123cm456user_abc"
      }
    ]
  },
  "meta": {
    "requestId": "req_1234567890_abc",
    "timestamp": "2026-06-02T07:00:00.000Z",
    "version": "v4"
  }
}