About

This endpoint returns information about a user identified by their user ID. You can use this endpoint to fetch user profile details, including email, user ID, assigned role, role ID, name, surname, and status for active users. It supports pagination and role-based filtering.

Example

List all users (with pagination)

curl -X GET "https://api.picussecurity.com/v1/users?offset=0&limit=25" \
  -H "Access-Token: YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

{
  "users": [
    {
      "email": "john.doe@example.com",
      "user_id": 1001,
      "role": "Admin",
      "role_id": 2,
      "name": "John Doe",
      "surname": "Doe",
      "is_active": true
    },
    {
      "email": "jane.smith@example.com",
      "user_id": 1002,
      "role": "Viewer",
      "role_id": 4,
      "name": "Jane Smith",
      "surname": "Smith",
      "is_active": true
    }
  ],
  "pages": {
    "offset": 0,
    "limit": 25,
    "total_pages": 3,
    "total_count": 67
  }
}

List users with role filter

curl -X GET "https://api.picussecurity.com/v1/users?role=Admin&offset=0&limit=10" \
  -H "Access-Token: YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

{
  "users": [
    {
      "email": "john.doe@example.com",
      "user_id": 1001,
      "role": "Admin",
      "role_id": 2,
      "name": "John Doe",
      "surname": "Doe",
      "is_active": true
    }
  ],
  "pages": {
    "offset": 0,
    "limit": 25,
    "total_pages": 1,
    "total_count": 15
  }
}