GET
/
v1-alpha1
/
credentials
/
types
/
{typeName}
Get a Credential Type
curl --request GET \
  --url https://staging.crossmint.com/api/v1-alpha1/credentials/types/{typeName} \
  --header 'X-API-KEY: <api-key>'
{
  "id": "crossmint:bfb292e7-2700-4924-9213-478f3d71f2d8:CourseCompletionCertificate",
  "typeSchema": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "title": "Course completion",
    "description": "Describes the course completed and the assigned grade",
    "type": "object",
    "properties": {
      "credentialSubject": {
        "type": "object",
        "properties": {
          "course": {
            "type": "string"
          },
          "grade": {
            "type": "string"
          },
          "id": {
            "type": "string"
          }
        },
        "required": [
          "course",
          "grade"
        ],
        "additionalProperties": false
      }
    },
    "$id": "https://staging.crossmint.com/api/v1-alpha1/credentials/types/crossmint:bfb292e7-2700-4924-9213-478f3d71f2d8:CourseCompletionCertificate"
  }
}
This is an alpha API and subject to change.

Authorizations

​
X-API-KEY
string
header
required

Key obtained from the Crossmint developer console, reflecting the API scope granted.

Path Parameters

​
typeName
string
required

The name of the type or the type's id.

Response

200
application/json

Success.

The response is of type object.