API Overview
Overview
The Astalty API is a JSON REST API for integrations and automations. It can read and manage supported Astalty records without using the web interface. The interactive API Reference describes its paths, parameters, request bodies and response schemas. For the latest deployed contract, open the live API documentation.
What is an API?
An API (Application Programming Interface) lets software systems exchange information. For example, your integration could retrieve Participant data for a reporting tool or create a Task from another system.
Key facts
| Base URL | https://api.app.astalty.com.au |
| Public endpoints | Prefixed with /public/v1, for example https://api.app.astalty.com.au/public/v1/participants |
| Format | JSON request and response bodies |
| Style | REST. Endpoints use methods such as GET, POST, PUT and DELETE |
| Authentication | Bearer token. See Authenticate API Requests |
| Interactive reference | API Reference |
| Who can manage it | The Account Owner and any Admin granted Can manage API keys and webhooks can open the API Dashboard and manage keys |
How to get started
- Create an API key and choose Full Access or Read Only.
- Authenticate your requests by sending the key as a Bearer token.
- Find an endpoint for the record or action you need.
- Handle list responses with pagination, filtering and sorting.
What you can do with the API
The API covers Participants, Contacts, Organisations, Plan Managers, Referrals, Sites, Users, Tasks, invoices, invoice batches, Charge Items, Incidents and other supported records. Some endpoints depend on an account feature such as Scheduling, Participant Budgets or webhooks. Check the API Reference for the operations and schemas available when you build your integration.
I need help using the API
Building an integration requires code that stores credentials securely, calls the API and handles its responses. If you cannot access the API or need help getting started, contact Astalty Support. Astalty can explain the documented API, but your developer remains responsible for the design and operation of your integration.