Amelia

https://wpamelia.com/documentation
Admin
Amelia is a WordPress booking and scheduling plugin that enables appointment booking, event...
Tokens:212,680
Snippets:2,329
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Amelia via FTP

Source: https://wpamelia.com/documentation/installing-amelia

Steps to manually install the Amelia plugin using an FTP client.

```text
1. Unzip the `ameliabooking.zip` file on your computer.
2. Open your FTP client (such as FileZilla, Cyberduck, or Total Commander).
3. Connect to your server and navigate to the `/wp-content/plugins/` directory.
4. Upload the unzipped **ameliabooking** folder there.
5. Once uploaded, go to your WordPress admin → **Plugins** and click **Activate** next to **Amelia**.
```

--------------------------------

### Event Page URL Example with Pre-selection

Source: https://wpamelia.com/documentation/amelia-shortcodes

Example URL demonstrating how to pre-select an event and open it in a popup using URL parameters.

```url
https://yourbookingwebsite.com/events/?ameliaEventId=123&ameliaEventPopup=123
```

--------------------------------

### Appointment Booking Form URL Example with Pre-selection

Source: https://wpamelia.com/documentation/amelia-shortcodes

Example URL demonstrating how to pre-select a service and employee in the appointment booking form using URL parameters.

```url
https://yourbookingwebsite.com/booking/?ameliaServiceId=5&ameliaEmployeeId=1
```

--------------------------------

### Step by step booking shortcode examples

Source: https://wpamelia.com/documentation/amelia-shortcodes

Examples of how to embed the Step by step booking form with various parameters to filter the displayed services and employees.

```shortcode
[ameliastepbooking]
```

```shortcode
[ameliastepbooking category=1]
```

```shortcode
[ameliastepbooking service=1]
```

```shortcode
[ameliastepbooking employee=1]
```

```shortcode
[ameliastepbooking location=1]
```

```shortcode
[ameliastepbooking category=1 employee=1]
```

```shortcode
[ameliastepbooking show=services]
```

```shortcode
[ameliastepbooking show=packages]
```

--------------------------------

### Retrieve Employees via cURL

Source: https://wpamelia.com/documentation/api-employees

Example request to fetch employees with filtering parameters using the GET method.

```bash
curl --location 'https://example-site.com/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/users/providers&page=1&search=ana&services[0]=2&location=1' \
--header 'Amelia: YOUR_API_KEY'
```

--------------------------------

### Retrieve Timeslots via cURL

Source: https://wpamelia.com/documentation/api-timeslots

Example request to fetch available timeslots using the GET method with required query parameters and API key header.

```bash
curl --location 'https://example-site.com/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/slots&locationId=2&serviceId=3&serviceDuration=1800&providerIds=3&persons=1&startDateTime=2026-02-10%2009:00&extras=[]&excludeAppointmentId=null' \
--header 'Amelia: YOUR_API_KEY'
```

--------------------------------

### GET /packages

Source: https://wpamelia.com/documentation/api-packages

Retrieves a list of packages. Supports pagination and sorting.

```APIDOC
## GET /packages

### Description
Use this endpoint to retrieve packages. You can paginate results and sort them depending on the supported parameters.

### Method
GET

### Endpoint
/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/packages

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number
- **sort** (string) - Optional - Sorting mode, for example `name`

### Response
#### Success Response (200)
- **message** (string) - Success message
- **data** (object) - Contains the list of packages

#### Response Example
{
  "message": "Successfully retrieved packages.",
  "data": {
    "packages": [
      {
        "id": 9,
        "name": "Starter recovery package",
        "description": "A short package for clients who want to try two core services.",
        "price": 53.89
      }
    ]
  }
}
```

--------------------------------

### Example Existing File Extension Entry

Source: https://wpamelia.com/documentation/extend-attachment-file-type

The format used for existing file extensions and their associated MIME types.

```json
".docx":"application/msword"
```

--------------------------------

### GET /extras

Source: https://wpamelia.com/documentation/api-extras

Retrieves a list of all available extras.

```APIDOC
## GET /extras

### Description
Use this endpoint to retrieve a list of extras.

### Method
GET

### Endpoint
/extras

### Response
#### Success Response (200)
- **message** (string) - Success message
- **data** (object) - Contains the list of extras

#### Response Example
{
  "message": "Successfully retrieved extras.",
  "data": {
    "extras": [
      {
        "id": 5,
        "name": "Aromatherapy",
        "description": "Add aromatherapy oils during the session.",
        "price": 20,
        "maxQuantity": 1,
        "position": 1,
        "duration": null,
        "serviceId": 6,
        "aggregatedPrice": false,
        "translations": null
      }
    ]
  }
}
```

--------------------------------

### GET /fields

Source: https://wpamelia.com/documentation/api-custom-fields

Retrieves a list of all custom fields configured in the system.

```APIDOC
## GET /fields

### Description
Use this endpoint to retrieve all custom fields.

### Method
GET

### Endpoint
{{your_site_URL}}/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/fields

### Response
#### Success Response (200)
- **message** (string) - Success message
- **data** (object) - Contains the list of custom fields

#### Response Example
{
  "message": "Successfully retrieved custom fields.",
  "data": {
    "customFields": [
      {
        "id": 1,
        "label": "text",
        "type": "text",
        "required": false,
        "position": 1,
        "allServices": true,
        "allEvents": true
      }
    ]
  }
}
```

--------------------------------

### InitiateCheckout

Source: https://wpamelia.com/documentation/js-hooks-for-events

Triggered when the payment step is loaded.

```APIDOC
## InitiateCheckout

### Description
Triggered when the payment step is loaded.

### Signature
`window.ameliaActions.InitiateCheckout(success, error, data)`
```

--------------------------------

### POST /packages

Source: https://wpamelia.com/documentation/api-packages

Creates a new package with defined services, pricing, and configuration settings.

```APIDOC
## POST /packages

### Description
Use this endpoint to create a new package, define its included services, and configure pricing and purchase rules.

### Method
POST

### Endpoint
{{your_site_URL}}/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/packages

### Parameters
#### Request Body
- **name** (string) - Required - Package name
- **bookable** (array) - Required - Array of included service objects (service, providers, locations, quantity, minimumScheduled, maximumScheduled, allowProviderSelection)
- **price** (double) - Required - Package price
- **status** (string) - Optional - Possible values: visible, hidden, disabled (default: visible)
- **description** (string) - Optional - Package description
- **color** (string) - Optional - Hex color (default: #1788FB)
- **calculatedPrice** (boolean) - Optional - Calculate price from services (default: true)
- **discount** (double) - Optional - Package discount
- **gallery** (array) - Optional - Gallery image paths
- **pictureFullPath** (string) - Optional - Full image path
- **pictureThumbPath** (string) - Optional - Thumbnail image path
- **position** (integer) - Optional - Sorting position (default: 1)
- **settings** (string) - Optional - JSON encoded package settings
- **endDate** (string) - Optional - Purchase expiration in YYYY-MM-DD HH:mm format
- **durationCount** (string) - Optional - Expiration duration count
- **durationType** (integer) - Optional - Expiration duration unit (day, week, month)
- **translations** (string) - Optional - JSON encoded translations
- **sharedCapacity** (boolean) - Optional - Shared capacity across services (default: false)
- **quantity** (integer) - Optional - Total quantity when sharedCapacity is true
- **limitPerCustomer** (integer) - Optional - JSON encoded limits per customer
- **descriptionHtml** (string) - Optional - Description in HTML
- **deposit** (double) - Optional - Deposit amount
- **depositPayment** (string) - Optional - Deposit type: disabled, fixed, percentage
- **fullPayment** (boolean) - Optional - Allow full payment instead of deposit only (default: false)
```

--------------------------------

### Search Timeslots Request

Source: https://wpamelia.com/documentation/api-search-timeslots

Example of a GET request to the search endpoint using cURL with query parameters and API key authorization.

```bash
curl --location 'https://example-site.com/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/search&date=2026-03-18&location=2&page=1&services=1,2&sort=name&providers=1,3' \
--header 'Amelia: YOUR_API_KEY'
```

--------------------------------

### Handle InitInfoStep Hook

Source: https://wpamelia.com/documentation/js-hooks-for-events

Triggered when the customer information step is initialized.

```javascript
window.ameliaActions = {
  InitInfoStep: function (success = null, error = null, data) {
    console.log('InitInfoStep HOOK')
    console.log(data)
    console.log('------------')
  }
}
```

--------------------------------

### Handle InitiateCheckout Hook

Source: https://wpamelia.com/documentation/js-hooks-for-events

Triggered when the payment step is loaded.

```javascript
window.ameliaActions = {
  InitiateCheckout: function (success = null, error = null, data) {
    console.log('InitiateCheckout HOOK')
    console.log(data)
    console.log('------------')
  }
}
```

--------------------------------

### Install Amelia via WordPress Admin

Source: https://wpamelia.com/documentation/installing-amelia

Steps to install the Amelia plugin through the WordPress dashboard.

```text
1. In your WordPress admin panel, go to **Plugins → Add New → Upload Plugin**.
2. Click **Choose File** , select the `ameliabooking.zip` file you downloaded, and click **Install Now**.
3. Once the installation finishes, click **Activate Plugin**.
```

--------------------------------

### Retrieve resources via GET

Source: https://wpamelia.com/documentation/api-resources

Fetches a list of resources and their linked entities. Requires the Amelia API key in the request header.

```bash
curl --location 'https://example-site.com/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/resources' \
--header 'Amelia: YOUR_API_KEY'
```

```json
{
  "message": "Successfully retrieved resources.",
  "data": {
    "resources": [
      {
        "id": 4,
        "name": "Treatment bed",
        "quantity": 1,
        "shared": "location",
        "status": "hidden",
        "entities": {
          "14": {
            "id": 14,
            "resourceId": 4,
            "entityId": 1,
            "entityType": "service"
          }
        },
        "countAdditionalPeople": null
      },
      {
        "id": 6,
        "name": "Massage room large",
        "quantity": 3,
        "shared": false,
        "status": "visible",
        "entities": {
          "25": {
            "id": 25,
            "resourceId": 6,
            "entityId": 2,
            "entityType": "service"
          }
        },
        "countAdditionalPeople": null
      }
    ]
  }
}
```

--------------------------------

### Customer Panel Shortcode Examples

Source: https://wpamelia.com/documentation/amelia-shortcodes

Examples of how to embed the Customer panel shortcode to allow customers to manage their appointments and events.

```shortcode
[ameliacustomerpanel appointments=1]
```

```shortcode
[ameliacustomerpanel events=1]
```

```shortcode
[ameliacustomerpanel appointments=1 events=1]
```

--------------------------------

### Create a Package Purchase Request

Source: https://wpamelia.com/documentation/api-package-purchases

Example request for creating a package purchase using cURL. Requires the Amelia API key in the header and specific package and customer IDs.

```bash
curl --location 'https://example-site.com/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/packages/customers' \
--header 'Content-Type: application/json' \
--header 'Amelia: YOUR_API_KEY' \
--data '{
  "packageId": 14,
  "customerId": 16,
  "notify": true
}'
```

--------------------------------

### Advanced Shortcode Parameter Examples

Source: https://wpamelia.com/documentation/amelia-shortcodes

Illustrative examples of advanced shortcode parameters for multiple selections, tags, recurring events, and popup modes.

```shortcode
employee=1,4,7
```

```shortcode
tag="{design},{marketing}"
```

```shortcode
recurring=1
```

```shortcode
trigger="some-class" trigger_type="class"
```

```shortcode
in_dialog=1
```

--------------------------------

### InitInfoStep

Source: https://wpamelia.com/documentation/js-hooks-for-events

Triggered when the customer information step is loaded.

```APIDOC
## InitInfoStep

### Description
Triggered when the customer information step is loaded.

### Signature
`window.ameliaActions.InitInfoStep(success, error, data)`
```

--------------------------------

### Employee Panel Shortcode Examples

Source: https://wpamelia.com/documentation/amelia-shortcodes

Examples of how to embed the Employee panel shortcode for employees to manage their schedules, with an option to hide profile settings.

```shortcode
[ameliaemployeepanel appointments=1]
```

```shortcode
[ameliaemployeepanel events=1]
```

```shortcode
[ameliaemployeepanel appointments=1 events=1]
```

```shortcode
[ameliaemployeepanel appointments=1 profile-hidden=1]
```

--------------------------------

### Catalog booking shortcode examples

Source: https://wpamelia.com/documentation/amelia-shortcodes

Examples of how to embed the Catalog booking form with parameters to filter by category, service, employee, location, or package.

```shortcode
[ameliacatalogbooking]
```

```shortcode
[ameliacatalogbooking category=1]
```

```shortcode
[ameliacatalogbooking service=1]
```

```shortcode
[ameliacatalogbooking employee=1]
```

```shortcode
[ameliacatalogbooking location=1]
```

```shortcode
[ameliacatalogbooking category=1 employee=1]
```

```shortcode
[ameliacatalogbooking show=services]
```

```shortcode
[ameliacatalogbooking show=packages]
```

```shortcode
[ameliacatalogbooking package=1]
```

--------------------------------

### Event Calendar Booking Form Shortcode Examples

Source: https://wpamelia.com/documentation/amelia-shortcodes

Examples of how to embed the Event calendar booking form shortcode with different parameters to filter events.

```shortcode
[ameliaeventscalendarbooking]
```

```shortcode
[ameliaeventscalendarbooking event=1]
```

```shortcode
[ameliaeventscalendarbooking event=1 recurring=1]
```

```shortcode
[ameliaeventscalendarbooking tag="{workshop}"]
```

--------------------------------

### Add New File Extensions

Source: https://wpamelia.com/documentation/extend-attachment-file-type

The syntax for appending new file types to the existing configuration list.

```json
".zip":"application/zip",".gz":"application/x-gzip"
```

--------------------------------

### POST /api/v1/packages

Source: https://wpamelia.com/documentation/api-packages

Creates a new booking package with specified services, pricing, and settings.

```APIDOC
## POST /api/v1/packages

### Description
Creates a new booking package in the system.

### Method
POST

### Endpoint
/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/packages

### Request Body
- **bookable** (array) - Required - List of services included in the package.
- **name** (string) - Required - Name of the package.
- **price** (number) - Required - Base price of the package.
- **status** (string) - Required - Visibility status (e.g., "visible").
- **endDate** (string) - Optional - Expiration date of the package.

### Request Example
{
  "bookable": [
    { "service": { "id": 1 }, "quantity": 1, "minimumScheduled": 0, "maximumScheduled": 1, "allowProviderSelection": true }
  ],
  "name": "Starter wellness package",
  "price": 55,
  "status": "visible",
  "endDate": "2026-06-30 23:59"
}

### Response
#### Success Response (200)
- **message** (string) - Success confirmation message.
- **data** (object) - The created package object.

#### Response Example
{
  "message": "Successfully added new package.",
  "data": {
    "package": {
      "id": 22,
      "name": "Starter wellness package",
      "price": 55
    }
  }
}
```

--------------------------------

### Execute code before package purchase addition

Source: https://wpamelia.com/documentation/wp-package-purchases-hooks

Trigger custom logic before a package purchase is added using the amelia_before_package_customer_added action.

```php
function example($packageCustomer)
{
    // do action
}

add_action('amelia_before_package_customer_added', 'example', 10, 1);
```

--------------------------------

### Execute code before settings return

Source: https://wpamelia.com/documentation/wp-settings-hooks

The amelia_get_settings action triggers before settings are returned for back-end display.

```php
function example($settings)
{
    // do action
}

add_action('amelia_get_settings', 'example', 10, 1);
```

--------------------------------

### Event list booking shortcode examples

Source: https://wpamelia.com/documentation/amelia-shortcodes

Examples of how to embed the Event list booking form, showing all events, filtered by date range, a specific event, or tags.

```shortcode
[ameliaeventslistbooking]
```

```shortcode
[ameliaeventslistbooking range="future"]
```

```shortcode
[ameliaeventslistbooking range="past"]
```

```shortcode
[ameliaeventslistbooking range="2026-04-07 - 2026-05-20"]
```

```shortcode
[ameliaeventslistbooking event=1]
```

```shortcode
[ameliaeventslistbooking event=1 recurring=1]
```

```shortcode
[ameliaeventslistbooking tag="{physics}"]
```

--------------------------------

### GET /coupons

Source: https://wpamelia.com/documentation/api-coupons

Retrieves a list of all coupons.

```APIDOC
## GET /coupons

### Description
Use this endpoint to retrieve a list of coupons.

### Method
GET

### Endpoint
{{your_site_URL}}/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/coupons

### Response
#### Success Response (200)
- **message** (string) - Success message.
- **data** (object) - Contains the list of coupons and count metadata.

#### Response Example
{
  "message": "Successfully retrieved coupons.",
  "data": {
    "coupons": [],
    "filteredCount": 6,
    "totalCount": 6
  }
}
```

--------------------------------

### POST /resources

Source: https://wpamelia.com/documentation/api-resources

Creates a new resource in the system, allowing you to define its quantity, visibility, and associated entities.

```APIDOC
## POST /resources

### Description
Use this endpoint to create a new resource, set its quantity, and optionally link it to services or locations for availability calculations.

### Method
POST

### Endpoint
{{your_site_URL}}/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/resources

### Parameters
#### Request Body
- **name** (string) - Required - Resource name for internal usage
- **quantity** (integer) - Required - Resource quantity
- **shared** (string) - Optional - Shared type, possible values: service, location, null
- **status** (string) - Optional - Possible values: visible, hidden, default visible
- **entities** (array) - Optional - Entities tied to the resource, all entities by default
- **countAdditionalPeople** (boolean) - Optional - Whether the resource is counted per person or per appointment

### Request Example
{
  "name": "Massage room",
  "quantity": 2,
  "shared": null,
  "status": "visible",
  "entities": [
    {
      "entityId": 1,
      "entityType": "service"
    }
  ]
}

### Response
#### Success Response (200)
- **message** (string) - Success confirmation message
- **data** (object) - The created resource object

#### Response Example
{
  "message": "Successfully added new resource.",
  "data": {
    "resource": {
      "id": 7,
      "name": "Massage room",
      "quantity": 2,
      "shared": false,
      "status": "visible",
      "entities": [
        {
          "entityId": 1,
          "entityType": "service"
        }
      ],
      "countAdditionalPeople": null
    }
  }
}
```

--------------------------------

### GET /notifications/undelivered/send

Source: https://wpamelia.com/documentation/api-notifications

Triggers the sending of undelivered notifications.

```APIDOC
## GET /notifications/undelivered/send

### Description
Use this endpoint to trigger sending undelivered notifications.

### Method
GET

### Endpoint
/api/v1/notifications/undelivered/send

### Response
#### Success Response (200)
- **message** (string) - Email notifications successfully sent
- **data** (null) - null
```

--------------------------------

### Execute code before package addition

Source: https://wpamelia.com/documentation/wp-packages-hooks

The amelia_before_package_added action triggers immediately before a package is added.

```php
function example($package)
{
    // do action
}

add_action('amelia_before_package_added', 'example', 10, 1);
```

--------------------------------

### GET /notifications/scheduled/send

Source: https://wpamelia.com/documentation/api-notifications

Triggers the sending of scheduled notifications.

```APIDOC
## GET /notifications/scheduled/send

### Description
Use this endpoint to trigger sending scheduled notifications.

### Method
GET

### Endpoint
/api/v1/notifications/scheduled/send

### Response
#### Success Response (200)
- **message** (string) - Scheduled email notifications successfully sent
- **data** (null) - null
```

--------------------------------

### Retrieve Packages via cURL

Source: https://wpamelia.com/documentation/api-packages

Use this cURL command to fetch a list of packages. Ensure the Amelia header is populated with your valid API key.

```bash
curl --location 'https://example-site.com/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/packages?page=1&sort=name' \
--header 'Amelia: YOUR_API_KEY'
```

--------------------------------

### GET /resources

Source: https://wpamelia.com/documentation/api-resources

Retrieves a list of resources and the entities they are linked to.

```APIDOC
## GET /resources

### Description
Use this endpoint to retrieve a list of resources and the entities they are linked to.

### Method
GET

### Endpoint
{{your_site_URL}}/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/resources

### Authorization
Requires an 'Amelia' header with your API key.

### Response
#### Success Response (200)
- **message** (string) - Success message
- **data** (object) - Contains the list of resources

#### Response Example
{
  "message": "Successfully retrieved resources.",
  "data": {
    "resources": [
      {
        "id": 4,
        "name": "Treatment bed",
        "quantity": 1,
        "shared": "location",
        "status": "hidden",
        "entities": {
          "14": {
            "id": 14,
            "resourceId": 4,
            "entityId": 1,
            "entityType": "service"
          }
        },
        "countAdditionalPeople": null
      }
    ]
  }
}
```

--------------------------------

### Create a Hyperlink with a URL Placeholder

Source: https://wpamelia.com/documentation/notification-placeholders

Use this HTML structure to ensure the placeholder is correctly interpreted as a secure, dynamic link by the system.

```html
<a href="%customer_panel_url%">Click here</a>
```

--------------------------------

### GET /payments/{{payment_id}}

Source: https://wpamelia.com/documentation/api-payments

Retrieve details for a specific payment by its ID.

```APIDOC
## GET /payments/{{payment_id}}

### Description
Use this endpoint to retrieve details for a specific payment ID.

### Method
GET

### Endpoint
/payments/{{payment_id}}

### Parameters
#### Path Parameters
- **payment_id** (integer) - Required - The unique identifier of the payment.

### Request Example
curl --location 'https://example.website/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/payments/312' --header 'Amelia: YOUR_API_KEY'

### Response
#### Success Response (200)
- **message** (string) - Status message
- **data** (object) - Payment details object

#### Response Example
{
  "message": "Successfully retrieved payment.",
  "data": {
    "payment": {
      "id": 312,
      "customerBookingId": 268,
      "packageCustomerId": null,
      "parentId": null,
      "amount": 10,
      "gateway": "onSite",
      "gatewayTitle": "",
      "dateTime": "2026-03-11 13:00:00",
      "status": "paid",
      "data": "",
      "entity": "appointment",
      "created": "2026-03-11 11:18:32",
      "actionsCompleted": null,
      "wcOrderId": null,
      "wcOrderUrl": null,
      "wcItemCouponValue": null,
      "wcItemTaxValue": null
    }
  }
}
```

--------------------------------

### Execute code before settings save

Source: https://wpamelia.com/documentation/wp-settings-hooks

The amelia_before_settings_updated action runs immediately before settings are saved to the database.

```php
function example($settings)
{
    // do action
}

add_action('amelia_before_settings_updated', 'example', 10, 1);
```

--------------------------------

### GET /events

Source: https://wpamelia.com/documentation/api-events

Retrieves a list of events with optional filtering capabilities.

```APIDOC
## GET /events

### Description
Use this endpoint to retrieve events. You can filter by search term, date range, page, and customer ID.

### Method
GET

### Endpoint
{{your_site_URL}}/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/events

### Parameters
#### Query Parameters
- **search** (string) - Optional - Search term
- **page** (integer) - Optional - Page number
- **dates** (array) - Optional - Date range using dates[0] for start and dates[1] for end in YYYY-MM-DD format
- **customerId** (integer) - Optional - Customer ID that booked the events

### Request Example
curl --location 'https://example-site.com/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/events&search=workshop&dates[0]=2026-05-01&dates[1]=2026-05-31&page=1' \
--header 'Amelia: YOUR_API_KEY'

### Response
#### Success Response (200)
- **message** (string) - Status message
- **data** (object) - List of events and count

#### Response Example
{
  "message": "Successfully retrieved events",
  "data": {
    "events": [
      {
        "id": 16,
        "name": "Spring wellness meetup",
        "price": 20,
        "status": "approved",
        "maxCapacity": 70,
        "show": true
      }
    ],
    "count": 1
  }
}
```

--------------------------------

### GET /events/{event_id}

Source: https://wpamelia.com/documentation/api-events

Retrieves details for a single event by its ID.

```APIDOC
## GET /events/{event_id}

### Description
Use this endpoint to retrieve details for a single event.

### Method
GET

### Endpoint
{{your_site_URL}}/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/events/{event_id}

### Parameters
#### Path Parameters
- **event_id** (integer) - Required - The unique identifier of the event.

### Request Example
curl --location 'https://example-site.com/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/events/122' \
--header 'Amelia: YOUR_API_KEY'

### Response
#### Success Response (200)
- **message** (string) - Status message
- **data** (object) - Event details

#### Response Example
{
  "message": "Successfully retrieved event",
  "data": {
    "event": {
      "id": 122,
      "name": "Wellness workshop updated",
      "status": "approved"
    }
  }
}
```

--------------------------------

### POST /api/v1/services

Source: https://wpamelia.com/documentation/api-services

Creates a new service in the Amelia system.

```APIDOC
## POST /api/v1/services

### Description
Creates a new service with specified details such as name, duration, price, and category.

### Method
POST

### Endpoint
https://example-site.com/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/services

### Request Body
- **categoryId** (integer) - Required - ID of the category
- **name** (string) - Required - Name of the service
- **duration** (integer) - Required - Duration in seconds
- **price** (number) - Required - Price of the service
- **status** (string) - Required - Visibility status

### Request Example
{
  "categoryId": 4,
  "name": "Initial consultation",
  "duration": 1800,
  "price": 35,
  "status": "visible"
}

### Response
#### Success Response (200)
- **message** (string) - Success message
- **data** (object) - The created service object

#### Response Example
{
  "message": "Successfully added new service.",
  "data": {
    "service": {
      "id": 24,
      "name": "Initial consultation"
    }
  }
}
```

--------------------------------

### GET /slots

Source: https://wpamelia.com/documentation/api-timeslots

Retrieves available timeslots for a specific service configuration.

```APIDOC
## GET /slots

### Description
Use this endpoint to retrieve available timeslots for a specific service configuration.

### Method
GET

### Endpoint
{{your_site_URL}}/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/slots

### Parameters
#### Query Parameters
- **serviceId** (integer) - Required - service ID
- **persons** (integer) - Required - number of persons
- **providerIds** (array) - Optional - array of employee IDs
- **locationId** (integer) - Optional - location ID
- **serviceDuration** (integer) - Optional - service duration in seconds
- **startDateTime** (string) - Optional - from which date to retrieve timeslots, string in datetime format YYYY-MM-DD HH:mm
- **endDateTime** (string) - Optional - up until which date to retrieve timeslots, string in datetime format YYYY-MM-DD HH:mm
- **excludeAppointmentId** (integer) - Optional - do not include this appointment ID in the timeslot calculation
- **extras** (array) - Optional - an array of extras

### Request Example
curl --location 'https://example-site.com/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/slots&locationId=2&serviceId=3&serviceDuration=1800&providerIds=3&persons=1&startDateTime=2026-02-10%2009:00&extras=[]&excludeAppointmentId=null' \
--header 'Amelia: YOUR_API_KEY'

### Response
#### Success Response (200)
- **message** (string) - Success message
- **data** (object) - Object containing slots, occupied, busyness, and provider information

#### Response Example
{
  "message": "Successfully retrieved free slots",
  "data": {
    "minimum": "2026-02-10 09:00",
    "maximum": "2026-04-10 09:00",
    "slots": {
      "2026-03-02": {
        "08:30": [[3, 2]],
        "09:00": [[3, 2]],
        "09:30": [[3, 2]],
        "10:00": [[3, 2]],
        "10:30": [[3, 2]],
        "11:00": [[3, 2]]
      }
    },
    "occupied": {},
    "busyness": {},
    "lastProvider": null
  }
}
```

--------------------------------

### Execute code before payment links with amelia_before_payment_links_created

Source: https://wpamelia.com/documentation/wp-hooks-payments

This action hook triggers before payment links are created for emails or the panel.

```php
function example($methods, $data, $amount)
{
    // do action
}

add_action('amelia_before_payment_links_created', 'example', 10, 3);
```

--------------------------------

### GET /coupons/{{coupon_id}}

Source: https://wpamelia.com/documentation/api-coupons

Retrieves details for a single coupon by its ID.

```APIDOC
## GET /coupons/{{coupon_id}}

### Description
Use this endpoint to retrieve details for a single coupon.

### Method
GET

### Endpoint
{{your_site_URL}}/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/coupons/{{coupon_id}}

### Parameters
#### Path Parameters
- **coupon_id** (integer) - Required - The unique identifier of the coupon.

### Response
#### Success Response (200)
- **message** (string) - Success message.
- **data** (object) - Contains the coupon object.

#### Response Example
{
  "message": "Successfully retrieved coupon.",
  "data": {
    "coupon": {
      "id": 14,
      "code": "SPRING20",
      "discount": 0,
      "deduction": 20,
      "limit": 40,
      "customerLimit": 1,
      "used": 0,
      "notificationInterval": 0,
      "notificationRecurring": false,
      "status": "hidden",
      "serviceList": [],
      "eventList": [],
      "packageList": [],
      "expirationDate": "2026-05-06"
    }
  }
}
```

--------------------------------

### Execute logic during resource addition

Source: https://wpamelia.com/documentation/wp-resources-hooks

Use amelia_before_resource_added or amelia_after_resource_added to trigger custom actions relative to the resource creation process.

```php
function example($resource)
{
    // do action
}

add_action('amelia_before_resource_added', 'example', 10, 1);
```

```php
function example($resource)
{
    // do action
}

add_action('amelia_after_resource_added', 'example', 10, 1);
```

--------------------------------

### Manual Plugin Update

Source: https://wpamelia.com/documentation/faq

Instructions for manually updating the Amelia plugin by uploading the installation file.

```text
Plugins → Add new and upload the `ameliabooking.zip` file
```

--------------------------------

### GET /notifications/sms/history

Source: https://wpamelia.com/documentation/api-notifications

Retrieves the history of SMS notifications sent through the system.

```APIDOC
## GET /notifications/sms/history

### Description
Use this endpoint to retrieve SMS notification history.

### Method
GET

### Endpoint
{{your_site_URL}}/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/notifications/sms/history

### Authorization
Requires 'Amelia' API key in the request header.

### Response
#### Success Response (200)
- **message** (string) - Success message
- **data** (object) - Contains notifications array and countFiltered

#### Response Example
{
  "message": "Successfully retrieved notifications.",
  "data": {
    "notifications": [
      {
        "id": 23,
        "notificationId": 15,
        "userId": 2,
        "appointmentId": 762,
        "dateTime": "2026-03-06 14:50:55",
        "status": "prepared",
        "userFullName": "Milica Nikolić"
      }
    ],
    "countFiltered": 23
  }
}
```

--------------------------------

### Execute code before coupon addition

Source: https://wpamelia.com/documentation/wp-coupons-hooks

The amelia_before_coupon_added action runs before a new coupon is added.

```php
function example($coupon)
{
    // do action
}

add_action('amelia_before_coupon_added', 'example', 10, 1);
```

--------------------------------

### GET /locations/{{location_id}}

Source: https://wpamelia.com/documentation/api-locations

Retrieves the details for a specific location by its ID.

```APIDOC
## GET /locations/{{location_id}}

### Description
Use this endpoint to retrieve details for a single location.

### Method
GET

### Endpoint
/api/v1/locations/{{location_id}}

### Parameters
#### Path Parameters
- **location_id** (integer) - Required - The unique identifier of the location.

### Response
#### Success Response (200)
- **message** (string) - Success message.
- **data** (object) - Contains the location object with details like id, status, name, address, and coordinates.

### Response Example
{
  "message": "Successfully retrieved location.",
  "data": {
    "location": {
      "id": 11,
      "status": "visible",
      "name": "Downtown studio",
      "description": "Main location for in-person appointments.",
      "address": "179 W North Ave, Northlake, IL, USA",
      "phone": "+12025550123",
      "latitude": 41.908659,
      "longitude": -87.912162
    }
  }
}
```

--------------------------------

### Execute code before location addition

Source: https://wpamelia.com/documentation/wp-hooks-locations

The amelia_before_location_added action runs immediately before a location is added.

```php
function example($location) {
    // do action
}
add_action('amelia_before_location_added', 'example', 10, 1);
```

--------------------------------

### Execute code before payment link callback

Source: https://wpamelia.com/documentation/wp-hooks-payments

Use the amelia_before_payment_link_callback action to run custom logic immediately before a payment link or panel payment callback.

```php
function example($payment, $data)
{
    // do action
}

add_action('amelia_before_payment_link_callback', 'example', 10, 2);
```

--------------------------------

### GET /appointments/{{appointment_id}}

Source: https://wpamelia.com/documentation/api-appointments

Retrieves the details of a specific appointment by its unique identifier.

```APIDOC
## GET /appointments/{{appointment_id}}

### Description
Retrieves the details of a specific appointment by its unique identifier.

### Method
GET

### Endpoint
/appointments/{{appointment_id}}

### Parameters
#### Path Parameters
- **appointment_id** (integer) - Required - The unique identifier of the appointment.

### Response
#### Success Response (200)
- **message** (string) - Success message
- **data** (object) - The appointment data object

#### Response Example
{
  "message": "Successfully retrieved appointment",
  "data": {
    "appointment": {
      "id": 742,
      "bookings": [],
      "status": "pending",
      "serviceId": 1,
      "providerId": 1,
      "locationId": 2,
      "bookingStart": "2026-02-06 11:00:00",
      "bookingEnd": "2026-02-06 11:30:00"
    },
    "recurring": []
  }
}
```

--------------------------------

### Execute code before package retrieval

Source: https://wpamelia.com/documentation/wp-packages-hooks

The amelia_get_packages action runs before packages are retrieved for the back end.

```php
function example($packages)
{
    // do action
}

add_action('amelia_get_packages', 'example', 10, 1);
```

--------------------------------

### GET /users/providers/{{provider_id}}

Source: https://wpamelia.com/documentation/api-employees

Retrieves details for a single employee by their provider ID.

```APIDOC
## GET /users/providers/{{provider_id}}

### Description
Use this endpoint to retrieve details for a single employee.

### Method
GET

### Endpoint
{{your_site_URL}}/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/users/providers/{{provider_id}}

### Parameters
#### Path Parameters
- **provider_id** (integer) - Required - The unique identifier of the employee.

### Request Example
curl --location 'https://example-site.com/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/users/providers/88' \
--header 'Amelia: YOUR_API_KEY'

### Response
#### Success Response (200)
- **message** (string) - Status message.
- **data** (object) - Contains the user object.

#### Response Example
{
  "message": "Successfully retrieved user.",
  "data": {
    "user": {
      "id": 88,
      "firstName": "Ana",
      "lastName": "Marković",
      "email": "ana.jovanovic@example.test",
      "type": "provider",
      "status": "visible",
      "timeZone": "Europe/Belgrade"
    }
  }
}
```

--------------------------------

### Create a new service via cURL

Source: https://wpamelia.com/documentation/api-services

Use this request to add a new service to the Amelia system. Ensure the 'Amelia' header is populated with a valid API key.

```bash
curl --location 'https://example-site.com/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/services' \
--header 'Content-Type: application/json' \
--header 'Amelia: YOUR_API_KEY' \
--data '{
  "categoryId": 4,
  "color": "#1788FB",
  "description": "A focused 30-minute consultation for first-time clients.",
  "duration": 1800,
  "providers": [3],
  "extras": [
    {
      "description": "Add a deep conditioning treatment.",
      "descriptionHTML": "",
      "duration": 900,
      "maxQuantity": 1,
      "name": "Deep conditioning",
      "position": 1,
      "price": 10,
      "serviceId": 0,
      "translations": null
    }
  ],
  "maxCapacity": 1,
  "minCapacity": 1,
  "name": "Initial consultation",
  "pictureFullPath": "",
  "pictureThumbPath": "",
  "price": 35,
  "customPricing": "{\"enabled\": false, \"durations\": []}",
  "status": "visible",
  "bringingAnyone": false,
  "show": true,
  "gallery": [],
  "aggregatedPrice": false,
  "settings": "{\"payments\":{\"paymentLinks\":{\"enabled\":true,\"changeBookingStatus\":false,\"redirectUrl\":null},\"onSite\":true,\"payPal\":{\"enabled\":false},\"stripe\":{\"enabled\":false},\"mollie\":{\"enabled\":false},\"razorpay\":{\"enabled\":false}},\"zoom\":{\"enabled\":true},\"lessonSpace\":{\"enabled\":false}}",
  "recurringCycle": "disabled",
  "recurringSub": "future",
  "recurringPayment": 0,
  "position": 9,
  "deposit": 0,
  "depositPayment": "disabled",
  "depositPerPerson": false,
  "fullPayment": false,
  "translations": null,
  "minSelectedExtras": null,
  "mandatoryExtra": false,
  "maxExtraPeople": null,
  "limitPerCustomer": "{\"enabled\": false, \"numberOfApp\": 1, \"timeFrame\": \"day\", \"period\": 1, \"from\": \"bookingDate\"}"
}'
```

--------------------------------

### GET /notifications/email/test

Source: https://wpamelia.com/documentation/api-notifications

Sends a test email using a selected notification template.

```APIDOC
## GET /notifications/email/test

### Description
Use this endpoint to send a test email using a selected notification template.

### Method
GET

### Endpoint
/api/v1/notifications/email/test

### Parameters
#### Request Body
- **recipientEmail** (string) - Required - recipient email address
- **notificationTemplate** (integer) - Required - notification template ID
- **type** (string) - Required - appointment, event, or package
- **language** (string) - Optional - send language

### Response
#### Success Response (200)
- **message** (string) - Test email successfully sent
- **data** (null) - null
```

--------------------------------

### GET /notifications

Source: https://wpamelia.com/documentation/api-notifications

Retrieves a list of notification templates and available WhatsApp templates.

```APIDOC
## GET /notifications

### Description
Use this endpoint to retrieve notification templates and available WhatsApp templates.

### Method
GET

### Endpoint
{{your_site_URL}}/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/notifications

### Authorization
Requires 'Amelia' API key in the request header.

### Response
#### Success Response (200)
- **message** (string) - Success message
- **data** (object) - Contains notifications and whatsAppTemplates arrays

#### Response Example
{
  "message": "Successfully retrieved notification.",
  "data": {
    "notifications": [
      {
        "id": 123,
        "name": "customer_appointment_approved",
        "customName": "Customer appointment approved updated",
        "status": "enabled",
        "type": "email",
        "entity": "appointment",
        "sendTo": "customer"
      }
    ],
    "whatsAppTemplates": [
      {
        "name": "appointment_rejected",
        "language": "en",
        "status": "APPROVED",
        "category": "UTILITY",
        "id": "1524182254713483"
      }
    ]
  }
}
```

--------------------------------

### Create a new booking package via cURL

Source: https://wpamelia.com/documentation/api-packages

Use this cURL request to create a new package by sending a POST request to the Amelia API endpoint. Ensure the 'Amelia' header is populated with your valid API key.

```bash
curl --location 'https://example-site.com/wp-admin/admin-ajax.php?action=wpamelia_api&call=/api/v1/packages' \
--header 'Content-Type: application/json' \
--header 'Amelia: YOUR_API_KEY' \
--data '{
  "bookable": [
    {
      "service": { "id": 1 },
      "providers": [],
      "locations": [],
      "quantity": 1,
      "minimumScheduled": 0,
      "maximumScheduled": 1,
      "allowProviderSelection": true
    },
    {
      "service": { "id": 4 },
      "providers": [],
      "locations": [],
      "quantity": 1,
      "minimumScheduled": 0,
      "maximumScheduled": 1,
      "allowProviderSelection": false
    }
  ],
  "color": "#1788FB",
  "description": "A two-session package combining consultation and treatment at a discounted rate.",
  "name": "Starter wellness package",
  "pictureFullPath": "",
  "pictureThumbPath": "",
  "price": 55,
  "calculatedPrice": false,
  "discount": 0,
  "status": "visible",
  "gallery": [],
  "position": 9,
  "settings": "{\"payments\":{\"paymentLinks\":{\"enabled\":true,\"changeBookingStatus\":false,\"redirectUrl\":null},\"onSite\":true,\"payPal\":{\"enabled\":true},\"stripe\":{\"enabled\":false},\"mollie\":{\"enabled\":false},\"razorpay\":{\"enabled\":false}}}",
  "endDate": "2026-06-30 23:59",
  "durationCount": null,
  "durationType": null,
  "deposit": 0,
  "depositPayment": "disabled",
  "translations": null,
  "sharedCapacity": false,
  "quantity": 1,
  "limitPerCustomer": "{\"enabled\":true,\"numberOfApp\":1,\"timeFrame\":\"day\",\"period\":1}",
  "descriptionHtml": "A two-session package combining consultation and treatment at a discounted rate."
}'
```
Tokens:
Raw