/v1/staff/list
Testing
GET
https://uat-api.wellnessliving.io/v1/staff/list
Request
id_region (query parameter): The ID of the region for which the staff list is requested.k_business (query parameter): The ID of the business for which the staff list is requested.Response
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"a_staff": {
"type": "object",
"description": "Contains staff details with each key representing a unique staff ID.",
"additionalProperties": {
"type": "object",
"properties": {
"a_pay_rate": {
"type": "array",
"description": "List of pay rate IDs associated with the staff member.",
"items": {
"type": "string"
}
},
"a_staff_service": {
"type": "array",
"description": "List of services the staff member provides and associated pay IDs.",
"items": {
"type": "object",
"properties": {
"k_service": {
"type": "string",
"description": "Unique service identifier."
},
"k_staff_pay": {
"type": ["string", "null"],
"description": "Payment ID associated with this service, or null if none."
}
},
"required": ["k_service"]
}
},
"i_order": {
"type": ["string", "integer"],
"description": "Order in which the staff member is displayed."
},
"is_appointment": {
"type": "boolean",
"description": "Indicates if the staff member provides appointment services."
},
"is_class": {
"type": "boolean",
"description": "Indicates if the staff member teaches classes."
},
"is_event": {
"type": "boolean",
"description": "Indicates if the staff member handles events."
},
"k_staff": {
"type": "string",
"description": "Unique identifier for the staff member."
},
"s_name": {
"type": "string",
"description": "First name of the staff member."
},
"s_surname": {
"type": "string",
"description": "Last name of the staff member."
},
"s_surname_full": {
"type": "string",
"description": "Full surname of the staff member."
},
"text_name_full": {
"type": "string",
"description": "Full name of the staff member."
},
"s_position": {
"type": "string",
"description": "Position or role of the staff member."
},
"s_image": {
"type": "string",
"description": "URL of the staff member's profile image."
},
"url_image": {
"type": "string",
"description": "Alternative URL for the staff member's image."
},
"html_name": {
"type": "string",
"description": "HTML-formatted name of the staff member."
},
"uid": {
"type": "string",
"description": "Unique user identifier for the staff member."
}
},
"required": ["k_staff", "s_name", "s_surname", "text_name_full"]
}
},
"status": {
"type": "string",
"enum": ["ok"],
"description": "Status of the response."
},
"s_version": {
"type": "string",
"description": "Version identifier for the response format."
}
},
"required": ["a_staff", "status", "s_version"]
}a_staff(Staff Information):
Unique keys represent each staff member.
Contains name, position, image, and services provided.a_pay_rate(Pay Rates):
Lists pay rate IDs assigned to the staff.a_staff_service(Services & Pay Information):
Services a staff member provides, with optional pay IDs.Boolean Flags ( is_appointment,is_class,is_event)
Indicate the type of services the staff handles.
Request
Query Params
id_region
string
required
Example:
2
k_business
string
required
Example:
49197