List Employees

GET/users

[updatedIn] 2 months ago

This endpoint allows you to fetch a list of your store employees.

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

to [header]，whose value is to concatenate the Token after the Bearer.

[api.label.example]

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Request samples

[api.label.responses]

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

array[object (Employees) {7}]

optional

number

required

A unique identifier assigned to an individual employee working at a specific store. List of employees can be found here.

Example:

282459793

name

string

required

Given name of store employee.

Example:

Taleb

mobile

string

required

Store employee mobile number.

Example:

580885751

mobile_code

string

required

Store employee mobile Code

Example:

+966

string

required

Email address of the store employee.

Example:

[email protected]

role

enum<string>

required

Role of the store employee. Value can either be user or team

Allowed values:

userteam

Example:

team

status

enum<string>

required

Status of the store employee. Value can either be active or suspended

Allowed values:

activesuspended

Example:

suspended

pagination

object (Pagination)

optional

For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.

count

number

required

Number of returned results.

total

number

required

Number of all results.

perPage

number

required

Number of results per page.

<= 65

currentPage

number

required

Number of current page.

totalPages

number

required

Number of total pages.

links

object

required

Array of linkes to next and previous pages.

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 282459793,
      "name": "User Name1",
      "mobile": "777654321",
      "mobile_code": "+967",
      "email": "[email protected]",
      "role": "team",
      "status": "suspended"
    },
    {
      "id": 1148378730,
      "name": "User Name2",
      "mobile": "777654321",
      "mobile_code": "+967",
      "email": "[email protected]",
      "role": "team",
      "status": "suspended"
    },
    {
      "id": 1697216187,
      "name": "User Name3",
      "mobile": "777654321",
      "mobile_code": "+967",
      "email": "[email protected]",
      "role": "user",
      "status": "suspended"
    },
    {
      "id": 1296225140,
      "name": "User Name4",
      "mobile": "777654321",
      "mobile_code": "+967",
      "email": "[email protected]",
      "role": "team",
      "status": "suspended"
    },
    {
      "id": 467410228,
      "name": "User Name5",
      "mobile": "777654321",
      "mobile_code": "+967",
      "email": "[email protected]",
      "role": "user",
      "status": "suspended"
    },
    {
      "id": 355137381,
      "name": "User Name6",
      "mobile": "777654321",
      "mobile_code": "+967",
      "email": "[email protected]",
      "role": "team",
      "status": "suspended"
    },
    {
      "id": 115245908,
      "name": "User Name7",
      "mobile": "777654321",
      "mobile_code": "+967",
      "email": "[email protected]",
      "role": "team",
      "status": "suspended"
    },
    {
      "id": 1072903216,
      "name": "User Name8",
      "mobile": "555555555",
      "mobile_code": "+966",
      "email": "[email protected]",
      "role": "user",
      "status": "suspended"
    },
    {
      "id": 1689171978,
      "name": "User",
      "mobile": "555555555",
      "mobile_code": "+966",
      "email": "[email protected]",
      "role": "user",
      "status": "active"
    },
    {
      "id": 2133460396,
      "name": "User Name9",
      "mobile": "555555555",
      "mobile_code": "+966",
      "email": "[email protected]",
      "role": "team",
      "status": "suspended"
    },
    {
      "id": 1279539873,
      "name": "User Name Test",
      "mobile": "777654321",
      "mobile_code": "+967",
      "email": "[email protected]",
      "role": "user",
      "status": "active"
    },
    {
      "id": 27854744,
      "name": "User Name10",
      "mobile": "555555555",
      "mobile_code": "+966",
      "email": "[email protected]",
      "role": "user",
      "status": "active"
    },
    {
      "id": 446255397,
      "name": "User Name11",
      "mobile": "555555555",
      "mobile_code": "+966",
      "email": "[email protected]",
      "role": "team",
      "status": "active"
    },
    {
      "id": 1192353076,
      "name": "User Name12",
      "mobile": "777654321",
      "mobile_code": "+967",
      "email": "[email protected]",
      "role": "user",
      "status": "active"
    }
  ],
  "pagination": {
    "count": 16,
    "total": 16,
    "perPage": 30,
    "currentPage": 1,
    "totalPages": 1,
    "links": []
  }
}

[updatedIn] 2 months ago