Certificates

List certificates

List the organization's certificates, one row per issued certificate.

Required OAuth scope: certificates:read

get/v2/certificates/

Request

Base URL
https://api.skilljar.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/skilljar/apis/skilljar-api-v2/docs/v2/certificates/get.ts
A function with typed inputs. Its response is checked against the schema.

filter[domains]string nullable

Comma-separated domain names; matches any listed domain. Unknown names match nothing.

filter[status]'active' | 'expired' | 'all'

Expiry-state filter values for GET /v2/certificates.

Filter by expiry state: active (unexpired), expired, or all. Defaults to all.

filter[issued_gte]string date-time nullable

Return only certificates issued at or after this ISO 8601 timestamp.

filter[issued_lte]string date-time nullable

Return only certificates issued at or before this ISO 8601 timestamp.

filter[student.id]string nullable

Return only certificates for the student with this opaque id. Unknown ids match nothing.

filter[course.id]string nullable

Return only certificates for the course with this opaque id. Unknown ids match nothing.

page[size]integer

Maximum number of records to return.

page[cursor]string nullable

Opaque cursor from the previous page's links.next.

metaobject nullable

Pagination metadata, e.g. {"page_size": 25}.

includedobject[] nullable

Related resources requested via ?include=. Absent when no include was requested.