Overview

Users are the people in your Allegrow workspace — the same list as the Team Members screen in the app. Each user can connect mailboxes, and each seat on your plan holds one user.

A user is in one of two states:

  • active — they've accepted their invite and signed up. Active users have an id, a role, and a summary of their connected mailboxes.
  • invited — they've been sent an invitation that hasn't been accepted yet. Invited users have id: null (an id is created when they sign up), an inviteExpiresAt date, and no mailboxes. Invitations expire after 30 days.

Roles are member or admin (plus a single owner who created the workspace); what each role can do is managed in the app.

A common use of these endpoints is coverage checking: a user with mailboxes: [] has a seat but hasn't connected anything yet, so nothing of theirs is being monitored. Invite User lets you create invitations programmatically — for example from your own onboarding flow when a new rep joins.

Start with List Users, then Get User for one active user's detail.