Docs / API / Users

Users & Team Management

Track team members per tenant. Four roles. Invite tokens expire in 7 days.

Roles

RoleCapabilities
ownerFull admin. Only one per tenant. Cannot be deleted.
adminManage users, streams, IPs, files, settings.
developerSend emails, manage templates + streams, view analytics.
viewerRead-only access to analytics and event log.

List users

GET /api/users

Scopes: users:read

Create a user (no invite email)

POST /api/users

Scopes: users:write

body
{
  "email": "new@yourcompany.com",
  "name":  "New Person",
  "role":  "developer"
}

Change role

PUT /api/users/:id/role
body
{ "role": "admin" }

Suspend / delete

POST /api/users/:id/suspend
DELETE /api/users/:id

Owners can't be suspended or deleted. Transfer ownership first.

Invite via token

POST /api/users/invite
body
{
  "email": "new@yourcompany.com",
  "role":  "developer"
}

Returns { user, invite: { token, expiresAt } }. Email the token to the invitee (Mailgrid doesn't yet send invite emails for you — coming in v3.4).

Accept an invite

POST /api/users/accept-invite

No auth required. Public endpoint by design.

body
{
  "token": "",
  "name":  "Anna Builder"
}

Marks the user active and records joinedAt.