List mailboxes

List the mailboxes a key authorizes, including users and tags. Synchronous, returns the full list in one response.

Returns information about every mailbox the API key authorizes — including the active and inactive users in each mailbox, the tags defined for each mailbox, and the mailbox’s time zone.

GET/api/v1/admin/mailboxes

Auth: Bearer API key — requires reporting scope
Async: No
Pagination: No — full list returned in one response

Authorization

The key must include the reporting scope. The response is filtered to only the mailboxes in the key’s allowlist; this endpoint does not require the caller to specify a mailbox.

Response

{
  "mailboxes": [
    {
      "mailboxId":    "af412a6c-657f-445b-892c-b6b1fa41ad1b",
      "mailboxName":  "Sales Department",
      "mailboxEmail": "sales@company.com",
      "active":       true,
      "timeZone":     "America/Toronto",
      "users": [
        { "userId": "3f4a5b60-774a-43f5-afb9-dfe54eaf6c3f", "userName": "Emily Johnson", "userEmail": "emilyjohnson@company.com", "active": true },
        { "userId": "e142c23e-6800-4d9b-af7e-4078c0ff6e2a", "userName": "Jane Smith",    "userEmail": "janesmith@company.com",    "active": true },
        { "userId": "d3fae393-1ee8-428a-b833-ea73a0948a50", "userName": "John Doe",      "userEmail": "johndoe@company.com",      "active": false }
      ],
      "tags": [
        { "tagId": "71c99741-b351-4e71-9d81-293d9fbf7dd7", "tagName": "Priority",   "tagColor": "Preset10", "active": true  },
        { "tagId": "bdcdbc3a-9c64-42ba-b33f-bbc9e0353a98", "tagName": "New Client", "tagColor": "Preset11", "active": true  },
        { "tagId": "179a17b8-d579-4f04-aee2-c27d2fdf8fdf", "tagName": "Urgent",     "tagColor": "Preset12", "active": false }
      ]
    }
  ]
}

Mailbox object

Each entry in mailboxes[].

mailboxIdstring

Mailbox identifier. Use this as the mailboxId body parameter on reports endpoints.

mailboxNamestring

Display name.

mailboxEmailstring

Email address of the shared mailbox.

activeboolean

Whether the mailbox is currently active (true) or has been offboarded/deleted (false).

timeZonestring

IANA time zone of the mailbox. Reports are grouped by date in this zone.

usersUser[]

Active and inactive members of the mailbox. Sorted by user display name (last name, then first name, parsed from userName).

tagsTag[]

Tags defined for the mailbox. Sorted by tagName.

User object

userIdstring

User identifier.

userNamestring

Display name.

userEmailstring

Email address.

activeboolean

Whether the user is currently a member of the mailbox (true) or has been removed/deleted (false).

Tag object

tagIdstring

Tag identifier.

tagNamestring

Tag name.

tagColorstring

Microsoft 365 category color name — for example, Preset10. The full set of values is defined by Microsoft Graph; see outlookCategory.color.

activeboolean

Whether the tag is currently active (true) or has been deleted (false).

Request

curl 'https://c1.emailgistics.com/api/v1/admin/mailboxes' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Errors

Status	When
`401`	API key missing, malformed, or expired.
`403`	Key is missing the `reporting` scope.
`429`	Rate limit exceeded — see Rate limits.
`5xx`	Transient server error.

Error bodies follow the standard shape — see Errors.

Mailbox Performance — uses mailboxId from this response.
Mailbox User Performance — uses both mailboxId and userId.

List mailboxes

On this page