Skip to main content

API Authentication

Atria's REST API uses Bearer Token authentication to ensure secure communication. Every request to the REST API must include a valid token in the Authorization header.

Generating an API Token​

To generate a token, follow these steps in the Atria portal:

  1. Log in to the Atria platform with an account that has API permissions.
  2. Navigate to My Account in the top right menu.
  3. Open the API Tokens tab.
  4. Click the Generate button.
  5. Copy the token immediately. For security, it will only be shown once.

[!WARNING] Treat your API token like a password. Never share it or commit it to version control.

Using the Token in Requests​

Include the token in the HTTP Authorization header as a Bearer token.

Example (cURL)​

curl -X GET "https://{atriahost}/api/v2/customers" \
     -H "Authorization: Bearer YOUR_API_TOKEN" \
     -H "Content-Type: application/json"

Token Expiry​

Tokens have an expiration date, which is displayed on the API Tokens page. Once a token expires, you will need to generate a new one. You can also manually delete tokens that are no longer in use from the same page.