Users API¶
Manage user profiles and organization membership.
Who this is for¶
Developer Admin
Endpoints¶
| Method | Path | Description |
|---|---|---|
| GET | /v1/users | List users |
| GET | /v1/users/{id} | Get a user |
| PUT | /v1/users/{id} | Update a user |
| POST | /v1/users/{id}/deactivate | Deactivate a user |
| GET | /v1/users/me | Get current user |
List users¶
Query parameters:
| Parameter | Type | Description |
|---|---|---|
role | string | Filter by role |
status | string | active, inactive, pending |
group | string | Filter by group membership |
Deactivate a user¶
POST /v1/users/usr_abc123/deactivate
Content-Type: application/json
{
"reason": "Offboarding",
"transfer_ownership_to": "usr_def456"
}
Data ownership transfer
When deactivating, specify a user to transfer initiative ownership to. Without this, initiatives remain owned by the deactivated user.
Permissions¶
| Action | Required Permission |
|---|---|
| List | admin:users |
| Get | admin:users or self |
| Update | admin:users or self |
| Deactivate | admin:users |
Limits¶
Limit Maximum users per tenant varies by plan (Starter: 25, Professional: 100, Enterprise: 500, Enterprise Plus: custom).