Progress API: Achievements

Retrieves one specific achievement

get
Authorizations
BearerstringRequired
Path parameters
achievementstring · uuidRequired
Responses
chevron-right
200

OK

get
/api/progress/achievements/{achievement}
200

OK

Checks for the existence of one specific achievement

head
Authorizations
BearerstringRequired
Path parameters
achievementstring · uuidRequired
Responses
chevron-right
200

OK

Responseboolean
head
/api/progress/achievements/{achievement}
200

OK

Collects the list of achievements that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · 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
chevron-right
200

OK

post
/api/progress/achievements/collect
200

OK

Counts the achievements that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · 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
chevron-right
200

OK

post
/api/progress/achievements/count
200

OK

Downloads the list of achievements that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · 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
chevron-right
200

OK

No content

post
/api/progress/achievements/download
200

OK

No content

Searches for the list of achievements that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · 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
chevron-right
200

OK

post
/api/progress/achievements/search
200

OK

Last updated

Was this helpful?