Skip to main content
GET
/
api
/
public
/
v1
/
training
/
certificates
List certificates
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/training/certificates \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "enrollmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "certificateNumber": "<string>",
      "verificationCode": "<string>",
      "issuedAt": "2023-11-07T05:31:56Z",
      "expiresAt": "2023-11-07T05:31:56Z",
      "certificateUrl": "<string>",
      "imageUrl": "<string>",
      "isRevoked": true,
      "revokedAt": "2023-11-07T05:31:56Z",
      "revokedReason": "<string>",
      "course": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>"
      },
      "user": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "fullName": "<string>"
      }
    }
  ],
  "pagination": {
    "page": 2,
    "limit": 50,
    "totalCount": 123,
    "totalPages": 123,
    "hasNextPage": true,
    "hasPrevPage": true
  }
}

Authorizations

​
Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

​
page
number
default:1

Page number

Required range: x >= 1
​
limit
number
default:25

Items per page

Required range: 1 <= x <= 100
​
userId
string<uuid>

Filter by user ID

​
courseId
string<uuid>

Filter by course ID

​
includeRevoked
boolean | null
default:false

Include revoked certificates

Response

List of certificates

​
data
object[]
required

Array of certificates

​
pagination
object
required