Mindbody · Arazzo Workflow

Mindbody Staff Schedule Lookup

Version 1.0.0

Look up a staff member and retrieve their booked appointments for a date range.

1 workflow 1 source API 1 provider
View Spec View on GitHub FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooksArazzoWorkflows

Provider

mindbody

Workflows

staff-schedule-lookup
Resolve staff members and retrieve a provider's appointment schedule.
Lists the staff at the site and then retrieves the appointments booked for a specified staff member over the requested date range.
2 steps inputs: apiKey, authorization, endDate, siteId, staffId, startDate outputs: appointments, staffMembers
1
listStaff
getStaff
Retrieve the staff members at the site to confirm the provider exists before pulling their schedule.
2
listStaffAppointments
getStaffAppointments
Retrieve the appointments booked for the specified staff member across the requested date range.

Source API Descriptions

Arazzo Workflow Specification

mindbody-staff-schedule-lookup-workflow.yml Raw ↑
arazzo: 1.0.1
info:
  title: Mindbody Staff Schedule Lookup
  summary: Look up a staff member and retrieve their booked appointments for a date range.
  description: >-
    A scheduling visibility flow for studio managers. The workflow lists the
    staff members at a site, then pulls the appointments booked for the
    selected staff member across a date range so a manager can review the
    provider's upcoming schedule. Every step inlines the Mindbody API-Key,
    SiteId, and staff authorization headers so the flow can be read and
    executed without opening the underlying OpenAPI description.
  version: 1.0.0
sourceDescriptions:
- name: mindbodyApi
  url: ../openapi/mindbody-public-api-v6-openapi-original.yml
  type: openapi
workflows:
- workflowId: staff-schedule-lookup
  summary: Resolve staff members and retrieve a provider's appointment schedule.
  description: >-
    Lists the staff at the site and then retrieves the appointments booked for
    a specified staff member over the requested date range.
  inputs:
    type: object
    required:
    - apiKey
    - siteId
    - staffId
    properties:
      apiKey:
        type: string
        description: The Mindbody-issued API key sent in the API-Key header.
      siteId:
        type: string
        description: The ID of the site from which to pull data.
      authorization:
        type: string
        description: A staff user authorization (OAuth bearer) token.
      staffId:
        type: integer
        description: The ID of the staff member whose appointments are retrieved.
      startDate:
        type: string
        description: The start date of the appointment schedule lookup.
      endDate:
        type: string
        description: The end date of the appointment schedule lookup.
  steps:
  - stepId: listStaff
    description: >-
      Retrieve the staff members at the site to confirm the provider exists
      before pulling their schedule.
    operationId: getStaff
    parameters:
    - name: version
      in: path
      value: '6'
    - name: API-Key
      in: header
      value: $inputs.apiKey
    - name: siteId
      in: header
      value: $inputs.siteId
    - name: authorization
      in: header
      value: $inputs.authorization
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      staffMembers: $response.body#/StaffMembers
  - stepId: listStaffAppointments
    description: >-
      Retrieve the appointments booked for the specified staff member across
      the requested date range.
    operationId: getStaffAppointments
    parameters:
    - name: version
      in: path
      value: '6'
    - name: API-Key
      in: header
      value: $inputs.apiKey
    - name: siteId
      in: header
      value: $inputs.siteId
    - name: authorization
      in: header
      value: $inputs.authorization
    - name: request.staffIds
      in: query
      value: $inputs.staffId
    - name: request.startDate
      in: query
      value: $inputs.startDate
    - name: request.endDate
      in: query
      value: $inputs.endDate
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      appointments: $response.body#/Appointments
  outputs:
    staffMembers: $steps.listStaff.outputs.staffMembers
    appointments: $steps.listStaffAppointments.outputs.appointments