Skip to main content

Reference

This section contains reference pages for each documented Breeze GraphQL operation and type.

The Breeze API exposes a curated set of operations for partner integrators. Operations are documented here as they are approved for external use. See the use-case guides for task-oriented examples.

Queries

OperationDescription
CredentialTemplatesV2Return available Credential Templates and their required data fields for one or more Tenants.
MeReturn the user tied to the access token. Use it to verify your token and identify the authenticated client.

Mutations

OperationDescription
CredentialOrderV1Issue a new Credential based on a Template. The Credential follows the Tenant's configured production flow on success.

Types

TypeDescription
Data fieldsAll named data fields available in Credential Templates — types, descriptions, and which fields you provide versus which are system-populated.