Records API: Achievements

Retrieves one specific achievement

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

achievementstring · uuidRequired

Responses

404

Not Found

application/jsontext/json

Typestring · nullableOptional

Titlestring · nullableOptional

Statusinteger · int32 · nullableOptional

Detailstring · nullableOptional

Instancestring · nullableOptional

Other propertiesanyOptional

get

/api/records/achievements/{achievement}

HTTPcURLJavaScriptPython

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

404

Not Found

{
  "Type": "text",
  "Title": "text",
  "Status": 1,
  "Detail": "text",
  "Instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Checks for the existence of one specific achievement

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

achievementstring · uuidRequired

Responses

200

OK

404

Not Found

application/jsontext/json

Typestring · nullableOptional

Titlestring · nullableOptional

Statusinteger · int32 · nullableOptional

Detailstring · nullableOptional

Instancestring · nullableOptional

Other propertiesanyOptional

head

/api/records/achievements/{achievement}

HTTPcURLJavaScriptPython

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

No content

Collects the list of achievements that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

AchievementTitlestring · nullableOptional

ExpirationFixedDateSincestring · date-time · nullableOptional

ExpirationFixedDateBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/records/achievements/collect

HTTPcURLJavaScriptPython

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

{
  "AchievementTitle": "text",
  "ExpirationFixedDateSince": "2026-05-09T15:29:57.337Z",
  "ExpirationFixedDateBefore": "2026-05-09T15:29:57.337Z"
}

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

200

OK

[
  {
    "AchievementId": "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-05-09T15:29:57.337Z"
  }
]

Counts the achievements that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

AchievementTitlestring · nullableOptional

ExpirationFixedDateSincestring · date-time · nullableOptional

ExpirationFixedDateBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/records/achievements/count

HTTPcURLJavaScriptPython

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

{
  "AchievementTitle": "text",
  "ExpirationFixedDateSince": "2026-05-09T15:29:57.337Z",
  "ExpirationFixedDateBefore": "2026-05-09T15:29:57.337Z"
}

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

AchievementTitlestring · nullableOptional

ExpirationFixedDateSincestring · date-time · nullableOptional

ExpirationFixedDateBeforestring · date-time · nullableOptional

Responses

200

OK

post

/api/records/achievements/download

HTTPcURLJavaScriptPython

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

{
  "AchievementTitle": "text",
  "ExpirationFixedDateSince": "2026-05-09T15:29:57.337Z",
  "ExpirationFixedDateBefore": "2026-05-09T15:29:57.337Z"
}

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

AchievementTitlestring · nullableOptional

ExpirationFixedDateSincestring · date-time · nullableOptional

ExpirationFixedDateBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/records/achievements/search

HTTPcURLJavaScriptPython

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

{
  "AchievementTitle": "text",
  "ExpirationFixedDateSince": "2026-05-09T15:29:57.337Z",
  "ExpirationFixedDateBefore": "2026-05-09T15:29:57.337Z"
}

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

200

OK

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