# Get Appointments — Acuity Scheduling

> Return a list of appointments. See the documentation

- Key: `acuity_scheduling-get-appointments`
- Type: Action (Read-only)
- Version: 0.0.2
- App: Acuity Scheduling (`acuity_scheduling`) — https://pipedream.com/apps/acuity-scheduling.md
- This page (HTML): https://pipedream.com/apps/acuity-scheduling/actions/get-appointments
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/acuity_scheduling/actions/get-appointments/get-appointments.mjs

## Description

Return a list of appointments. [See the documentation](https://developers.acuityscheduling.com/reference/get-appointments)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `minDate` | `string` | No | Show appointments after this date (YYYY-MM-DD) |
| `maxDate` | `string` | No | Show appointments before this date (YYYY-MM-DD) |
| `calendarId` | `string` | No | Show only appointments on calendar with specified ID. Options are loaded from the connected account. |
| `appointmentTypeId` | `string` | No | Show only appointments of this type. Options are loaded from the connected account. |
| `canceled` | `boolean` | No | Show only canceled appointments |
| `showall` | `boolean` | No | Show both canceled and scheduled appointments |
| `excludeForms` | `boolean` | No | Don't include intake forms in the response object (speeds up the response) |
| `email` | `string` | No | Filter by client email address |
| `firstName` | `string` | No | Filter by client first name |
| `lastName` | `string` | No | Filter by client last name |
| `phone` | `string` | No | Filter by client phone number |
| `max` | `integer` | No | Maximum number of appointments to return |
| `direction` | `string` | No | Sort direction |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "acuity_scheduling",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "acuity_scheduling-get-appointments",
  arguments: {
    minDate: "Min Date",
    maxDate: "Max Date",
  },
})
```

**TypeScript**

```ts
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "acuity_scheduling-get-appointments",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    acuity_scheduling: { authProvisionId: "apn_xxxxxxx" },
    minDate: "Min Date",
    maxDate: "Max Date",
  },
})

console.log(result)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "acuity_scheduling-get-appointments",
    "configured_props": {
      "acuity_scheduling": { "authProvisionId": "apn_xxxxxxx" },
      "minDate": "Min Date",
      "maxDate": "Max Date"
    }
  }'
```

---

- App: https://pipedream.com/apps/acuity-scheduling.md · All apps: https://pipedream.com/apps