/v1/schemas/{slug}
Public
Paginated
Get schema details
Get detailed information about a specific credential schema by its slug.
Includes the full schema definition, claim fields, and related schemas.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
slug
*
|
path | string | Schema slug (URL-friendly identifier) |
* Required parameter
Response
Content-Type: application/json
success
boolean
data
object
A template defining the structure of a credential
slug
string
URL-friendly identifier (lowercase, hyphenated)
Example: university-degree
name
string
Human-readable name of the schema
Example: University Degree
description
string
Detailed description of what this credential type represents
Example: A credential representing an academic degree from a university
credential_type
string
Credential type identifier (e.g., PascalCase or standard like mDL)
Example: UniversityDegreeCredential
category
string
Category for organizing schemas
Example: education
visibility
string
Schema visibility: - public: Listed in the public schema catalog for anyone to use - private: Only visible to the owning issuer organization
Allowed values: "public", "private"
Example: public
claims
array[object]
List of claim fields defined in this schema
Array items:
name
string
Claim field name
Example: degree
type
string
Data type of the claim: - string: Text value - integer: Whole number - boolean: True/false value - date: Date only (YYYY-MM-DD) - datetime: Date and time (ISO 8601)
Allowed values: "string", "integer", "boolean", "date", "datetime"
Example: string
required
boolean
Whether this claim is required when issuing
Example: true
tags
array[string]
Tags for filtering and discovery
Example: ["degree","academic","diploma"]
Array items:
url
string (uri)
URL to the schema documentation page
context_url
string (uri)
URL to the JSON-LD context document
Example: https://aho.com/contexts/university-degree
external_url
string (uri)
nullable
URL to external schema definition (e.g., schema.org)
Example: https://schema.org/EducationalOccupationalCredential
source
string
nullable
Source of the schema (e.g., 'schema_org', 'custom')
Example: custom
subject_schema
object
nullable
JSON Schema defining the credential subject structure
json_ld_context
array[string]
nullable
JSON-LD context URLs for this schema
Example: ["https://www.w3.org/2018/credentials/v1"]
Array items:
svg_template_key
string
nullable
Key identifying the SVG template used for rendering
Example: university_diploma
meta
object
related_schemas
array[object]
Other schemas in the same category
Array items:
A template defining the structure of a credential
slug
string
URL-friendly identifier (lowercase, hyphenated)
Example: university-degree
name
string
Human-readable name of the schema
Example: University Degree
description
string
Detailed description of what this credential type represents
Example: A credential representing an academic degree from a university
credential_type
string
Credential type identifier (e.g., PascalCase or standard like mDL)
Example: UniversityDegreeCredential
category
string
Category for organizing schemas
Example: education
visibility
string
Schema visibility: - public: Listed in the public schema catalog for anyone to use - private: Only visible to the owning issuer organization
Allowed values: "public", "private"
Example: public
claims
array[object]
List of claim fields defined in this schema
Array items:
name
string
Claim field name
Example: degree
type
string
Data type of the claim: - string: Text value - integer: Whole number - boolean: True/false value - date: Date only (YYYY-MM-DD) - datetime: Date and time (ISO 8601)
Allowed values: "string", "integer", "boolean", "date", "datetime"
Example: string
required
boolean
Whether this claim is required when issuing
Example: true
tags
array[string]
Tags for filtering and discovery
Example: ["degree","academic","diploma"]
Array items:
url
string (uri)
URL to the schema documentation page
context_url
string (uri)
URL to the JSON-LD context document
Example: https://aho.com/contexts/university-degree
external_url
string (uri)
nullable
URL to external schema definition (e.g., schema.org)
Example: https://schema.org/EducationalOccupationalCredential
source
string
nullable
Source of the schema (e.g., 'schema_org', 'custom')
Example: custom
subject_schema
object
nullable
JSON Schema defining the credential subject structure
json_ld_context
array[string]
nullable
JSON-LD context URLs for this schema
Example: ["https://www.w3.org/2018/credentials/v1"]
Array items:
svg_template_key
string
nullable
Key identifying the SVG template used for rendering
Example: university_diploma
Code Examples
import os
from aho_sdk import AhoSdk
client = AhoSdk.unauthenticated(api_key=os.environ["AHO_API_KEY"])
result = client.schemas.get(
slug="example_slug"
)client = AhoSdk.unauthenticated(api_key: ENV["AHO_API_KEY"])
result = client.schemas.get(
slug: "example_slug"
)import { AhoSdk } from '@aho/sdk';
const client = AhoSdk.unauthenticated({ apiKey: process.env.AHO_API_KEY });
const result = await client.schemas.get({
slug: "example_slug"
});curl -X GET 'https://api.aho.com/v1/schemas/example_slug'Try It
Log in to test this endpoint directly from the documentation.
Log in