List Employees

GET/users

Last modified: 4 months ago

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

Request

Authorization

Inherited from project

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

Request samples

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

$ref(#/definitions/1389493)[]

optional

#/definitions/1389493

optional

pagination

#/definitions/1307303

optional

{
  "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": []
  }
}

Last modified: 4 months ago