List mailboxes

Lists the shared mailboxes on your account, sorted by description. A shared mailbox is a mailbox that is not tied to an extension. Each one includes its settings, keypad options, copy destinations, greetings and message counts.

Use scope to get something else:

  • all returns the UUID, number and description of every mailbox on your account, sorted by number.
  • next_id returns the next free shared mailbox number. The number is not reserved.

Requires an API key with the Admin role.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
Defaults to shared

What to return: shared for the shared mailboxes, all for a short list of every mailbox, or next_id for the next free shared mailbox number.

Allowed:
Responses

401

Missing or invalid API key.

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