Shift iQCMDS

Progress: Achievements

get
Authorizations
Path parameters
achievementstring · uuidRequired
Responses
200
OK
application/json
get
GET /v2/E01/progress/achievements/{achievement} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
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-08-04T21:44:17.459Z"
}
head
Authorizations
Path parameters
achievementstring · uuidRequired
Responses
200
OK
application/json
Responseboolean
head
HEAD /v2/E01/progress/achievements/{achievement} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*
200

OK

true
get
Authorizations
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.PageSizeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Responses
200
OK
application/json
Responseinteger · int32
get
GET /v2/E01/progress/achievements/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*
200

OK

1
get
Authorizations
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.PageSizeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Responses
200
OK
application/json
get
GET /v2/E01/progress/achievements HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
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-08-04T21:44:17.459Z"
  }
]
Authorizations
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.PageSizeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Responses
200
OK
application/json
get
GET /v2/E01/progress/achievements/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "AchievementIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "AchievementTitle": "text"
  }
]
post
Authorizations
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
200
OK
application/json
post
POST /v2/E01/progress/achievements/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 888

{
  "Identifier": "123e4567-e89b-12d3-a456-426614174000",
  "Origin": {
    "When": "2025-08-04T21:44:17.459Z",
    "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"
  },
  "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-08-04T21:44:17.459Z"
}
200

OK

[
  {
    "AchievementIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "AchievementTitle": "text"
  }
]
PreviousPlatform: RoutesNextProgress: Gradebooks

Was this helpful?