GET /api/v1.0/mailboxes — messages-api

mailboxes

ViewSet for Mailbox model.

get/api/v1.0/mailboxes/

Response

idstring uuid required

primary key for the record as UUID

emailstring required

namestring nullable required

Return the display name of the mailbox (its contact name).

domain_idstring uuid required

is_identityboolean required

Whether this mailbox identifies a person (i.e. is not an alias or a group)

is_sharedboolean required

Return True if the mailbox is shared (non-identity or has more than one access).

Drives mailbox-level UI gating for collaboration features (assignment sub-folders, mention folder) that have no purpose in a mono-user identity mailbox.

role'viewer' | 'editor' | 'sender' | 'admin' required

count_unread_threadsinteger required

Return the number of threads with unread messages in the mailbox.

count_threadsinteger required

Return the number of threads in the mailbox.

count_deliveringinteger required

Return the number of threads with messages being delivered.

count_unread_mentionsinteger required

Return the number of threads with unread mentions for the current user.

count_assignedinteger required

Return the number of threads in this mailbox currently assigned to the current user.

Changes

Changed in 15 of the 54 revisions of this API.2219

Jun 23, 2026302e2aacc4581See the full diff
- ▲
  the response property items/role became nullable for the status 200
  response-property-became-nullable
Jun 10, 20263ffcd4a80db72See the full diff
- ○
  added the required property items/domain_id to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/name to the response with the 200 status
  response-required-property-added
Jun 5, 20268afe1f77a5c82See the full diff
- ▲
  removed the required property items/domain_id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property items/name from the response with the 200 status
  response-required-property-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 1, 202602f320d0d6dd2See the full diff
- ○
  added the required property items/domain_id to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/name to the response with the 200 status
  response-required-property-added
May 7, 20261516e10a835a2See the full diff
- ○
  added the required property items/count_assigned to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/is_shared to the response with the 200 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 6, 20262319a741f4d22See the full diff
- ▲
  removed the required property items/count_assigned from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property items/is_shared from the response with the 200 status
  response-required-property-removed
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 5, 202675dbb02c61c02See the full diff
- ○
  added the required property items/count_assigned to the response with the 200 status
  response-required-property-added
- ○
  added the required property items/is_shared to the response with the 200 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 9, 20266ea533c083c231See the full diff
- ▲
  the items/count_delivering response's property type/format changed from string/ to integer/ for status 200
  response-property-type-changed
- ▲
  the items/count_threads response's property type/format changed from string/ to integer/ for status 200
  response-property-type-changed
- ▲
  the items/count_unread_threads response's property type/format changed from string/ to integer/ for status 200
  response-property-type-changed
- ○
  added the required property items/count_unread_mentions to the response with the 200 status
  response-required-property-added
Apr 9, 2026cf070e65cfb64See the full diff
- ▲
  the items/count_delivering response's property type/format changed from integer/ to string/ for status 200
  response-property-type-changed
- ▲
  the items/count_threads response's property type/format changed from integer/ to string/ for status 200
  response-property-type-changed
- ▲
  the items/count_unread_threads response's property type/format changed from integer/ to string/ for status 200
  response-property-type-changed
- ▲
  removed the required property items/count_unread_mentions from the response with the 200 status
  response-required-property-removed
Apr 9, 20265ae90ac0a17f31See the full diff
- ▲
  the items/count_delivering response's property type/format changed from string/ to integer/ for status 200
  response-property-type-changed
- ▲
  the items/count_threads response's property type/format changed from string/ to integer/ for status 200
  response-property-type-changed
- ▲
  the items/count_unread_threads response's property type/format changed from string/ to integer/ for status 200
  response-property-type-changed
- ○
  added the required property items/count_unread_mentions to the response with the 200 status
  response-required-property-added

Full history (15 revisions)