Skip to content

Users

As an Admin, you can view users via the API. Users are organized by role.

User Roles

RoleURL Slug
Adminadmins
Manager Leadermanager-leaders
Managermanagers
Sellersellers
Agentagents
Sourcing Agentsourcing-agents
Stock Managerstock-managers
Call Center Managercall-center-managers
Deliverydeliveries
Follow-Up Agentfollow-up-agents

List Users

GET/users/{role} Bearer Token

Retrieve a paginated list of users for a specific role. Replace {role} with the URL slug from the table above.

ParameterTypeRequiredDescription
per_pagenumberNoResults per page

Response

Success (200):

json
{
  "data": [
    {
      "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "full_name": "Kamal Admin",
      "email": "[email protected]",
      "phone": "0612345678",
      "status": "active",
      "created_at": "2025-01-05T08:00:00Z"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "limit": 50,
      "total": 12,
      "pages": 1
    }
  }
}

Show User

GET/users/{role}/{id} Bearer Token

Retrieve a single user by ID.

Response

Success (200):

json
{
  "data": {
    "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "full_name": "Kamal Admin",
    "email": "[email protected]",
    "phone": "0612345678",
    "status": "active",
    "created_at": "2025-01-05T08:00:00Z",
    "updated_at": "2025-01-10T12:00:00Z"
  },
  "meta": {}
}

Not found (404):

json
{
  "error": {
    "code": "HTTP_ERROR",
    "message": "Resource not found."
  }
}

WedoCOD API Documentation