AG5.com

List all achievements viewable for API user

get

/achievements

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/achievements' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "remark": "text",
      "lastModifiedAt": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "issueDate": "2025-03-12",
      "overriddenExpirationDate": "2025-03-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-03-12"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/achievements/{id}

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[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}$