GET
/
v1
/
issuer
/
credential-definitions
List issuer credential definitions
curl --request GET \
  --url https://sandbox.authbound.io/v1/issuer/credential-definitions \
  --header 'X-Authbound-Key: <api-key>'
{
  "object": "list",
  "data": [
    {
      "object": "<string>",
      "id": "pension_credential_v1",
      "credentialDefinitionId": "pension_credential_v1",
      "vct": "urn:vc:authbound:pension:1.0",
      "title": "Pension Credential",
      "claims": [
        {
          "name": "Pension.startDate",
          "path": [
            "Pension",
            "startDate"
          ],
          "mandatory": true,
          "displayName": "Start Date"
        }
      ],
      "aliases": [
        "<string>"
      ],
      "rendering": {
        "simple": {
          "text_color": "<string>",
          "background_color": "<string>"
        },
        "authbound_svg_template_preset": "<string>"
      },
      "metadata": {}
    }
  ]
}

Authorizations

X-Authbound-Key
string
header
required

Server-side secret key header. Format: sk_live_* (production) or sk_test_* (testing).

Query Parameters

lifecycle_status
enum<string>

Optional credential definition lifecycle filter.

Available options:
draft,
published,
archived
limit
integer
default:20

Customer-controlled deployments only. Most definitions to return; a page can hold fewer.

Required range: 1 <= x <= 100
cursor
string

Customer-controlled deployments only. The nextCursor of the previous page. A cursor that names no definition the Project can see returns 404.

Response

List of credential definitions

object
enum<string>
required
Available options:
list
data
object[]
required