/v1/login/search/staff-app/list

This endpoint retrieves a list of staff members based on the provided query parameters.

Request

Parameters:

id_region (number): The ID of the region for which the staff list is being retrieved.

k_business (number): The business key for which the staff list is being retrieved.

Response

Status: 200

Content-Type: application/json

The response is in JSON format and has the following schema:

a_list (array): An array of staff members with their details.

text_mail (string): The email address of the staff member.

text_name_first (string): The first name of the staff member.

text_name_last (string): The last name of the staff member.

text_phone (string): The phone number of the staff member.

text_title (string): The job title of the staff member.

uid (string): The unique identifier of the staff member.

can_add (boolean): Indicates whether the user has permission to add staff members.

status (string): The status of the response.

s_version (string): The version of the response.

__a_message (array): An array of messages.

{
    "type": "object",
    "properties": {
        "a_list": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "text_mail": {"type": "string"},
                    "text_name_first": {"type": "string"},
                    "text_name_last": {"type": "string"},
                    "text_phone": {"type": "string"},
                    "text_title": {"type": "string"},
                    "uid": {"type": "string"}
                },
                "additionalProperties": false
            }
        },
        "can_add": {"type": "boolean"},
        "status": {"type": "string"},
        "s_version": {"type": "string"},
        "__a_message": {
            "type": "array",
            "items": {"type": "string"}
        }
    },
    "additionalProperties": false
}

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Request#

Response#

Request

Request samples

Responses

Request

Response