List mailboxes

List all mailboxes

activeboolean nullable

Filter for effectively active mailboxes (marked active with a live subscription)

email_addressesstring nullable

Email addresses of the mailboxes to return (comma-delimited)

limitinteger nullable

The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used

mailbox_typesstring nullable

Comma-delimited list of mailbox types to filter by

marked_activeboolean nullable

Filter for mailboxes marked active

message_source_idstring nullable

ID of the message source the mailboxes belong to

offsetinteger nullable

The (zero-based) offset of the first mailbox to return

searchstring nullable

Search across mailbox names and email addresses

sub_error_typesstring nullable

Comma-delimited list of subscription error types to filter by

Response

OK

activeinteger

Total number of active matching filters

countinteger

Count of results for this page

totalinteger

Total number of results available