SimpleSpa Documentation
Back to SimpleSpa
  • SimpleSpa Documentation
  • Scheduling Software
    • What is Scheduling Software
    • What is Salon Software
    • What is Spa Software
    • What is Medical Scheduling Software
    • What is Medi-Spa Scheduling Software
    • What is Microblading Software
  • Guides
    • General
    • Adding your first Service/Staff
    • Creating your first Appointment
    • Creating your first Transaction/Checking out a Client
  • Fundamentals
    • Dashboard
      • Overview
      • Viewing Appointments
      • Viewing Transactions
      • Making a Sale
      • Birthdays
    • Appointments
      • Calendar
      • Creating an Appointment
      • Appointment Status
      • Appointment Notes
      • Appointment Checkout
      • Creating a Block
      • Cloning a Block
    • POS
      • Recording a Sale
      • Balances & Deposits
      • Multiple Payment Methods
      • Processing Credit Cards
      • PCI Compliance
      • Common Checkouts & Tutorial Walkthroughs
        • Accepting Multiple Payments
        • Using Gift Certificates in Checkout
        • Accepting Appointment Deposits
        • Adding a Balance to a client
        • Assigning Staff during Checkout
        • Prompting and Collecting Tips
        • Applying Discounts during Checkout
        • Applying Notes & Change Calculator
    • Hardware
      • Receipt Printing
      • Thermal Receipt
      • Receipt Printer Setup
      • Cash drawer / Till
      • POS Terminal
    • Staff
      • Managing Staff
      • Fields and Settings
      • Calendar
      • Commissions Tab
      • Weekly Schedule Tab
      • Block Hours on Calendar
      • Breaks Tab
      • Clock In/Out Tab
      • How to Clock In/Out
      • Assigning Specialties
      • Staff Login
    • Clients
      • Managing Clients
      • Files
      • Images
      • Notes
      • Appointments
      • Transactions
      • Packages
      • Forms
    • Services
      • Managing Services
      • Fields and Service Settings
      • Adding Form(s) to Services
      • Assigning Resources to a Service
    • Products
      • Managing Products
      • Fields and Products Settings
      • Assign Tax Rate to all Products
      • Inventory
      • Orders
      • Vendors
    • Gift Cards
      • Gift Cards & Gift Certificates
      • Selling Gift Cards/Certificates
      • Sending Gift Cards/Certificates
      • Using Gift Cards/Certificates
      • Reloading Gift Cards/Certificates
      • Viewing Balance Gift Cards/Certificates
      • Viewing History Gift Cards/Certificates
      • Apple Wallet
    • Packages
      • Managing Packages
      • Selling Packages
      • Redeeming Packages
      • Manually Adjusting Clients Package Balance
      • Memberships
    • Forms
      • Managing Forms
      • Additional Settings
      • Additional Questions (Form Editor)
      • Assigning to a Service
      • Sending a Form
    • Users
      • Manage Users
      • User Roles
      • User Password
    • Discounts
      • Managing Discounts
      • Applying Discounts
    • Expenses
      • Managing Expenses
    • Online Booking
      • Your Custom Booking URL
      • Multiple Bookings
      • Accepting Deposits for Bookings
      • Linking & Embedding Online Booking
      • Adding a Holiday
      • Waitlist
    • Notifications
      • Email Notifications
      • SMS/Text Notifications
    • Marketing
      • Campaigns
      • Creating a New Campaign
      • Image Campaign
      • AI Campaign Generator
    • Mobile Device Support
      • iOS (iPhone & iPad)
      • Android
    • Browser Support
  • Extras
    • Video Walkthroughs
      • Creating your first appointment
      • Using the POS & completing an appointment
      • Making a sale without an appointment
      • Demo Walkthrough
    • FAQ
      • Is there anything to install?
      • Can I import my existing data to SimpleSpa?
      • How much does SimpleSpa cost?
      • Where can I get a SimpleSpa perpetual license?
      • How do I convert my SimpleSpa free trial to a paid subscription?
      • What kind of computer do I need?
      • What countries do you support?
      • How can I view the timestamp an appointment was created?
      • Do I need to download updates to my computer?
      • Does SimpleSpa have online booking?
      • Is online booking in my language?
      • How does SimpleSpa handle double booking for online appointments?
      • Does SimpleSpa send appointment reminders?
      • Does SimpleSpa send SMS/Text reminders?
      • How much does SMS/Text Notifications cost?
      • How can I add SMS/Text Notifications to my account?
      • Are the SimpleSpa Marketing Tools included in my plan?
      • I am already paying for SMS Notifications is SMS Marketing included in my package?
      • What businesses can use SimpleSpa?
      • Can I brand SimpleSpa with my logo?
      • Can I process Credit Cards with SimpleSpa?
      • What type of Credit Card Integration does SimpleSpa Support?
      • How can I disable Credit Card Auto-fill in Chrome?
      • Do plans have a minimum contract?
      • Can I downgrade my plan?
      • I am trying to login but it is redirecting to SimpleSpa.com
      • Does SimpleSpa Support Parallel Bookings
      • Does SimpleSpa support multiple business locations?
      • My online booking hours show different availability than what I have set in the staff page
      • I am a third party processor/reseller, can I work with SimpleSpa?
      • My staff will work on a different schedule on a specific date, can SimpleSpa handle this?
      • My online booking is not showing availability although I am available in my calendar
      • SimpleSpa HIPAA
      • How does SimpleSpa transmit data securely?
      • How is the data on the SimpleSpa network protected?
      • Can you provide me with more information about your data centers?
      • SimpleSpa iOS
  • API
    • SimpleSpa Enterprise API
      • Appointment Endpoint
      • Client Endpoint
      • Service Endpoint
      • Staff Endpoint
      • Ideas & Inspiration
      • Integrations
        • Zapier
        • Make.com
        • OpenAI
        • OpenAI & Cron Jobs
        • Ideas: Marketing Campaigns with Zapier, Make.com, Integrately
Powered by GitBook
On this page
  • Overview
  • Authentication
  • Appointments API
  • Endpoint
  • Authentication
  • Request Body
  • Example Request Body
  • Example CURL Request
  • Response Format
  • Response Fields
  • Notes
  1. API
  2. SimpleSpa Enterprise API

Staff Endpoint

Staff API access is read-only

Note: API Access is limited to Enterprise accounts and available upon request


Overview

The Staff API allows Enterprise accounts to retrieve a list of active staff offered at their business location, including service details like name, contact information, and general staff work hours.

Authentication

You must include a valid Authorization header using your SimpleSpa API Key:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Replace YOUR_API_KEY with your SimpleSpa Enterprise API Key.

Appointments API

Endpoint

POST https://my.simplespa.com/api/staff.php

Authentication

You must include a valid Authorization header using your SimpleSpa API Key:

Header Name

Header Value

Authorization

Bearer YOUR_API_KEY

Content-Type

application/json

Replace YOUR_API_KEY with your SimpleSpa Enterprise API Key.

Request Body

The API expects a JSON body with optional parameters to control pagination and filtering.

Example Request Body

{
  "page": 1,
  "per_page": 100
}

Field

Type

Required

Description

page

integer

No

Page number to retrieve (default = 1)

per_page

integer

No

Number of results per page (maximum 1000)

Example CURL Request

curl -X POST https://my.simplespa.com/api/staff.php \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "page": 1,
  "per_page": 100
}'

Response Format

The API responds with a JSON object containing the list of staff members and pagination information.

Example Response

{
  "success": true,
  "staff": [
    {
      "staff_id": "1",
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "john@example.com",
      "phone": "+15551234567",
      "gender": "Male",
      "color_code": "#FF5733",
      "labels": ["Massage", "Therapy"],
      "label_ids": ["1", "2"],
      "working_hours": [
        { "day": 1, "start_time": "09:00", "end_time": "17:00" },
        { "day": 3, "start_time": "10:00", "end_time": "18:00" }
      ],
      "staff_image_url": "https://my.simplespa.com/uploads/staff/12345.jpg",
      "deleted": false
    }
  ],
  "page": 1,
  "per_page": 100,
  "total_results": 20
}

Response Fields

Field

Description

success

Always true if the request was successful

staff

List of staff records

staff_id

Unique ID of the staff member

first_name

Staff member’s first name

last_name

Staff member’s last name

email

Staff member’s email address

phone

Staff member’s phone number

gender

Gender of the staff member (if provided)

color_code

Assigned color code for calendar views

labels

Skills or categories associated with the staff

label_ids

IDs of the labels (category)

working_hours

Weekly working hours array (day: 0 = Monday, 6 = Sunday)

staff_image_url

Public URL of the staff member’s avatar image (if uploaded)

deleted

If true, this staff is currently inactive/deleted

page

Current page number

per_page

Number of results per page

total_results

Total number of staff available

Notes

  • Working Hours:

    Only the first time range per day is returned. Days without hours are skipped.

  • Pagination:

    Default per_page is 100 if not specified. Maximum allowed is 1000.

  • Filtering Inactive Staff:

    Only staff with active = 1 are returned (deleted staff are flagged with "deleted": true).

  • Rate Limiting:

    It is recommended to query no faster than once per minute

⚠️ IMPORTANT: Never expose your private API key in client-side JavaScript. Always use secure, server-side code to handle sensitive credentials.

PreviousService EndpointNextIdeas & Inspiration

Last updated 25 days ago

Page cover image