Get All

GET

/:tenantId/users

Query Parameters

Name	Type	Description
search	string	Searches by name, email, mobile

Response

HTTP 200 OK

{
  "data": [
    {
      "id": 1,
      "email": "john.doe@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "name": "John Doe",
      "identity_number": null,
      "mobile": "+1234567890",
      "phone": "",
      "role_id": "admin",
      "status": 1,
      "color": "#fde6f0",
      "bonus_rate": "10.00",
      "photo": null
    },
    {
      "id": 2,
      "email": "jane.smith@example.com",
      "first_name": "Jane",
      "last_name": "Smith",
      "name": "Jane Smith",
      "identity_number": null,
      "mobile": "",
      "phone": "",
      "role_id": "specialist",
      "status": 1,
      "color": "#FDEAD7",
      "bonus_rate": "5.00",
      "photo": null
    },
    {
      "id": 3,
      "email": "mike.brown@example.com",
      "first_name": "Mike",
      "last_name": "Brown",
      "name": "Mike Brown",
      "identity_number": null,
      "mobile": "+9876543210",
      "phone": "",
      "role_id": "admin",
      "status": 1,
      "color": "#FEFBE8",
      "bonus_rate": "0.00",
      "photo": null
    },
    {
      "id": 4,
      "email": "alice.white@example.com",
      "first_name": "Alice",
      "last_name": "White",
      "name": "Alice White",
      "identity_number": null,
      "mobile": "+1122334455",
      "phone": "",
      "role_id": "personnel",
      "status": 1,
      "color": "#EFF8FF",
      "bonus_rate": "0.00",
      "photo": null
    },
    {
      "id": 5,
      "email": "charlie.green@example.com",
      "first_name": "Charlie",
      "last_name": "Green",
      "name": "Charlie Green",
      "identity_number": null,
      "mobile": "+5566778899",
      "phone": "",
      "role_id": "admin",
      "status": 1,
      "color": "#fff9e6",
      "bonus_rate": "0.00",
      "photo": null
    }
  ],
  "links": {
    "first": "https://<Base URL>/api/v1/:tenantId/users?page=1",
    "last": "https://<Base URL>/api/v1/:tenantId/users?page=2",
    "prev": null,
    "next": "https://<Base URL>/api/v1/:tenantId/users?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 2,
    "links": [
      {
        "url": null,
        "label": "pagination.previous",
        "active": false
      },
      {
        "url": "https://<Base URL>/api/v1/:tenantId/users?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": "https://<Base URL>/api/v1/:tenantId/users?page=2",
        "label": "2",
        "active": false
      },
      {
        "url": "https://<Base URL>/api/v1/:tenantId/users?page=2",
        "label": "pagination.next",
        "active": false
      }
    ],
    "path": "https://<Base URL>/api/v1/:tenantId/users",
    "per_page": 5,
    "to": 5,
    "total": 10
  }
}