Ctrlk
Shift iQ
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Records API: Achievements

Retrieves one specific achievement

get
Authorizations
BearerstringRequired
Path parameters
achievementstring · uuidRequired
Responses
200

OK

AchievementIdstring · uuidOptional
AchievementAllowSelfDeclaredbooleanOptional
AchievementIsEnabledbooleanOptional
AchievementReportingDisabledbooleanOptional
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
get/api/records/achievements/{achievement}
GET /v2/e01/api/records/achievements/{achievement} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

{
  "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-01-01T00:00:00.000Z"
}

Checks for the existence of one specific achievement

head
Authorizations
BearerstringRequired
Path parameters
achievementstring · uuidRequired
Responses
200

OK

No content
head/api/records/achievements/{achievement}
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
BearerstringRequired
Body
AchievementTitlestring · nullableOptional
ExpirationFixedDateSincestring · date-time · nullableOptional
ExpirationFixedDateBeforestring · date-time · nullableOptional
Responses
200

OK

AchievementIdstring · uuidOptional
AchievementAllowSelfDeclaredbooleanOptional
AchievementIsEnabledbooleanOptional
AchievementReportingDisabledbooleanOptional
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
post/api/records/achievements/collect
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-01-01T00:00:00.000Z",
  "ExpirationFixedDateBefore": "2026-01-01T00:00:00.000Z"
}
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-01-01T00:00:00.000Z"
  }
]

Counts the achievements that match specific criteria

post
Authorizations
BearerstringRequired
Body
AchievementTitlestring · nullableOptional
ExpirationFixedDateSincestring · date-time · nullableOptional
ExpirationFixedDateBeforestring · date-time · nullableOptional
Responses
200

OK

Countinteger · int32Optional
Summarystring · nullableOptional
post/api/records/achievements/count
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-01-01T00:00:00.000Z",
  "ExpirationFixedDateBefore": "2026-01-01T00:00:00.000Z"
}
200

OK

{
  "Count": 1,
  "Summary": "text"
}

Downloads the list of achievements that match specific criteria

post
Authorizations
BearerstringRequired
Body
AchievementTitlestring · nullableOptional
ExpirationFixedDateSincestring · date-time · nullableOptional
ExpirationFixedDateBeforestring · date-time · nullableOptional
Responses
200

OK

No content
post/api/records/achievements/download
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-01-01T00:00:00.000Z",
  "ExpirationFixedDateBefore": "2026-01-01T00:00:00.000Z"
}
200

OK

No content

Searches for the list of achievements that match specific criteria

post
Authorizations
BearerstringRequired
Body
AchievementTitlestring · nullableOptional
ExpirationFixedDateSincestring · date-time · nullableOptional
ExpirationFixedDateBeforestring · date-time · nullableOptional
Responses
200

OK

AchievementIdstring · uuidOptional
AchievementTitlestring · nullableOptional
post/api/records/achievements/search
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-01-01T00:00:00.000Z",
  "ExpirationFixedDateBefore": "2026-01-01T00:00:00.000Z"
}
200

OK

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

Last updated

Was this helpful?