Skip to main content
Issued credentials

List issued credentials

GET/v4/config/ows/issuer/issuance-history/{credentialExchangeId}/credentials

Lists the credentials that the issuer signed for an issuance history: the first issue, each re-issuance (a new version) and each copy of a batch. The order is newest first (the highest version, then the highest copy). Use event to get only the first issue or only the re-issuances. The items have no token: read the token of one credential with Read issued credential. To read the next page, send the nextCursor of the answer as cursor.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:issuances:read

Path parameters

  • credentialExchangeIdstringrequired

    The credential exchange id of the issuance history, from issuanceHistory[].credentialExchangeId of Issue credential, from List issuance history, or from an issuer event.

Query parameters

  • limitinteger

    The most items in the page: 1 to 100, default 20. Another value gives HTTP 400.

    From 1 to 100.

    Default:20

  • cursorstring

    The nextCursor of the page before, to read the next page. Leave it out for the first page. Use it as it is: a changed cursor gives HTTP 400. Do not send it with offset (HTTP 400).

  • offsetinteger

    How many items come before the page: 0 to 10000. Use it only to jump to a page of a pager, then continue with the nextCursor of the answer. Do not send it with cursor (HTTP 400). Another value gives HTTP 400.

    From 0 to 10000.

  • includeTotalboolean

    true: the answer also has total and totalCapped, the number of items of the filtered list. Send it on the first page only, for a pager. Default false. Another value gives HTTP 400.

    Default:false

  • eventenum<string>

    issued: only the credentials of the first issue. reissued: only the re-issuances. Without it, all. Another value gives HTTP 400.

    Available options:issued,reissued

Response

application/json

One page of the issued credentials.

  • itemsobject[]
  • nextCursorstring | null

    The cursor of the next page, or null on the last page.

  • totalinteger

    The number of items of the filtered list, at most 10000. Only with includeTotal=true. When the list has more items, the value is 10000 and totalCapped is true.

    From 0 to 10000.

    Example:137

  • totalCappedboolean

    true when the filtered list has more than 10000 items: total then shows 10000. Only with includeTotal=true.

    Example:false