### Appointments API

Source: https://developers.acuityscheduling.com/reference/index

This section provides examples for retrieving appointments using various programming languages.

```APIDOC
## Appointments API Example

### Description
This endpoint allows you to retrieve appointment data. The examples below demonstrate how to make a request using JavaScript, PHP, and cURL.

### Method
GET

### Endpoint
`https://acuityscheduling.com/api/v1/appointments`

### Request Example (JavaScript)
```javascript
var Acuity = require('acuityscheduling');

var acuity = Acuity.basic({
  userId: ACUITY_USER_ID,
  apiKey: 'ACUITY_API_KEY'
});

acuity.request('appointments', function (err, res, appointments) {
  if (err) return console.error(err);
  console.log(appointments);
});
```

### Request Example (PHP SDK)
```php
<?php
require_once('vendor/autoload.php');

$acuity = new AcuityScheduling(array(
  'userId' => ACUITY_USER_ID,
  'apiKey' => 'ACUITY_API_KEY'
));

$appointments = $acuity->request('appointments');
print_r($appointments);
?>
```

### Request Example (PHP cURL)
```php
<?php

$userID = 'ACUITY_USER_ID';
$key = 'ACUITY_API_KEY';

// URL for all appointments (just an example):
$url = 'https://acuityscheduling.com/api/v1/appointments.json';

// Initiate curl:
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, "$userID:$key");

// Execute request:
$result = curl_exec($ch);
curl_close($ch);

$data = json_decode($result, true);
print_r($data);

?>
```
```

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

### GET /appointments

Source: https://developers.acuityscheduling.com/reference/quick-start

This example shows how to retrieve a list of appointments using the Acuity Scheduling API with different client libraries and direct cURL requests.

```APIDOC
## GET /appointments

### Description

This endpoint retrieves a list of appointments. The examples below demonstrate how to make this request using cURL, the Acuity JavaScript SDK, and PHP.

### Method

GET

### Endpoint

`https://acuityscheduling.com/api/v1/appointments`

### Request Example (cURL)

```shell
curl -u YOUR_USER_ID:YOUR_API_KEY "https://acuityscheduling.com/api/v1/appointments"
```

### Request Example (JavaScript SDK)

```javascript
var Acuity = require('acuityscheduling');

var acuity = Acuity.basic({
  userId: YOUR_USER_ID,
  apiKey: 'YOUR_API_KEY'
});

acuity.request('appointments', function (err, res, appointments) {
  if (err) return console.error(err);
  console.log(appointments);
});
```

### Request Example (PHP SDK)

```php
<?php
require_once('vendor/autoload.php');

$acuity = new AcuityScheduling(array(
  'userId' => YOUR_USER_ID,
  'apiKey' => 'YOUR_API_KEY'
));

$appointments = $acuity->request('appointments');
print_r($appointments);
?>
```

### Request Example (PHP cURL)

```php
<?php

$userID = 'YOUR_USER_ID';
$key = 'YOUR_API_KEY';

$url = 'https://acuityscheduling.com/api/v1/appointments.json';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
custom_curl_setopt($ch, CURLOPT_USERPWD, "$userID:$key");

$result = curl_exec($ch);
custom_curl_close($ch);

$data = json_decode($result, true);
print_r($data);
?>
```

### Response Example (Success)

```json
{
  "example": "response body"
}
```
```

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

### Authenticate and Fetch Appointments with PHP (PHP-SDK)

Source: https://developers.acuityscheduling.com/reference/quick-start

This PHP snippet uses the `acuityscheduling` SDK to fetch appointments. Ensure you have installed the SDK using Composer (`vendor/autoload.php`). Replace `ACUITY_USER_ID` and `ACUITY_API_KEY` with your credentials.

```php
<?php
require_once('vendor/autoload.php');

$acuity = new AcuityScheduling(array(
  'userId' => ACUITY_USER_ID,
  'apiKey' => 'ACUITY_API_KEY'
));

$appointments = $acuity->request('appointments');
print_r($appointments);
?>
```

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

### Fetch Appointments using Acuity Scheduling JavaScript SDK

Source: https://developers.acuityscheduling.com/reference/index

This example shows how to retrieve appointments using the Acuity Scheduling JavaScript SDK. It requires initializing the SDK with your User ID and API Key, then making a request to the 'appointments' endpoint.

```javascript
var Acuity = require('acuityscheduling');

var acuity = Acuity.basic({
  userId: ACUITY_USER_ID,
  apiKey: 'ACUITY_API_KEY'
});

acuity.request('appointments', function (err, res, appointments) {
  if (err) return console.error(err);
  console.log(appointments);
});
```

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

### Authenticate and Fetch Appointments with PHP (cURL)

Source: https://developers.acuityscheduling.com/reference/quick-start

This PHP example uses cURL to authenticate and fetch appointments. It manually sets up the cURL request with HTTP Basic Auth. Replace `ACUITY_USER_ID` and `ACUITY_API_KEY` with your credentials.

```php
<?php

$userID = 'ACUITY_USER_ID';
$key = 'ACUITY_API_KEY';

// URL for all appointments (just an example):
$url = 'https://acuityscheduling.com/api/v1/appointments.json';

// Initiate curl:
// GET request, so no need to worry about setting post vars:
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);

// Grab response as string:
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// HTTP auth:
curl_setopt($ch, CURLOPT_USERPWD, "$userID:$key");

// Execute request:
$result = curl_exec($ch);

// Don't forget to close the connection!
curl_close($ch);

$data = json_decode($result, true);
print_r($data);
?>
```

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

### Fetch Appointments using PHP cURL

Source: https://developers.acuityscheduling.com/reference/index

This example shows how to fetch appointments using PHP's cURL library. It manually sets up the cURL request with HTTP Basic Authentication and retrieves the JSON response.

```php
<?php

$userID = 'ACUITY_USER_ID';
$key = 'ACUITY_API_KEY';

// URL for all appointments (just an example):
$url = 'https://acuityscheduling.com/api/v1/appointments.json';

// Initiate curl:
// GET request, so no need to worry about setting post vars:
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);

// Grab response as string:
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// HTTP auth:
curl_setopt($ch, CURLOPT_USERPWD, "$userID:$key");

// Execute request:
$result = curl_exec($ch);

// Don't forget to close the connection!
curl_close($ch);

$data = json_decode($result, true);
print_r($data);
```

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

### Search Clients - Bash

Source: https://context7.com/context7/developers_acuityscheduling_reference/llms.txt

Searches for clients within Acuity Scheduling using the API. This bash example uses curl to send a GET request to the '/clients' endpoint with a 'search' query parameter to filter results by name, phone, or other criteria.

```bash
curl -u 12345678:abc123def456 \
  "https://acuityscheduling.com/api/v1/clients?search=Bob"
```

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

### Get Appointments (Shell)

Source: https://developers.acuityscheduling.com/reference/get-appointments

Retrieves a list of appointments from Acuity Scheduling. This example uses cURL with basic authentication, specifying a maximum number of results and a specific calendar ID. Ensure you replace ACUITY_USER_ID and ACUITY_API_KEY with your actual credentials.

```shell
curl -u ACUITY_USER_ID:ACUITY_API_KEY "https://acuityscheduling.com/api/v1/appointments?max=25&calendarID=27238"
```

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

### GET /products

Source: https://developers.acuityscheduling.com/reference/get-products

Retrieves a list of all products and packages available. This endpoint provides details about each product, including its ID, name, description, price, type, and other relevant attributes.

```APIDOC
## GET /products

### Description
Get a list of products and packages.

### Method
GET

### Endpoint
/products

### Parameters

#### Query Parameters

#### Request Body

### Request Example

### Response
#### Success Response (200)
- **id** (integer) - The product ID.
- **name** (string) - The name of the product.
- **description** (string) - The description of the product.
- **price** (number) - The price of the product in the account's currency.
- **type** (string) - The product type: `product` for regular products, `appointments` for packages of appointments, or `minutes` for packages of minutes.
- **hidden** (boolean) - Whether or not the product is hidden from the store.
- **expires** (integer) - The number of days from the date of purchase that a package expires. Null if it does not expire.
- **appointmentTypeIDs** (array of integers) - The appointment types that a package can be applied to.
- **appointmentTypeCounts** (object) - A hash containing the total number of appointments an `appointments` package may be redeemed for, keyed by appointment type ID; null otherwise.
- **minutes** (integer) - The total number of minutes of the selected appointment types a `minutes` package may be redeemed for; null otherwise.

#### Response Example
{
  "products": [
    {
      "id": 1,
      "name": "Basic Session",
      "description": "A 60-minute session.",
      "price": 100.00,
      "type": "product",
      "hidden": false,
      "expires": null,
      "appointmentTypeIDs": [],
      "appointmentTypeCounts": null,
      "minutes": null
    },
    {
      "id": 2,
      "name": "3-Session Package",
      "description": "Three 60-minute sessions.",
      "price": 250.00,
      "type": "appointments",
      "hidden": false,
      "expires": 30,
      "appointmentTypeIDs": [101, 102],
      "appointmentTypeCounts": {
        "101": 3,
        "102": 3
      },
      "minutes": null
    },
    {
      "id": 3,
      "name": "60-Minute Credits",
      "description": "60 minutes of session time.",
      "price": 90.00,
      "type": "minutes",
      "hidden": false,
      "expires": null,
      "appointmentTypeIDs": [101],
      "appointmentTypeCounts": null,
      "minutes": 60
    }
  ]
}
```

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

### Get Blocks - Shell Example

Source: https://developers.acuityscheduling.com/reference/blocks

This code snippet demonstrates how to retrieve a list of blocks from the Acuity Scheduling API using a cURL command in shell. It requires user ID and API key for authentication and specifies a maximum number of results. The response will contain block data or an error message if authentication fails.

```shell
curl -u ACUITY_USER_ID:ACUITY_API_KEY "https://acuityscheduling.com/api/v1/blocks?max=25"
```

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

### GET /products

Source: https://developers.acuityscheduling.com/reference/get-products

Retrieves a list of products and packages. This endpoint allows you to fetch all available products, optionally including deleted ones.

```APIDOC
## GET /products

### Description
Get a list of products and packages. This endpoint allows you to fetch all available products, optionally including deleted ones.

### Method
GET

### Endpoint
https://acuityscheduling.com/api/v1/products

### Parameters
#### Query Parameters
- **deleted** (boolean) - Optional - Retrieve deleted products. Defaults to false.

### Request Example
```bash
curl -u ACUITY_USER_ID:ACUITY_API_KEY "https://acuityscheduling.com/api/v1/products"
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the product.
- **name** (string) - The name of the product or package.
- **description** (string) - A detailed description of the product.
- **price** (string) - The price of the product.
- **type** (string) - The type of product (e.g., 'minutes', 'appointments', 'product').
- **hidden** (boolean) - Indicates if the product is hidden from view.
- **expires** (integer or null) - The expiration period in days, if applicable.
- **appointmentTypeIDs** (array of integers or null) - IDs of appointment types associated with this product.
- **appointmentTypeCounts** (object or null) - Counts of appointment types associated with this product.
- **minutes** (integer or null) - The number of build minutes included, if applicable.

#### Response Example
```json
[
  {
    "id": 6,
    "name": "120 Build Minutes",
    "description": "Hundred build minutes.",
    "price": "100.00",
    "type": "minutes",
    "hidden": false,
    "expires": null,
    "appointmentTypeIDs": [
      1,
      2,
      3
    ],
    "appointmentTypeCounts": null,
    "minutes": 120
  }
]
```

#### Error Response (401)
- **status_code** (integer) - The HTTP status code (401).
- **message** (string) - A message indicating unauthorized access.

#### Error Response Example
```json
{
  "status_code": 401,
  "message": "Unauthorized"
}
```
```

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

### Date and Time Format

Source: https://developers.acuityscheduling.com/reference/index

Guidance on formatting date and time parameters for API requests.

```APIDOC
## Date and Time Format

### Description
When supplying a date and time, make sure that the `datetime` parameter can be parsed by **strtotime()** in the business or calendar timezone.

### Parameter
- **datetime** (string) - The date and time to be parsed.

### Reference
For more information on how to format the `datetime` parameter, visit https://www.php.net/manual/en/function.strtotime.php.
```

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

### Fetch Appointments using Acuity Scheduling PHP SDK

Source: https://developers.acuityscheduling.com/reference/index

This code demonstrates fetching appointments using the Acuity Scheduling PHP SDK. It involves requiring the SDK, instantiating the client with credentials, and requesting appointment data.

```php
<?php
require_once('vendor/autoload.php');

$acuity = new AcuityScheduling(array(
  'userId' => ACUITY_USER_ID,
  'apiKey' => 'ACUITY_API_KEY'
));

$appointments = $acuity->request('appointments');
print_r($appointments);
```

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

### OpenAPI Definition for /me Endpoint

Source: https://developers.acuityscheduling.com/reference/get-me

This is the OpenAPI 3.1.0 definition for the /me endpoint of the Acuity Scheduling API. It specifies the request method (GET), responses (200 and 400), and provides an example of the expected JSON response for successful retrieval of account information.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "v1",
    "version": "1.1"
  },
  "servers": [
    {
      "url": "https://acuityscheduling.com/api/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/me": {
      "get": {
        "summary": "/me",
        "description": "Get basic account information.",
        "operationId": "get-me",
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"id\": 1,\n    \"email\": \"example@acuityscheduling.com\",\n    \"timezone\": \"America/New_York\",\n    \"firstDayOfWeek\": 0,\n    \"timeFormat\": \"ampm\",\n    \"currency\": \"USD\",\n    \"schedulingPage\": \"https://example.acuityscheduling.com/\",\n    \"embedCode\": \"<iframe>...</script>\",\n    \"plan\": \"Professional\",\n    \"name\": \"Example\",\n    \"description\": \"\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "example": 1,
                      "default": 0
                    },
                    "email": {
                      "type": "string",
                      "example": "example@acuityscheduling.com"
                    },
                    "timezone": {
                      "type": "string",
                      "example": "America/New_York"
                    },
                    "firstDayOfWeek": {
                      "type": "integer",
                      "example": 0,
                      "default": 0
                    },
                    "timeFormat": {
                      "type": "string",
                      "example": "ampm"
                    },
                    "currency": {
                      "type": "string",
                      "example": "USD"
                    },
                    "schedulingPage": {
                      "type": "string",
                      "example": "https://example.acuityscheduling.com/"
                    },
                    "embedCode": {
                      "type": "string",
                      "example": "<iframe>...</script>"
                    },
                    "plan": {
                      "type": "string",
                      "example": "Professional"
                    },
                    "name": {
                      "type": "string",
                      "example": "Example"
                    },
                    "description": {
                      "type": "string",
                      "example": ""
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false,
        "x-readme": {
          "code-samples": [
            {
              "language": "shell",
              "code": "curl -u ACUITY_USER_ID:ACUITY_API_KEY \"https://acuityscheduling.com/api/v1/me\""
            }
          ],
          "samples-languages": [
            "shell"
          ]
        }
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": false
  },
  "x-readme-fauxas": true
}
```

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

### Fetch Appointments using cURL

Source: https://developers.acuityscheduling.com/reference/index

This snippet demonstrates how to fetch appointments using a simple cURL command. It utilizes HTTP Basic Authentication with your User ID and API Key.

```bash
curl -u ACUITY_USER_ID:ACUITY_API_KEY "https://acuityscheduling.com/api/v1/appointments"
```

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

### Get Package Certificates (OpenAPI)

Source: https://developers.acuityscheduling.com/reference/get-certificates

This OpenAPI definition describes the /certificates endpoint for retrieving package certificates. It details the available query parameters for filtering and provides example responses for successful retrieval and error cases. The endpoint requires Basic authentication.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "v1",
    "version": "1.1"
  },
  "servers": [
    {
      "url": "https://acuityscheduling.com/api/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/certificates": {
      "get": {
        "summary": "/certificates",
        "description": "Get package certificates.",
        "operationId": "get-certificates",
        "parameters": [
          {
            "name": "productID",
            "in": "query",
            "description": "Get certificate codes for a particular product.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "orderID",
            "in": "query",
            "description": "Get certificate codes for a particular order.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "appointmentTypeID",
            "in": "query",
            "description": "Get certificate codes for a particular appointment type.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "email",
            "in": "query",
            "description": "Get valid codes for a particular email address.  Combine this with appointment type to suggest certificates to a client!",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "[
  {
    "id": 1,
    "certificate": "514794CC",
    "productID": 2,
    "orderID": null,
    "appointmentTypeIDs": [
      1
    ],
    "name": "5 Small Builds",
    "email": "",
    "type": "appointments",
    "remainingCounts": {
      "1": 5
    },
    "remainingMinutes": null,
    "expiration": null
  },
  {
    "id": 2,
    "certificate": "7FFF6C65",
    "productID": 3,
    "orderID": null,
    "appointmentTypeIDs": [
      1,
      2,
      3
    ],
    "name": "120 Build Minutes",
    "email": "",
    "type": "minutes",
    "remainingCounts": null,
    "remainingMinutes": 120,
    "expiration": null
  },
  ...
]"
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{
  "status_code": 400,
  "message": "The product \"10\" does not exist.",
  "error": "invalid_product"
}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status_code": {
                      "type": "integer",
                      "example": 400,
                      "default": 0
                    },
                    "message": {
                      "type": "string",
                      "example": "The product \"10\" does not exist."
                    },
                    "error": {
                      "type": "string",
                      "example": "invalid_product"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": false
  },
  "x-readme-fauxas": true
}
```

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

### GET /appointment-types

Source: https://developers.acuityscheduling.com/reference/appointment-types

Returns a list of all appointment types configured in your account.

```APIDOC
## GET /appointment-types

### Description
Returns a list of all appointment types configured in your account.

### Method
GET

### Endpoint
/appointment-types

### Parameters
#### Query Parameters
- None

### Request Example
No request body needed.

### Response
#### Success Response (200)
- **id** (integer) - appointment type ID
- **active** (boolean) - whether the appointment type is deleted
- **name** (string) - the name of the appointment type
- **description** (string) - the description of the appointment type
- **duration** (integer) - the duration in minutes
- **price** (number) - the price in the account's currency
- **category** (string) - the category of the appointment type
- **color** (string) - the color of the appointment type
- **private** (boolean) - whether or not the appointment type is a private type
- **type** (string) - the kind of appointment type: `service`, `class` or `series`
- **classSize** (integer or null) - the maximum class size for `class` or `series` types, `null` otherwise
- **paddingAfter** (integer) - the post-appointment padding in minutes
- **paddingBefore** (integer) - the pre-appointment padding in minutes
- **calendarIDs** (array of integers) - the IDs of calendars this type is offered on

#### Response Example
```json
[
  {
    "id": 12345,
    "active": true,
    "name": "Standard Massage",
    "description": "A relaxing 60-minute massage.",
    "duration": 60,
    "price": 80.00,
    "category": "Massage",
    "color": "#FFDDC1",
    "private": false,
    "type": "service",
    "classSize": null,
    "paddingAfter": 15,
    "paddingBefore": 10,
    "calendarIDs": [1, 2]
  }
]
```
```

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

### Get List of Blocks - OpenAPI Definition

Source: https://developers.acuityscheduling.com/reference/blocks

Defines the GET endpoint for retrieving a list of blocks for the authenticated user. Supports filtering by date range and calendar ID. Requires basic authentication.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "v1",
    "version": "1.1"
  },
  "servers": [
    {
      "url": "https://acuityscheduling.com/api/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/blocks": {
      "get": {
        "summary": "/blocks",
        "description": "Get a list of blocks for the authenticated user.",
        "operationId": "blocks",
        "parameters": [
          {
            "name": "max",
            "in": "query",
            "description": "Maximum number of results.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 100
            }
          },
          {
            "name": "minDate",
            "in": "query",
            "description": "Only get blocks this date and after (YYYY-MM-DD).",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "maxDate",
            "in": "query",
            "description": "Only get blocks this date and before (YYYY-MM-DD).",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "calendarID",
            "in": "query",
            "description": "Only get blocks on calendar with this ID.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "[
  {
    "description": "Every Wednesday 11:00am to 12:00pm starting  8 July 2015 ending 29 July 2015",
    "until": "2015-07-29T12:00:00-0700",
    "recurring": "weekly",
    "notes": "Recurring blocked time.",
    "end": "2015-07-08T12:00:00-0700",
    "start": "2015-07-08T11:00:00-0700",
    "calendarID": 1,
    "id": 4
  },
  {
    "description": "Wednesday  1 July 2015 11:00am - 12:00pm",
    "until": null,
    "recurring": null,
    "notes": "Blocked time.",
    "end": "2015-07-01T12:00:00-0700",
    "start": "2015-07-01T11:00:00-0700",
    "calendarID": 1,
    "id": 1
  },
  {
    "description": "Tuesday 30 June 11:00am -  1 Jul 2015 12:00pm",
    "until": null,
    "recurring": null,
    "notes": "Blocked time.",
    "end": "2015-07-01T12:00:00-0700",
    "start": "2015-06-30T11:00:00-0700",
    "calendarID": 2,
    "id": 3
  }
]"
                  }
                },
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "description": {
                        "type": "string",
                        "example": "Every Wednesday 11:00am to 12:00pm starting  8 July 2015 ending 29 July 2015"
                      },
                      "until": {
                        "type": "string",
                        "example": "2015-07-29T12:00:00-0700"
                      },
                      "recurring": {
                        "type": "string",
                        "example": "weekly"
                      },
                      "notes": {
                        "type": "string",
                        "example": "Recurring blocked time."
                      },
                      "end": {
                        "type": "string",
                        "example": "2015-07-08T12:00:00-0700"
                      },
                      "start": {
                        "type": "string",
                        "example": "2015-07-08T11:00:00-0700"
                      },
                      "calendarID": {
                        "type": "integer",
                        "example": 1,
                        "default": 0
                      },
                      "id": {
                        "type": "integer",
                        "example": 4,
                        "default": 0
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\"status_code\": 401, \"message\": \"Unauthorized\", \"error\": \"unauthorized\"}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status_code": {
                      "type": "integer"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```

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

### Create Appointment (PHP)

Source: https://context7.com/context7/developers_acuityscheduling_reference/llms.txt

Shows how to schedule a new appointment using the Acuity Scheduling PHP library. This example includes setting appointment details and intake form data, with authentication handled by the library.

```php
<?php
require_once('vendor/autoload.php');

$acuity = new AcuityScheduling(array(
  'userId' => 12345678,
  'apiKey' => 'abc123def456'
));

$appointment = $acuity->request('/appointments', array(
  'method' => 'POST',
  'data' => array(
    'appointmentTypeID' => 1,
    'datetime' => '2025-10-15T14:00:00-0700',
    'firstName' => 'Bob',
    'lastName' => 'McTest',
    'email' => 'bob.mctest@example.com',
    'fields' => array(
      array('id' => 1, 'value' => 'Party time!')
    )
  )
));

print_r($appointment);
?>
```

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

### GET /api/v1/products

Source: https://context7.com/context7/developers_acuityscheduling_reference/llms.txt

Retrieves available products and appointment packages, with an option to include deleted items.

```APIDOC
## List Products

### Description
Get products and appointment packages

### Method
GET

### Endpoint
/api/v1/products

### Parameters
#### Query Parameters
- **deleted** (boolean, optional) - Set to `true` to include deleted products. Defaults to `false`.

### Request Example
```bash
curl -u YOUR_USER_ID:YOUR_API_KEY \
  "https://acuityscheduling.com/api/v1/products?deleted=false"
```

### Response
#### Success Response (200)
- **id** (integer) - Unique identifier for the product.
- **name** (string) - The name of the product.
- **price** (string) - The price of the product.
- **type** (string) - The type of product ('appointments' or 'minutes').
- **appointmentTypeCounts** (object, optional) - For 'appointments' type, details on included appointment counts per type.
- **minutes** (integer, optional) - For 'minutes' type, the total minutes included.
- **expires** (integer, optional) - The number of days until the product expires after purchase.

#### Response Example
```json
[
  {
    "id": 201,
    "name": "First Session Package",
    "price": "75.00",
    "type": "appointments",
    "appointmentTypeCounts": {
      "101": 3
    }
  },
  {
    "id": 202,
    "name": "60 Minute Relaxation Package",
    "price": "90.00",
    "type": "minutes",
    "minutes": 60,
    "expires": 30
  }
]
```
```

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

### Create Appointment as Admin (Bash)

Source: https://context7.com/context7/developers_acuityscheduling_reference/llms.txt

Example for creating an appointment as an administrator, bypassing standard availability validation, and optionally disabling email notifications. Uses HTTP Basic Authentication and POST request.

```bash
curl -u 12345678:abc123def456 \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{
    "datetime": "2025-10-15T14:00:00-0700",
    "appointmentTypeID": 1,
    "calendarID": 27238,
    "firstName": "Bob",
    "lastName": "McTest",
    "email": "bob.mctest@example.com",
    "notes": "Customer requested specific time outside normal hours"
  }' \
  "https://acuityscheduling.com/api/v1/appointments?admin=true&noEmail=true"
```

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

### Authenticate and List Appointments (PHP)

Source: https://context7.com/context7/developers_acuityscheduling_reference/llms.txt

Provides a PHP example for authenticating with the Acuity Scheduling API and fetching appointments using the AcuityScheduling library. Requires User ID and API Key for basic authentication.

```php
<?php
require_once('vendor/autoload.php');

$acuity = new AcuityScheduling(array(
  'userId' => 12345678,
  'apiKey' => 'abc123def456'
));

$appointments = $acuity->request('appointments');
print_r($appointments);
?>
```

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

### Create Appointment (Bash)

Source: https://context7.com/context7/developers_acuityscheduling_reference/llms.txt

Example of creating a new appointment via the Acuity Scheduling API using Bash. It includes specifying appointment details, intake form data, and uses HTTP Basic Authentication for the POST request.

```bash
curl -u 12345678:abc123def456 \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{
    "datetime": "2025-10-15T14:00:00-0700",
    "appointmentTypeID": 1,
    "firstName": "Bob",
    "lastName": "McTest",
    "email": "bob.mctest@example.com",
    "phone": "555-1234",
    "fields": [
      {"id": 1, "value": "Party time!"},
      {"id": 2, "value": "First visit, Option A"}
    ]
  }' \
  "https://acuityscheduling.com/api/v1/appointments"
```

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

### Authentication

Source: https://developers.acuityscheduling.com/reference/quick-start

Authentication to the Acuity API is performed using HTTP Basic Auth with your User ID as the username and your API Key as the password. Unauthorized requests will result in a 401 error.

```APIDOC
## Authentication

### Description

To authenticate with the Acuity API, use HTTP Basic Authentication. Your numeric User ID serves as the username, and your API Key is used as the password. Successful authentication is required to access API resources. Failure to authenticate will result in a `401 Unauthorized` response.

For managing multiple Acuity accounts, consider using OAuth2.

### Method

HTTP Basic Auth

### Credentials

- **Username**: Your numeric Acuity User ID
- **Password**: Your Acuity API Key

### Example (cURL)

```shell
curl -u YOUR_USER_ID:YOUR_API_KEY "https://acuityscheduling.com/api/v1/appointments"
```
```

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

### Get Products List with cURL

Source: https://developers.acuityscheduling.com/reference/get-products

This snippet demonstrates how to retrieve a list of products and packages using a cURL command. It requires basic HTTP authentication with your Acuity user ID and API key. The request targets the /products endpoint of the v1 API.

```shell
curl -u ACUITY_USER_ID:ACUITY_API_KEY "https://acuityscheduling.com/api/v1/products"
```

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

### Retrieve Payment Transactions for Appointment (OpenAPI)

Source: https://developers.acuityscheduling.com/reference/get-appointments-id-payments

This OpenAPI definition describes the GET endpoint for retrieving payment transactions associated with a specific appointment. It specifies the request parameters, response structure, and example data.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "v1",
    "version": "1.1"
  },
  "servers": [
    {
      "url": "https://acuityscheduling.com/api/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/appointments/{id}/payments": {
      "get": {
        "summary": "/appointments/:id/payments",
        "description": "Retrieve a list of payment transactions for a particular appointment.",
        "operationId": "get-appointments-id-payments",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Appointment ID",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "[
  {
    "transactionID": "pi_123456abcdef",
    "created": "2016-01-22T09:27:51-0800",
    "processor": "stripe",
    "amount": "300.00"
  }
]"
                  }
                },
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "transactionID": {
                        "type": "string",
                        "example": "pi_123456abcdef"
                      },
                      "created": {
                        "type": "string",
                        "example": "2016-01-22T09:27:51-0800"
                      },
                      "processor": {
                        "type": "string",
                        "example": "stripe"
                      },
                      "amount": {
                        "type": "string",
                        "example": "300.00"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": false
  },
  "x-readme-fauxas": true
}
```

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

### Timezone Format

Source: https://developers.acuityscheduling.com/reference/index

Specifies the format for timezone values in API requests.

```APIDOC
## Timezone Format

### Description
Acuity uses strings in IANA Timezone Identifier format for specifying timezones.

### Format
IANA Timezone Identifier string

### Example
`"America/New_York"`
```

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

### GET /api/v1/forms

Source: https://context7.com/context7/developers_acuityscheduling_reference/llms.txt

Retrieves all intake forms and their associated field definitions.

```APIDOC
## List Forms

### Description
Get intake forms and their field definitions

### Method
GET

### Endpoint
/api/v1/forms

### Parameters
#### Query Parameters
None

### Request Example
```bash
curl -u YOUR_USER_ID:YOUR_API_KEY \
  "https://acuityscheduling.com/api/v1/forms"
```

### Response
#### Success Response (200)
- **id** (integer) - Unique identifier for the form.
- **name** (string) - The name of the form.
- **appointmentTypeIDs** (array) - Array of appointment type IDs associated with the form.
- **fields** (array) - An array of field definitions for the form.
  - **id** (integer) - Unique identifier for the field.
  - **name** (string) - The name of the field.
  - **type** (string) - The type of the field (e.g., 'text', 'textarea', 'dropdown').
  - **required** (boolean) - Indicates if the field is mandatory.
  - **options** (array, optional) - An array of options for dropdown or select fields.

#### Response Example
```json
[
  {
    "id": 1,
    "name": "New Client Intake",
    "appointmentTypeIDs": [101, 102],
    "fields": [
      {
        "id": 1,
        "name": "Full Name",
        "type": "text",
        "required": true
      },
      {
        "id": 2,
        "name": "Email Address",
        "type": "text",
        "required": true
      },
      {
        "id": 3,
        "name": "How did you hear about us?",
        "type": "dropdown",
        "required": false,
        "options": ["Google", "Referral", "Social Media"]
      }
    ]
  }
]
```
```

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

### GET /meta

Source: https://developers.acuityscheduling.com/reference/meta

Retrieves metadata for Acuity services, including information about webhook origins.

```APIDOC
## GET /meta

### Description
Metadata for Acuity services. This endpoint returns a list of IPv4 or IPv6 CIDRs from which webhooks will originate.

### Method
GET

### Endpoint
/meta

### Parameters

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **hooks** (array) - A list of IPv4 or IPv6 CIDRs from which webhooks will originate.

#### Response Example
```json
{
  "hooks": [
    "192.168.0.0/16",
    "2001:db8::/32"
  ]
}
```
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.