REST API Reference

The Atria REST API provides a comprehensive set of endpoints for integrating and automating tasks within the Atria platform.

Interactive Documentation

We provide interactive "Try it out" documentation for all our REST API endpoints. This allows you to explore the available methods, view request/response models, and test API calls directly from your browser.

[!TIP] To use the "Try it out" feature, you will first need to generate an API token. See the Authentication Guide for details.

API Categories

The API is organized into several key categories:

• Customers: Manage customer accounts and primary details.
• Users: Manage user accounts within a customer.
• WorkSpace Services: Manage the Atria WorkSpace service.
• Billing & Metadata: Access usage data and system metadata.

Using the Interactive Reference

1. Navigate to the desired API endpoint page.
2. Click the Authorize button (if available) or copy your token into the security section.
3. Click Try it out to unlock the parameters.
4. Fill in any required values and click Execute.
5. View the Curl request, the Request URL, and the Response Body directly in the page.