This documentation is currently under development. Certain sections are not yet complete and will be added shortly.
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Advanced

Additional API endpoints that do not belong to a specific functional group. These cover platform-level administration, data export, template management, access control, and observability.

Additional API endpoints that do not belong to a specific functional group. These cover platform-level administration, data export, template management, access control, and observability.

Pass Export

Bulk-export pass data for a tenant. Returns pass records with identifiers, metadata, and current field values in a structured format suitable for CRM sync, BI pipelines, or migration.

For large exports, prefer paginated calls or the SFTP flat-file export. See Import and export guide.

Templates

Programmatic access to pass template definitions — the visual and data configuration that controls how a pass looks in Apple Wallet and Google Wallet.

Operation
Description

List templates

Enumerate all templates configured for the tenant.

Get template

Retrieve the full template definition including field layout and branding.

API Keys

A secondary API key management surface (the primary one is under Tenant Configuration → Security). Use these endpoints when managing keys as part of a provisioning pipeline.

Config

Read or update runtime configuration values for the tenant. Overlaps with Tenant endpoints but focuses on in-memory configuration rather than file-based configuration archives.

Permissions, Roles, and Users

Back-office identity management for the tenant:

Tag
Description

Permissions

List and inspect permission scopes available on the platform.

Roles

Create and manage role definitions that group permissions.

Users

Manage back-office user accounts, role assignments, and invitations.

See User access guide for the full setup flow.

Google Classes Admin

Manage Google Wallet class definitions at the platform level. Google Wallet passes are built on top of a class (template) and an object (instance). These endpoints let you inspect and update class configurations when the standard template management UI is not sufficient.

Logs

Query raw platform logs for the tenant. Useful for troubleshooting integration failures, diagnosing connector errors, and auditing configuration changes.

For analytics queries (KQL), use the Insights endpoint under the Tools group instead.

Global

Cross-tenant utility endpoints available to Global Administrators. Includes platform health checks, tenant directory access, and infrastructure diagnostics.

Further reading

Last updated