Progress: Achievements

get

Path parameters

achievementstring · uuidRequired

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/e01/progress/achievements/{achievement} HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "AchievementIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "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": "2025-07-16T20:24:42.363Z"
}

head

Path parameters

achievementstring · uuidRequired

Responses

200

OK

application/json

Responseboolean

head

HTTPcURLJavaScriptPython

HEAD /v2/e01/progress/achievements/{achievement} HTTP/1.1
Host: 
Accept: */*

200

OK

true

get

Query parameters

OrganizationIdentifierstring · uuidOptional

AchievementIsEnabledbooleanOptional

AchievementReportingDisabledbooleanOptional

HasBadgeImagebooleanOptional

AchievementDescriptionstringOptional

AchievementLabelstringOptional

AchievementTitlestringOptional

AchievementTypestringOptional

BadgeImageUrlstringOptional

CertificateLayoutCodestringOptional

ExpirationLifetimeUnitstringOptional

ExpirationTypestringOptional

ExpirationLifetimeQuantityinteger · int32Optional

ExpirationFixedDatestring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.Takeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/e01/progress/achievements/count HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "Count": 1
}

get

Query parameters

OrganizationIdentifierstring · uuidOptional

AchievementIsEnabledbooleanOptional

AchievementReportingDisabledbooleanOptional

HasBadgeImagebooleanOptional

AchievementDescriptionstringOptional

AchievementLabelstringOptional

AchievementTitlestringOptional

AchievementTypestringOptional

BadgeImageUrlstringOptional

CertificateLayoutCodestringOptional

ExpirationLifetimeUnitstringOptional

ExpirationTypestringOptional

ExpirationLifetimeQuantityinteger · int32Optional

ExpirationFixedDatestring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.Takeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Pageinteger · int32Optional

Takeinteger · int32Optional

SortstringOptional

ExcludesstringOptional

IncludesstringOptional

FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/e01/progress/achievements HTTP/1.1
Host: 
Accept: */*

200

OK

[
  {
    "AchievementIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "OrganizationIdentifier": "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": "2025-07-16T20:24:42.363Z"
  }
]

get

Query parameters

OrganizationIdentifierstring · uuidOptional

AchievementIsEnabledbooleanOptional

AchievementReportingDisabledbooleanOptional

HasBadgeImagebooleanOptional

AchievementDescriptionstringOptional

AchievementLabelstringOptional

AchievementTitlestringOptional

AchievementTypestringOptional

BadgeImageUrlstringOptional

CertificateLayoutCodestringOptional

ExpirationLifetimeUnitstringOptional

ExpirationTypestringOptional

ExpirationLifetimeQuantityinteger · int32Optional

ExpirationFixedDatestring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.Takeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Pageinteger · int32Optional

Takeinteger · int32Optional

SortstringOptional

ExcludesstringOptional

IncludesstringOptional

FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/e01/progress/achievements/search HTTP/1.1
Host: 
Accept: */*

200

OK

[
  {
    "AchievementIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]