Get Started
Usage API
More information

GET api/2.0/mailserver/mailboxes/get This function requires authentication

Description

Returns a list of all the mailboxes associated with the tenant.

Parameters

This method doesn't have any parameters.

Example
GET api/2.0/mailserver/mailboxes/get
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of mailbox data for the current tenant

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "Id": 1234,
      "UserId": "UserId",
      "UserDisplayName": "UserDisplayName",
      "Address": {
        "Id": 1234,
        "DomainId": 1234,
        "Email": "Email@only.com"
      },
      "Name": "Name",
      "Aliases": [
        {
          "Id": 1234,
          "DomainId": 1234,
          "Email": "Email@only.com"
        }
      ]
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <Id>1234</Id>
    <UserId>UserId</UserId>
    <UserDisplayName>UserDisplayName</UserDisplayName>
    <Address>
      <Id>1234</Id>
      <DomainId>1234</DomainId>
      <Email>Email@only.com</Email>
    </Address>
    <Name>Name</Name>
    <Aliases>
      <Id>1234</Id>
      <DomainId>1234</DomainId>
      <Email>Email@only.com</Email>
    </Aliases>
  </response>
</result>