api referenceGET
POST
POST
GET
Users
User management, invitations, and API key rotation.
GET/api/users
List users in the org. Requires view_users. api_key is only populated for the caller's own row, or every row if the caller is an admin.
| Param | Type | Required | Description |
|---|---|---|---|
include_disabled | boolean | No | Include disabled users. Defaults to false. |
Response
[
{ "id": 12, "org_id": 1, "name": "Jane Doe", "email": "[email protected]", "groups": [1, 4], "is_invitation_pending": false, "disabled": false, "digest_enabled": true }
]POST/api/users
Invite a new user (requires manage_users). Sends an invitation email automatically; the returned row never includes an api_key.
Request
{ "name": "New Hire", "email": "[email protected]", "groups": [1] }POST/api/users/{id}/regenerate_api_key
Rotate a user's API key, invalidating the old one immediately.
Response
{ "api_key": "a1b2c3d4e5f6..." }GET/api/users/{id}/effective_permissions
Admin-only: the flat permission set a user effectively holds via their groups' linked roles.
Response
{ "permissions": ["view_query", "create_query"], "is_admin": false }