How does the Amelia API entities endpoint work
The Amelia Entities API allows you to retrieve structured data for multiple entity types, such as events, locations, services, and settings, in a single request.
API endpoints are available only in Elite license plans. Using the API requires coding skills and is not covered by standard plugin support.
- Authorization: All endpoints use an API key sent via the Amelia request header.
- Base path:
{{your_site_URL}}/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1 - Postman collection: You can review all endpoints and examples in the Amelia API Postman collection.
How do I retrieve entities via the Amelia API?
You can retrieve one or more entity types by calling the entities endpoint and specifying the desired types as query parameters.
- Method: GET
- Path:
/entities/
Query parameters
- types (string) – Comma-separated list of entity types to retrieve. Possible values include:
- Â employees
- categories
- locations
- packages
- entitiesRelations
- customFields
- customers
- services
- coupons
- events
- tags
- appointments
- settings
- resources
- lessonSpace_spaces
Example
Request
curl --location 'https://example.com/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/entities&types=locations,events' \
--header 'Amelia: YOUR_API_KEY'
Response
{
"message": "Successfully retrieved entities",
"data": {
"events": [
{
"id": 84,
"name": "Sample Event",
"description": "",
"color": "#1788FB",
"price": 100,
"deposit": 10,
"depositPayment": "fixed",
"depositPerPerson": true,
"pictureFullPath": null,
"pictureThumbPath": null,
"extras": [],
"coupons": [],
"position": null,
"settings": "{\"payments\":{\"paymentLinks\":{\"enabled\":true,\"changeBookingStatus\":false,\"redirectUrl\":null},\"onSite\":true,\"payPal\":{\"enabled\":true},\"stripe\":{\"enabled\":true}},\"zoom\":{\"enabled\":true}}",
"fullPayment": true,
"bookings": [],
"periods": [
{
"id": 84,
"eventId": 84,
"periodStart": "2026-02-12 14:00:00",
"periodEnd": "2026-02-12 16:30:00",
"zoomMeeting": null,
"lessonSpace": null,
"bookings": [],
"googleCalendarEventId": null,
"googleMeetUrl": null,
"outlookCalendarEventId": null
}
],
"status": "approved",
"maxCapacity": 100,
"show": true,
"notifyParticipants": 1,
"locationId": 2,
"created": "2026-01-18 10:12:12",
"type": "event"
}
],
"locations": [
{
"id": 4,
"status": "visible",
"name": "West Drive Office",
"description": "Main downtown location",
"address": "179 West Drive, Chicago, IL, USA",
"phone": "+12025550123",
"latitude": 41.906876,
"longitude": -87.896297,
"pictureFullPath": null,
"pictureThumbPath": null,
"pin": null,
"translations": null
}
],
"customers": [],
"appointments": {
"futureAppointments": []
}
}
}