Progress API: Credentials

Retrieves one specific credential

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

credentialstring · uuidRequired

Responses

200

OK

application/jsontext/json

achievementIdstring · uuidOptional

authorityIdstring · uuid · nullableOptional

credentialIdstring · uuidOptional

employerGroupIdstring · uuid · nullableOptional

organizationIdstring · uuidOptional

userIdstring · uuidOptional

afterExpiryNotificationSentbooleanOptional

beforeExpiryNotificationSentbooleanOptional

authorityLocationstring · nullableOptional

authorityNamestring · nullableOptional

authorityReferencestring · nullableOptional

authorityTypestring · nullableOptional

credentialDescriptionstring · nullableOptional

credentialGrantedDescriptionstring · nullableOptional

credentialNecessitystring · nullableOptional

credentialPrioritystring · nullableOptional

credentialReminderTypestring · nullableOptional

credentialRevokedReasonstring · nullableOptional

credentialStatusstring · nullableOptional

employerGroupStatusstring · nullableOptional

expirationLifetimeUnitstring · nullableOptional

expirationTypestring · nullableOptional

publisherAddressstring · nullableOptional

transactionHashstring · nullableOptional

expirationLifetimeQuantityinteger · int32 · nullableOptional

publicationStatusinteger · int32 · nullableOptional

credentialGrantedScorenumber · double · nullableOptional

credentialHoursnumber · double · nullableOptional

credentialRevokedScorenumber · double · nullableOptional

credentialAssignedstring · date-time · nullableOptional

credentialExpirationExpectedstring · date-time · nullableOptional

credentialExpirationReminderDelivered0string · date-time · nullableOptional

credentialExpirationReminderDelivered1string · date-time · nullableOptional

credentialExpirationReminderDelivered2string · date-time · nullableOptional

credentialExpirationReminderDelivered3string · date-time · nullableOptional

credentialExpirationReminderRequested0string · date-time · nullableOptional

credentialExpirationReminderRequested1string · date-time · nullableOptional

credentialExpirationReminderRequested2string · date-time · nullableOptional

credentialExpirationReminderRequested3string · date-time · nullableOptional

credentialExpiredstring · date-time · nullableOptional

credentialGrantedstring · date-time · nullableOptional

credentialRevokedstring · date-time · nullableOptional

expirationFixedDatestring · date-time · nullableOptional

get

/api/progress/credentials/{credential}

HTTPcURLJavaScriptPython

GET /v2/e01/api/progress/credentials/{credential} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "achievementId": "123e4567-e89b-12d3-a456-426614174000",
  "authorityId": "123e4567-e89b-12d3-a456-426614174000",
  "credentialId": "123e4567-e89b-12d3-a456-426614174000",
  "employerGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "afterExpiryNotificationSent": true,
  "beforeExpiryNotificationSent": true,
  "authorityLocation": "text",
  "authorityName": "text",
  "authorityReference": "text",
  "authorityType": "text",
  "credentialDescription": "text",
  "credentialGrantedDescription": "text",
  "credentialNecessity": "text",
  "credentialPriority": "text",
  "credentialReminderType": "text",
  "credentialRevokedReason": "text",
  "credentialStatus": "text",
  "employerGroupStatus": "text",
  "expirationLifetimeUnit": "text",
  "expirationType": "text",
  "publisherAddress": "text",
  "transactionHash": "text",
  "expirationLifetimeQuantity": 1,
  "publicationStatus": 1,
  "credentialGrantedScore": 1,
  "credentialHours": 1,
  "credentialRevokedScore": 1,
  "credentialAssigned": "2026-03-06T20:00:55.537Z",
  "credentialExpirationExpected": "2026-03-06T20:00:55.537Z",
  "credentialExpirationReminderDelivered0": "2026-03-06T20:00:55.537Z",
  "credentialExpirationReminderDelivered1": "2026-03-06T20:00:55.537Z",
  "credentialExpirationReminderDelivered2": "2026-03-06T20:00:55.537Z",
  "credentialExpirationReminderDelivered3": "2026-03-06T20:00:55.537Z",
  "credentialExpirationReminderRequested0": "2026-03-06T20:00:55.537Z",
  "credentialExpirationReminderRequested1": "2026-03-06T20:00:55.537Z",
  "credentialExpirationReminderRequested2": "2026-03-06T20:00:55.537Z",
  "credentialExpirationReminderRequested3": "2026-03-06T20:00:55.537Z",
  "credentialExpired": "2026-03-06T20:00:55.537Z",
  "credentialGranted": "2026-03-06T20:00:55.537Z",
  "credentialRevoked": "2026-03-06T20:00:55.537Z",
  "expirationFixedDate": "2026-03-06T20:00:55.537Z"
}

Checks for the existence of one specific credential

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

credentialstring · uuidRequired

Responses

200

OK

application/jsontext/json

booleanOptional

head

/api/progress/credentials/{credential}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/progress/credentials/{credential} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of credentials that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

achievementIdstring · uuid · nullableOptional

learnerIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

Responses

200

OK

application/jsontext/json

achievementIdstring · uuidOptional

authorityIdstring · uuid · nullableOptional

credentialIdstring · uuidOptional

employerGroupIdstring · uuid · nullableOptional

organizationIdstring · uuidOptional

userIdstring · uuidOptional

afterExpiryNotificationSentbooleanOptional

beforeExpiryNotificationSentbooleanOptional

authorityLocationstring · nullableOptional

authorityNamestring · nullableOptional

authorityReferencestring · nullableOptional

authorityTypestring · nullableOptional

credentialDescriptionstring · nullableOptional

credentialGrantedDescriptionstring · nullableOptional

credentialNecessitystring · nullableOptional

credentialPrioritystring · nullableOptional

credentialReminderTypestring · nullableOptional

credentialRevokedReasonstring · nullableOptional

credentialStatusstring · nullableOptional

employerGroupStatusstring · nullableOptional

expirationLifetimeUnitstring · nullableOptional

expirationTypestring · nullableOptional

publisherAddressstring · nullableOptional

transactionHashstring · nullableOptional

expirationLifetimeQuantityinteger · int32 · nullableOptional

publicationStatusinteger · int32 · nullableOptional

credentialGrantedScorenumber · double · nullableOptional

credentialHoursnumber · double · nullableOptional

credentialRevokedScorenumber · double · nullableOptional

credentialAssignedstring · date-time · nullableOptional

credentialExpirationExpectedstring · date-time · nullableOptional

credentialExpirationReminderDelivered0string · date-time · nullableOptional

credentialExpirationReminderDelivered1string · date-time · nullableOptional

credentialExpirationReminderDelivered2string · date-time · nullableOptional

credentialExpirationReminderDelivered3string · date-time · nullableOptional

credentialExpirationReminderRequested0string · date-time · nullableOptional

credentialExpirationReminderRequested1string · date-time · nullableOptional

credentialExpirationReminderRequested2string · date-time · nullableOptional

credentialExpirationReminderRequested3string · date-time · nullableOptional

credentialExpiredstring · date-time · nullableOptional

credentialGrantedstring · date-time · nullableOptional

credentialRevokedstring · date-time · nullableOptional

expirationFixedDatestring · date-time · nullableOptional

post

/api/progress/credentials/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/progress/credentials/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 602

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-06T20:00:55.537Z",
    "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"
  },
  "achievementId": "123e4567-e89b-12d3-a456-426614174000",
  "learnerId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000"
}

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

200

OK

[
  {
    "achievementId": "123e4567-e89b-12d3-a456-426614174000",
    "authorityId": "123e4567-e89b-12d3-a456-426614174000",
    "credentialId": "123e4567-e89b-12d3-a456-426614174000",
    "employerGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "afterExpiryNotificationSent": true,
    "beforeExpiryNotificationSent": true,
    "authorityLocation": "text",
    "authorityName": "text",
    "authorityReference": "text",
    "authorityType": "text",
    "credentialDescription": "text",
    "credentialGrantedDescription": "text",
    "credentialNecessity": "text",
    "credentialPriority": "text",
    "credentialReminderType": "text",
    "credentialRevokedReason": "text",
    "credentialStatus": "text",
    "employerGroupStatus": "text",
    "expirationLifetimeUnit": "text",
    "expirationType": "text",
    "publisherAddress": "text",
    "transactionHash": "text",
    "expirationLifetimeQuantity": 1,
    "publicationStatus": 1,
    "credentialGrantedScore": 1,
    "credentialHours": 1,
    "credentialRevokedScore": 1,
    "credentialAssigned": "2026-03-06T20:00:55.537Z",
    "credentialExpirationExpected": "2026-03-06T20:00:55.537Z",
    "credentialExpirationReminderDelivered0": "2026-03-06T20:00:55.537Z",
    "credentialExpirationReminderDelivered1": "2026-03-06T20:00:55.537Z",
    "credentialExpirationReminderDelivered2": "2026-03-06T20:00:55.537Z",
    "credentialExpirationReminderDelivered3": "2026-03-06T20:00:55.537Z",
    "credentialExpirationReminderRequested0": "2026-03-06T20:00:55.537Z",
    "credentialExpirationReminderRequested1": "2026-03-06T20:00:55.537Z",
    "credentialExpirationReminderRequested2": "2026-03-06T20:00:55.537Z",
    "credentialExpirationReminderRequested3": "2026-03-06T20:00:55.537Z",
    "credentialExpired": "2026-03-06T20:00:55.537Z",
    "credentialGranted": "2026-03-06T20:00:55.537Z",
    "credentialRevoked": "2026-03-06T20:00:55.537Z",
    "expirationFixedDate": "2026-03-06T20:00:55.537Z"
  }
]

Counts the credentials that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

achievementIdstring · uuid · nullableOptional

learnerIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

Responses

200

OK

application/jsontext/json

countinteger · int32Optional

summarystring · nullableOptional

post

/api/progress/credentials/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/progress/credentials/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 602

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-06T20:00:55.537Z",
    "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"
  },
  "achievementId": "123e4567-e89b-12d3-a456-426614174000",
  "learnerId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000"
}

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

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of credentials that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

achievementIdstring · uuid · nullableOptional

learnerIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

Responses

200

OK

No content

post

/api/progress/credentials/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/progress/credentials/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 602

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-06T20:00:55.537Z",
    "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"
  },
  "achievementId": "123e4567-e89b-12d3-a456-426614174000",
  "learnerId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000"
}

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

200

OK

No content

Searches for the list of credentials that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

achievementIdstring · uuid · nullableOptional

learnerIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

Responses

200

OK

application/jsontext/json

achievementIdstring · uuidOptional

credentialIdstring · uuidOptional

learnerIdstring · uuidOptional

credentialIssuedstring · date-time · nullableOptional

credentialStatusstring · nullableOptional

credentialNecessitystring · nullableOptional

credentialIsRequiredbooleanOptional

post

/api/progress/credentials/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/progress/credentials/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 602

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-06T20:00:55.537Z",
    "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"
  },
  "achievementId": "123e4567-e89b-12d3-a456-426614174000",
  "learnerId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000"
}

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

200

OK

[
  {
    "achievementId": "123e4567-e89b-12d3-a456-426614174000",
    "credentialId": "123e4567-e89b-12d3-a456-426614174000",
    "learnerId": "123e4567-e89b-12d3-a456-426614174000",
    "credentialIssued": "2026-03-06T20:00:55.537Z",
    "credentialStatus": "text",
    "credentialNecessity": "text",
    "credentialIsRequired": true
  }
]