Alution Cloud API

Connect external software to Alution Cloud. Synchronize contacts and provider fields, work with tickets and transfers, and access files through one tenant-scoped public API.

How it works

Each tenant has its own https://{tenant}.alution.cloud origin. Public clients obtain short-lived access tokens through OAuth 2.0 Authorization Code with PKCE, then call versioned endpoints below /api/v1 with Authorization: Bearer {access_token}. Signed file and guest URLs are the documented exceptions and carry their authorization in the URL signature.

Register provider metadata only when your integration needs provider-owned settings, custom fields, mappings, or transfer definitions. OAuth client registration and provider registration are distinct concepts.

Guides

Authentication

Learn how to authenticate API requests using OAuth 2.0 PKCE.

Read more

Pagination

Understand how to work with paginated list responses.

Read more

Errors

Read about HTTP status codes and error response formats.

Read more

Real-time

Subscribe to live events over authenticated WebSocket channels.

Read more

Resources

Contacts

Learn about the contact model and how to create, retrieve, update, delete, and list contacts.

Providers

Learn how to register and configure your integration as a provider within Alution.

Tickets

Learn about the ticket model and how to create, query, update, and manage tickets.

Transfers

Learn how to receive and respond to transfers from Alution to your system.

Was this page helpful?