List Users

Returns every user in your workspace — including invited users who have not yet signed up — with a summary of each user's connected mailboxes.

Users with no connected mailboxes appear with mailboxes: [], which makes this the endpoint for spotting who has not connected yet. Invited users have status: invited, carry inviteExpiresAt instead of createdAt, and always have an empty mailbox list.

Results are sorted by email ascending and paginate with limit/offset.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns every user in your workspace with a summary of each user's connected mailboxes.

  • Invited users are included: anyone with a pending invitation appears with status: invited, an inviteExpiresAt timestamp instead of createdAt, an empty mailbox list, and id: null — their id is created when they sign up.
  • Zero-mailbox users are included: an active user who hasn't connected anything appears with mailboxes: [] — making this the endpoint for tracking who has and hasn't connected.

Each active user carries an id for Get User. Use ?status=invited for a pending-invites panel, or ?status=active to exclude invites. The mailboxes array is a light summary (email + connectionStatus); for reputation and full mailbox detail, use List Connected Mailboxes. This endpoint carries no Safety Net data — that lives per mailbox on List Safety Net Mailboxes.

Query Params
string
enum

Return only users in this state. Omit to return all. total reflects the filtered count.

Allowed:
integer
1 to 1000
Defaults to 50

Page size (1–1000). A single page can hold an entire workspace — for a full snapshot request limit=1000 rather than stitching offset pages, which are computed independently.

integer
≥ 0
Defaults to 0

Zero-based index of the first entry to return.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json