Get Appointments with Acuity Scheduling API

Pipedream makes it easy to connect APIs for Acuity Scheduling and 2,700+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Get Appointments with the Acuity Scheduling API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Get Appointments with the Acuity Scheduling API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Get Appointments action
1. Connect your Acuity Scheduling account
2. Optional- Configure Min Date
3. Optional- Configure Max Date
4. Optional- Select a Calendar ID
5. Optional- Select a Appointment Type ID
6. Optional- Configure Canceled
7. Optional- Configure Show All
8. Optional- Configure Exclude Forms
9. Optional- Configure Email
10. Optional- Configure First Name
11. Optional- Configure Last Name
12. Optional- Configure Phone
13. Optional- Configure Max Results
14. Optional- Select a Direction
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Get Appointments with Acuity Scheduling API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Acuity Scheduling

Try it

Get Appointments with Acuity Scheduling API on New Submission from Typeform API

Typeform + Acuity Scheduling

Try it

Get Appointments with Acuity Scheduling API on New Submission (Instant) from Jotform API

Jotform + Acuity Scheduling

Try it

Get Appointments with Acuity Scheduling API on New Scheduled Tasks from Pipedream API

Pipedream + Acuity Scheduling

Try it

Get Appointments with Acuity Scheduling API on New Download Counts from npm API

npm + Acuity Scheduling

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Get Appointments on Acuity Scheduling

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

Version:0.0.1

Key:acuity_scheduling-get-appointments

View on GitHub

Code#

import acuityScheduling from "../../acuity_scheduling.app.mjs";

export default {
  key: "acuity_scheduling-get-appointments",
  name: "Get Appointments",
  description: "Return a list of appointments. [See the documentation](https://developers.acuityscheduling.com/reference/get-appointments)",
  version: "0.0.1",
  type: "action",
  props: {
    acuityScheduling,
    minDate: {
      type: "string",
      label: "Min Date",
      description: "Show appointments after this date (YYYY-MM-DD)",
      optional: true,
    },
    maxDate: {
      type: "string",
      label: "Max Date",
      description: "Show appointments before this date (YYYY-MM-DD)",
      optional: true,
    },
    calendarId: {
      propDefinition: [
        acuityScheduling,
        "calendarId",
      ],
      optional: true,
    },
    appointmentTypeId: {
      propDefinition: [
        acuityScheduling,
        "appointmentTypeId",
      ],
      optional: true,
    },
    canceled: {
      type: "boolean",
      label: "Canceled",
      description: "Show only canceled appointments",
      optional: true,
    },
    showall: {
      type: "boolean",
      label: "Show All",
      description: "Show both canceled and scheduled appointments",
      optional: true,
    },
    excludeForms: {
      type: "boolean",
      label: "Exclude Forms",
      description: "Don't include intake forms in the response object (speeds up the response)",
      optional: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "Filter by client email address",
      optional: true,
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "Filter by client first name",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Filter by client last name",
      optional: true,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "Filter by client phone number",
      optional: true,
    },
    max: {
      type: "integer",
      label: "Max Results",
      description: "Maximum number of appointments to return",
      optional: true,
    },
    direction: {
      type: "string",
      label: "Direction",
      description: "Sort direction",
      options: [
        "ASC",
        "DESC",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const appointments = await this.acuityScheduling.listAppointments({
      $,
      params: {
        minDate: this.minDate,
        maxDate: this.maxDate,
        calendarID: this.calendarId,
        appointmentTypeID: this.appointmentTypeId,
        canceled: this.canceled,
        showall: this.showall,
        excludeForms: this.excludeForms,
        email: this.email,
        firstName: this.firstName,
        lastName: this.lastName,
        phone: this.phone,
        max: this.max,
        direction: this.direction,
      },
    });
    $.export("$summary", `Returned ${appointments.length} appointments.`);
    return appointments;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Acuity Scheduling	`acuityScheduling`	`app`	This component uses the Acuity Scheduling app.
Min Date	`minDate`	`string`	Show appointments after this date (YYYY-MM-DD)
Max Date	`maxDate`	`string`	Show appointments before this date (YYYY-MM-DD)
Calendar ID	`calendarId`	`string`	Select a value from the drop down menu.
Appointment Type ID	`appointmentTypeId`	`string`	Select a value from the drop down menu.
Canceled	`canceled`	`boolean`	Show only canceled appointments
Show All	`showall`	`boolean`	Show both canceled and scheduled appointments
Exclude Forms	`excludeForms`	`boolean`	Don't include intake forms in the response object (speeds up the response)
Email	`email`	`string`	Filter by client email address
First Name	`firstName`	`string`	Filter by client first name
Last Name	`lastName`	`string`	Filter by client last name
Phone	`phone`	`string`	Filter by client phone number
Max Results	`max`	`integer`	Maximum number of appointments to return
Direction	`direction`	`string`	Select a value from the drop down menu:`ASCDESC`

Authentication#

Acuity Scheduling uses OAuth authentication. When you connect your Acuity Scheduling account, Pipedream will open a popup window where you can sign into Acuity Scheduling and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Acuity Scheduling API.

Pipedream requests the following authorization scopes when you connect your account:

api-v1

About Acuity Scheduling#

Online Appointment Scheduling

More Ways to Use Acuity Scheduling#

Triggers#

New Appointment (Instant) from the Acuity Scheduling API

Emit new event when an appointment is scheduled.

Try it

New Appointment Canceled (Instant) from the Acuity Scheduling API

Emit new event when an appointment is canceled.

Try it

Actions#

Add Blocked Off Time with the Acuity Scheduling API

Blocks a specific time slot on your schedule to prevent the scheduling of any appointments during this particular time range. See the documentation

Try it

Book Appointment with the Acuity Scheduling API

Book an appointment. See the documentation

Try it

Check Availability Times with the Acuity Scheduling API

Validate available times for an appointment. See the documentation

Try it

Find Appointments by Client Info with the Acuity Scheduling API

Retrieves existing appointments using the client's information, allowing you to track all the appointments associated with a specific client. See the documentation

Try it

Get Appointment Types with the Acuity Scheduling API

Return a list ofappointment types. See the documentation

Try it