Get an obtained certificate

GET$BEEDEEZ_API/v1/certificates/{CERTIFICATE_ID}

Get an obtained certificate

Get one obtained certificate by its award id (id in the list). Requires the admin or certificates:read scope.

Path Parameters
`CERTIFICATE_ID` string — REQUIRED

Responses

200

Schema — OPTIONAL

updatedAt date-time — OPTIONAL

Last change of the award itself; reaching expiresAt does not update it

correctAnswersRate double — OPTIONAL

successRate double — OPTIONAL

score double — OPTIONAL

expiresAt date-time — OPTIONAL

obtainedAt date-time — OPTIONAL

user object

externalId string

login string

email string

id string

certificate object

ruleType string

name string

Certificate name at the time it was obtained

id string

Certificate definition id, usable as the certificateId filter

status string

Possible values: [active, expired, revoked]

Derived from the awarded record: expired once expiresAt is reached, otherwise revoked when the award was disabled (revoked, superseded by a renewal or deduplicated), otherwise active.

id string

Awarded certificate id

400

Invalid certificate ID

Schema — OPTIONAL
`statusCode` double
`kind` string
`message` string

404

Certificate not found

Schema — OPTIONAL
`statusCode` double
`kind` string
`message` string

Authorization

AuthorizationBearer access tokenadmin scopecertificates:read scopeHow to get one

Path parameters

CERTIFICATE_IDstringrequired

Response

200 OKobject

updatedAtdate-time

Last change of the award itself; reaching expiresAt does not update it

correctAnswersRatedouble

successRatedouble

scoredouble

expiresAtdate-time

obtainedAtdate-time

userobject

externalIdstring

loginstring

emailstring

idstring

certificateobject

ruleTypestring

namestring

Certificate name at the time it was obtained

idstring

Certificate definition id, usable as the certificateId filter

statusstring

Derived from the awarded record: expired once expiresAt is reached, otherwise revoked when the award was disabled (revoked, superseded by a renewal or deduplicated), otherwise active.

activeexpiredrevoked

idstring

Awarded certificate id

Errors

400Invalid certificate ID

404Certificate not found