Achievements

List all achievements viewable for API user

get

Authorizations

Query parameters

pageTokenstringOptional

limitinteger · int32Optional

sinceDeltaTokenstringOptional

fieldsstring[]Optional

Responses

200

Successful request

application/json

get

HTTPcURLJavaScriptPython

GET /achievements HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful request

{
  "results": [
    {
      "remark": "text",
      "lastModifiedAt": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "issueDate": "2025-06-12",
      "overriddenExpirationDate": "2025-06-12",
      "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
      "evidenceVariantID": "550e8400-e29b-41d4-a716-446655440000",
      "externalId": "text",
      "documents": [
        {
          "contentType": "text",
          "filename": "text"
        }
      ],
      "externalCode": "text",
      "scoreOrder": 1,
      "submittedByID": "550e8400-e29b-41d4-a716-446655440000",
      "approvedByID": "550e8400-e29b-41d4-a716-446655440000",
      "isAutoAchieved": true,
      "createdAt": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000",
      "expirationDate": "2025-06-12"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

get

Authorizations

Path parameters

idstring · hexadecimal-integerRequiredExample: 550e8400-e29b-41d4-a716-446655440000Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Responses

200

Successful request

application/json

get

HTTPcURLJavaScriptPython

GET /achievements/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful request

{
  "remark": "text",
  "lastModifiedAt": "text",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "issueDate": "2025-06-12",
  "overriddenExpirationDate": "2025-06-12",
  "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
  "evidenceVariantID": "550e8400-e29b-41d4-a716-446655440000",
  "externalId": "text",
  "documents": [
    {
      "contentType": "text",
      "filename": "text"
    }
  ],
  "externalCode": "text",
  "scoreOrder": 1,
  "submittedByID": "550e8400-e29b-41d4-a716-446655440000",
  "approvedByID": "550e8400-e29b-41d4-a716-446655440000",
  "isAutoAchieved": true,
  "createdAt": "text",
  "employmentID": "550e8400-e29b-41d4-a716-446655440000",
  "expirationDate": "2025-06-12"
}