Progress API: Achievements

Retrieves one specific achievement

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

achievementstring · uuidRequired

Responses

200

OK

application/jsontext/json

get

/api/progress/achievements/{achievement}

HTTPcURLJavaScriptPython

GET /v2/e01/api/progress/achievements/{achievement} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "achievementId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "achievementAllowSelfDeclared": true,
  "achievementIsEnabled": true,
  "achievementReportingDisabled": true,
  "hasBadgeImage": true,
  "achievementDescription": "text",
  "achievementLabel": "text",
  "achievementTitle": "text",
  "achievementType": "text",
  "badgeImageUrl": "text",
  "certificateLayoutCode": "text",
  "expirationLifetimeUnit": "text",
  "expirationType": "text",
  "expirationLifetimeQuantity": 1,
  "expirationFixedDate": "2026-01-29T16:06:18.583Z"
}

Checks for the existence of one specific achievement

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

achievementstring · uuidRequired

Responses

200

OK

application/jsontext/json

head

/api/progress/achievements/{achievement}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/progress/achievements/{achievement} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of achievements that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

achievementIsEnabledboolean · nullableOptional

achievementReportingDisabledboolean · nullableOptional

hasBadgeImageboolean · nullableOptional

achievementDescriptionstring · nullableOptional

achievementLabelstring · nullableOptional

achievementTitlestring · nullableOptional

achievementTypestring · nullableOptional

badgeImageUrlstring · nullableOptional

certificateLayoutCodestring · nullableOptional

expirationLifetimeUnitstring · nullableOptional

expirationTypestring · nullableOptional

expirationLifetimeQuantityinteger · int32 · nullableOptional

expirationFixedDatestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/progress/achievements/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/progress/achievements/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 880

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T16:06:18.583Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "achievementIsEnabled": true,
  "achievementReportingDisabled": true,
  "hasBadgeImage": true,
  "achievementDescription": "text",
  "achievementLabel": "text",
  "achievementTitle": "text",
  "achievementType": "text",
  "badgeImageUrl": "text",
  "certificateLayoutCode": "text",
  "expirationLifetimeUnit": "text",
  "expirationType": "text",
  "expirationLifetimeQuantity": 1,
  "expirationFixedDate": "2026-01-29T16:06:18.583Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "achievementId": "123e4567-e89b-12d3-a456-426614174000",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "achievementAllowSelfDeclared": true,
    "achievementIsEnabled": true,
    "achievementReportingDisabled": true,
    "hasBadgeImage": true,
    "achievementDescription": "text",
    "achievementLabel": "text",
    "achievementTitle": "text",
    "achievementType": "text",
    "badgeImageUrl": "text",
    "certificateLayoutCode": "text",
    "expirationLifetimeUnit": "text",
    "expirationType": "text",
    "expirationLifetimeQuantity": 1,
    "expirationFixedDate": "2026-01-29T16:06:18.583Z"
  }
]

Counts the achievements that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

achievementIsEnabledboolean · nullableOptional

achievementReportingDisabledboolean · nullableOptional

hasBadgeImageboolean · nullableOptional

achievementDescriptionstring · nullableOptional

achievementLabelstring · nullableOptional

achievementTitlestring · nullableOptional

achievementTypestring · nullableOptional

badgeImageUrlstring · nullableOptional

certificateLayoutCodestring · nullableOptional

expirationLifetimeUnitstring · nullableOptional

expirationTypestring · nullableOptional

expirationLifetimeQuantityinteger · int32 · nullableOptional

expirationFixedDatestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/progress/achievements/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/progress/achievements/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 880

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T16:06:18.583Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "achievementIsEnabled": true,
  "achievementReportingDisabled": true,
  "hasBadgeImage": true,
  "achievementDescription": "text",
  "achievementLabel": "text",
  "achievementTitle": "text",
  "achievementType": "text",
  "badgeImageUrl": "text",
  "certificateLayoutCode": "text",
  "expirationLifetimeUnit": "text",
  "expirationType": "text",
  "expirationLifetimeQuantity": 1,
  "expirationFixedDate": "2026-01-29T16:06:18.583Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of achievements that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

achievementIsEnabledboolean · nullableOptional

achievementReportingDisabledboolean · nullableOptional

hasBadgeImageboolean · nullableOptional

achievementDescriptionstring · nullableOptional

achievementLabelstring · nullableOptional

achievementTitlestring · nullableOptional

achievementTypestring · nullableOptional

badgeImageUrlstring · nullableOptional

certificateLayoutCodestring · nullableOptional

expirationLifetimeUnitstring · nullableOptional

expirationTypestring · nullableOptional

expirationLifetimeQuantityinteger · int32 · nullableOptional

expirationFixedDatestring · date-time · nullableOptional

Responses

200

OK

post

/api/progress/achievements/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/progress/achievements/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 880

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T16:06:18.583Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "achievementIsEnabled": true,
  "achievementReportingDisabled": true,
  "hasBadgeImage": true,
  "achievementDescription": "text",
  "achievementLabel": "text",
  "achievementTitle": "text",
  "achievementType": "text",
  "badgeImageUrl": "text",
  "certificateLayoutCode": "text",
  "expirationLifetimeUnit": "text",
  "expirationType": "text",
  "expirationLifetimeQuantity": 1,
  "expirationFixedDate": "2026-01-29T16:06:18.583Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of achievements that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

achievementIsEnabledboolean · nullableOptional

achievementReportingDisabledboolean · nullableOptional

hasBadgeImageboolean · nullableOptional

achievementDescriptionstring · nullableOptional

achievementLabelstring · nullableOptional

achievementTitlestring · nullableOptional

achievementTypestring · nullableOptional

badgeImageUrlstring · nullableOptional

certificateLayoutCodestring · nullableOptional

expirationLifetimeUnitstring · nullableOptional

expirationTypestring · nullableOptional

expirationLifetimeQuantityinteger · int32 · nullableOptional

expirationFixedDatestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/progress/achievements/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/progress/achievements/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 880

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T16:06:18.583Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "achievementIsEnabled": true,
  "achievementReportingDisabled": true,
  "hasBadgeImage": true,
  "achievementDescription": "text",
  "achievementLabel": "text",
  "achievementTitle": "text",
  "achievementType": "text",
  "badgeImageUrl": "text",
  "certificateLayoutCode": "text",
  "expirationLifetimeUnit": "text",
  "expirationType": "text",
  "expirationLifetimeQuantity": 1,
  "expirationFixedDate": "2026-01-29T16:06:18.583Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "achievementId": "123e4567-e89b-12d3-a456-426614174000",
    "achievementTitle": "text"
  }
]