API

The Astalty API is a JSON-based REST API that lets you interact with your Astalty account programmatically — securely reading and managing certain data without using the web interface. It's designed for developers who want to integrate Astalty into other systems or automate parts of their workflow.

The API is available to every provider on Premium — there is nothing to request or switch on. On any other plan you need to upgrade to Premium to get API access. The Account Owner can always open the API Dashboard and manage keys, and can grant another Admin the same access — see Granting API Key and Webhook Access. No other role can reach it. The full, always-up-to-date endpoint reference is published as interactive documentation at api.app.astalty.com.au/docs.

In this section

• API Overview — what the Astalty API is, how it's structured, and where to find the full endpoint reference.
• How to Set Up an API Key — create and manage API keys, choose an access level, and get to the API Dashboard.
• Authentication — authenticate your requests, plus rate limits and error responses.
• Pagination, Filtering & Sorting — how list endpoints paginate, and how to filter, sort, and expand them.
• Available Endpoints — where to find the full list of API endpoints.