Users API

Endpoints

List users

GET /api/v1/users

Returns all users in the organisation.

Query parameters: | Parameter | Type | Description | |-----------|------|------------| | department_id | string | Filter by department | | role | string | Filter by role (member, approver, admin) | | status | string | Filter by status (active, deactivated) |

Response:

{
  "users": [
    {
      "id": "usr_abc123",
      "email": "john@company.com",
      "first_name": "John",
      "last_name": "Smith",
      "role": "member",
      "department_id": "dep_xyz",
      "start_date": "2024-01-15",
      "status": "active"
    }
  ]
}

Get user

GET /api/v1/users/{id}

Returns a single user by ID.

Update user

PATCH /api/v1/users/{id}

Update user fields. Only admins can update other users.

{
  "role": "approver",
  "department_id": "dep_new"
}