Records 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

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

404

Not Found

application/jsontext/json

get/api/records/credentials/{credential}

HTTPcURLJavaScriptPython

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

{
  "AchievementId": "123e4567-e89b-12d3-a456-426614174000",
  "AuthorityId": "123e4567-e89b-12d3-a456-426614174000",
  "CredentialId": "123e4567-e89b-12d3-a456-426614174000",
  "EmployerGroupId": "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-08-10T15:51:17.911Z",
  "CredentialExpirationExpected": "2026-08-10T15:51:17.911Z",
  "CredentialExpirationReminderDelivered0": "2026-08-10T15:51:17.911Z",
  "CredentialExpirationReminderDelivered1": "2026-08-10T15:51:17.911Z",
  "CredentialExpirationReminderDelivered2": "2026-08-10T15:51:17.911Z",
  "CredentialExpirationReminderDelivered3": "2026-08-10T15:51:17.911Z",
  "CredentialExpirationReminderRequested0": "2026-08-10T15:51:17.911Z",
  "CredentialExpirationReminderRequested1": "2026-08-10T15:51:17.911Z",
  "CredentialExpirationReminderRequested2": "2026-08-10T15:51:17.911Z",
  "CredentialExpirationReminderRequested3": "2026-08-10T15:51:17.911Z",
  "CredentialExpired": "2026-08-10T15:51:17.911Z",
  "CredentialGranted": "2026-08-10T15:51:17.911Z",
  "CredentialRevoked": "2026-08-10T15:51:17.911Z",
  "ExpirationFixedDate": "2026-08-10T15:51:17.911Z"
}

Checks for the existence of one specific credential

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

credentialstring · uuidRequired

Responses

200

OK

No content

404

Not Found

application/jsontext/json

head/api/records/credentials/{credential}

HTTPcURLJavaScriptPython

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

No content

Collects the list of credentials that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

AchievementIdstring · uuid · nullableOptional

UserIdstring · uuid · nullableOptional

ModifiedFromstring · date-time · nullableOptional

ModifiedBeforestring · date-time · nullableOptional

PersonCodestring · nullableOptional

Responses

200

OK

application/jsontext/json

AchievementIdstring · uuidOptional

AuthorityIdstring · uuid · nullableOptional

CredentialIdstring · uuidOptional

EmployerGroupIdstring · uuid · nullableOptional

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/records/credentials/collect

HTTPcURLJavaScriptPython

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

{
  "AchievementId": "123e4567-e89b-12d3-a456-426614174000",
  "UserId": "123e4567-e89b-12d3-a456-426614174000",
  "ModifiedFrom": "2026-08-10T15:51:17.911Z",
  "ModifiedBefore": "2026-08-10T15:51:17.911Z",
  "PersonCode": "text"
}

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",
    "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-08-10T15:51:17.911Z",
    "CredentialExpirationExpected": "2026-08-10T15:51:17.911Z",
    "CredentialExpirationReminderDelivered0": "2026-08-10T15:51:17.911Z",
    "CredentialExpirationReminderDelivered1": "2026-08-10T15:51:17.911Z",
    "CredentialExpirationReminderDelivered2": "2026-08-10T15:51:17.911Z",
    "CredentialExpirationReminderDelivered3": "2026-08-10T15:51:17.911Z",
    "CredentialExpirationReminderRequested0": "2026-08-10T15:51:17.911Z",
    "CredentialExpirationReminderRequested1": "2026-08-10T15:51:17.911Z",
    "CredentialExpirationReminderRequested2": "2026-08-10T15:51:17.911Z",
    "CredentialExpirationReminderRequested3": "2026-08-10T15:51:17.911Z",
    "CredentialExpired": "2026-08-10T15:51:17.911Z",
    "CredentialGranted": "2026-08-10T15:51:17.911Z",
    "CredentialRevoked": "2026-08-10T15:51:17.911Z",
    "ExpirationFixedDate": "2026-08-10T15:51:17.911Z"
  }
]

Counts the credentials that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

AchievementIdstring · uuid · nullableOptional

UserIdstring · uuid · nullableOptional

ModifiedFromstring · date-time · nullableOptional

ModifiedBeforestring · date-time · nullableOptional

PersonCodestring · nullableOptional

Responses

200

OK

application/jsontext/json

Countinteger · int32Optional

Summarystring · nullableOptional

post/api/records/credentials/count

HTTPcURLJavaScriptPython

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

{
  "AchievementId": "123e4567-e89b-12d3-a456-426614174000",
  "UserId": "123e4567-e89b-12d3-a456-426614174000",
  "ModifiedFrom": "2026-08-10T15:51:17.911Z",
  "ModifiedBefore": "2026-08-10T15:51:17.911Z",
  "PersonCode": "text"
}

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

AchievementIdstring · uuid · nullableOptional

UserIdstring · uuid · nullableOptional

ModifiedFromstring · date-time · nullableOptional

ModifiedBeforestring · date-time · nullableOptional

PersonCodestring · nullableOptional

Responses

200

OK

No content

post/api/records/credentials/download

HTTPcURLJavaScriptPython

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

{
  "AchievementId": "123e4567-e89b-12d3-a456-426614174000",
  "UserId": "123e4567-e89b-12d3-a456-426614174000",
  "ModifiedFrom": "2026-08-10T15:51:17.911Z",
  "ModifiedBefore": "2026-08-10T15:51:17.911Z",
  "PersonCode": "text"
}

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

AchievementIdstring · uuid · nullableOptional

UserIdstring · uuid · nullableOptional

ModifiedFromstring · date-time · nullableOptional

ModifiedBeforestring · date-time · nullableOptional

PersonCodestring · nullableOptional

Responses

200

OK

application/jsontext/json

AchievementIdstring · uuidOptional

CredentialIdstring · uuidOptional

UserIdstring · uuidOptional

CredentialIssuedstring · date-time · nullableOptional

CredentialStatusstring · nullableOptional

CredentialNecessitystring · nullableOptional

CredentialIsRequiredbooleanOptional

AchievementLabelstring · nullableOptional

AchievementTitlestring · nullableOptional

PersonCodestring · nullableOptional

AchievementEffectiveDatestring · date-time · nullableOptional

AchievementExpiryDatestring · date-time · nullableOptional

AchievementValidbooleanOptional

post/api/records/credentials/search

HTTPcURLJavaScriptPython

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

{
  "AchievementId": "123e4567-e89b-12d3-a456-426614174000",
  "UserId": "123e4567-e89b-12d3-a456-426614174000",
  "ModifiedFrom": "2026-08-10T15:51:17.911Z",
  "ModifiedBefore": "2026-08-10T15:51:17.911Z",
  "PersonCode": "text"
}

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

200

OK

[
  {
    "AchievementId": "123e4567-e89b-12d3-a456-426614174000",
    "CredentialId": "123e4567-e89b-12d3-a456-426614174000",
    "UserId": "123e4567-e89b-12d3-a456-426614174000",
    "CredentialIssued": "2026-08-10T15:51:17.911Z",
    "CredentialStatus": "text",
    "CredentialNecessity": "text",
    "CredentialIsRequired": true,
    "AchievementLabel": "text",
    "AchievementTitle": "text",
    "PersonCode": "text",
    "AchievementEffectiveDate": "2026-08-10T15:51:17.911Z",
    "AchievementExpiryDate": "2026-08-10T15:51:17.911Z",
    "AchievementValid": true
  }
]