/v1/staff/list

Summary

Retrieve a list of staff members for a specific business location/region, including their scheduling flags and service/pay-rate configuration.

HTTP Request

GET /v1/staff/list

Base URL example (UAT):
https://uat-api.wellnessliving.io/v1/staff/list

Query Parameters

id_region (required, integer)

Identifies the geographic or logical region for which staff should be returned.

Example: id_region=2.

k_business (required, integer/string ID)

The business key for which to load staff records.

Example: k_business=49197.

Successful Response (200 OK)

A successful response returns JSON with staff keyed by their internal staff ID.

Top‑level fields:

a_staff (object)

Map of staff IDs to staff detail objects.

Each property key is a k_staff value (e.g., "479472", "100000067386").

status (string)

API status indicator, typically "ok" on success.

s_version (string)

API/version string of the response payload.

Staff Object (a_staff[])

Key properties for each staff entry:

k_staff (string)

Unique internal identifier for the staff member (matches the key under a_staff).

s_name (string)

Staff first name or display name (e.g., "Barbie").

s_surname, s_surname_full (string)

Staff last name / full surname (e.g., "Girl").

text_name_full (string)

Full display name, typically (e.g., "Barbie Girl").

html_name (string)

HTML-formatted version of the staff display name.

s_position (string)

Staff position or role label (may be empty).

s_image, url_image (string)

Image identifiers/URLs for the staff profile picture.

is_appointment (boolean)

true if the staff member can be booked for appointments.

is_class (boolean)

true if the staff member can be scheduled to lead classes.

is_event (boolean)

true if the staff member can be scheduled to lead events.

i_order (string/integer)

Sort order index used to order staff in UI listings.

Scheduling and pay‑related properties:

a_staff_service (array of objects)

List of services the staff member can perform.

Each item typically includes:

k_service (string): Service key.

k_staff_pay (string|null): Staff pay‑rate key for this service, if configured.

a_pay_rate (array of strings)

Collection of pay‑rate IDs associated with the staff member.

Example 200 OK Response (truncated)

{
  "a_staff": {
    "479472": {
      "k_staff": "479472",
      "s_name": "Barbie",
      "s_surname": "Girl",
      "text_name_full": "Barbie Girl",
      "html_name": "Barbie",
      "s_position": "",
      "s_image": "https://d1k5xu6ji7n0vs.cloudfront.net/f/...",
      "url_image": "https://d1k5xu6ji7n0vs.cloudfront.net/f/...",
      "is_appointment": true,
      "is_class": true,
      "is_event": true,
      "i_order": "1",
      "a_pay_rate": [
        "438632",
        "100000033694",
        "100000033718"
      ],
      "a_staff_service": [
        {
          "k_service": "235076",
          "k_staff_pay": "438632"
        },
        {
          "k_service": "235121",
          "k_staff_pay": "100000033696"
        }
        // ... additional services truncated ...
      ]
    },
    "479522": {
      "k_staff": "479522",
      "s_name": "Barbiensky",
      "s_surname": "Doll",
      "text_name_full": "Barbiensky Doll",
      "is_appointment": true,
      "is_class": true,
      "is_event": true,
      "a_pay_rate": ["438637"],
      "a_staff_service": [
        { "k_service": "235076", "k_staff_pay": "438637" }
        // ...
      ]
    }
    // ... additional staff entries truncated ...
  },
  "status": "ok",
  "s_version": "44408..."
}

Summary#

HTTP Request#

Query Parameters#

Successful Response (200 OK)#

Staff Object (a_staff[])#

Example 200 OK Response (truncated)#