API Overview
Overview
The Astalty API lets you interact with your Astalty account programmatically — securely reading and managing certain data without using the web interface. It's a JSON-based REST API, designed for developers who want to integrate Astalty into other systems or automate parts of their workflow.
We're actively expanding endpoint coverage based on customer requests. The full, always-up-to-date endpoint reference is published as interactive documentation at api.app.astalty.com.au/docs.
What is an API?
An API (Application Programming Interface) is a way for different software systems to talk to each other. It lets one system safely request or send information to another without a person doing it manually. For example, another app could use the Astalty API to pull participant data from your account or create a task automatically — the same things you might do in the Astalty app, just done behind the scenes by software instead of a person.
Key facts
| Base URL | https://api.app.astalty.com.au |
| Public endpoints | Prefixed with /public/v1 — e.g. https://api.app.astalty.com.au/public/v1/participants |
| Format | JSON request and response bodies |
| Style | REST — resources are accessed with GET, created with POST, updated with PUT, and removed with DELETE |
| Authentication | Bearer token (API key) — see Authentication |
| Interactive reference | api.app.astalty.com.au/docs |
How to get started
- Set up an API key — create a key, choose an access level (Full Access or Read Only), and copy it from the API Dashboard.
- Authenticate your requests — send your key as a Bearer token.
- Browse the available endpoints — see what data you can read and manage.
- Handle pagination, filtering and sorting — work with list responses.
What you can do with the API
The API exposes many of the records you already work with in Astalty, including participants, contacts, organisations, plan managers, referrals, sites, users, tasks, invoices and invoice batches, charge items, incidents and more. For the complete and current list — including every field, parameter and example response — always refer to the interactive endpoint reference.
I need help using the API
The Astalty API is designed for developers to build integrations or automations that connect other systems with Astalty. Typically you'll need a developer to set up and manage the connection, as it involves writing code to securely call our API and handle the data it returns.
If you or your developer are having trouble accessing the API, or you'd like more information on how to get started, please contact support@astalty.com.au.
While we can provide guidance and documentation, we're unable to offer direct technical assistance or build custom integrations. The specific steps for building an integration will depend on what you're trying to achieve, how you're connecting, and the tools or platforms you're using to make the API calls.