List obtained certificates

GET$BEEDEEZ_API/v1/certificates

List obtained certificates

List the certificates obtained by the account's users, oldest change first.

A user renewing a certificate gets a new award; the previous ones stay listed with the revoked or expired status.

For an incremental sync, page with a cursor rather than pageNumber: pass the updatedAt and id of the last row received as updatedSince and afterId, until a page comes back empty. An award reaching its expiresAt date is not updated, so compute expiry from expiresAt on your side. Requires the admin or certificates:read scope.

Query Parameters
`userId` string Only the certificates of this user
`certificateId` string Only the awards of this certificate definition (`certificate.id`)
`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`. Only awards with this status
`obtainedAfter` string ISO date: obtained on or after this date
`obtainedBefore` string ISO date: obtained on or before this date
`updatedSince` string ISO date: only awards changed since this date
`afterId` string Cursor, with `updatedSince`: the `id` of the last award received
`pageSize` string Number of awards per page, 1 to 500
`pageNumber` string Page number, starting at 1. Not combinable with `afterId`

Responses

200

Schema — OPTIONAL

object[]

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 query parameters

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

Authorization

AuthorizationBearer access tokenadmin scopecertificates:read scopeHow to get one

Query parameters

userIdstringoptional

Only the certificates of this user

certificateIdstringoptional

Only the awards of this certificate definition (certificate.id)

statusstringoptional

Only awards with this status

activeexpiredrevoked

obtainedAfterstringoptional

ISO date: obtained on or after this date

obtainedBeforestringoptional

ISO date: obtained on or before this date

updatedSincestringoptional

ISO date: only awards changed since this date

afterIdstringoptional

Cursor, with updatedSince: the id of the last award received

pageSizestringoptional

Number of awards per page, 1 to 500

pageNumberstringoptional

Page number, starting at 1. Not combinable with afterId

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 query parameters