Mailbox Data Backups

The /BackupRepositories/{repositoryId}/MailboxData resource collection represents backed-up mailboxes whose data is stored in a backup repository.

Get Mailbox Data by Repository ID

Returns a collection of backed-up mailboxes whose data is stored in a backup repository with the specified ID.

SecurityBearer
Request
path Parameters
repositoryId
required
string <uuid>

Specifies the identification number of the backup repository. For more information on how to get this parameter, see Get Backup Repositories.

query Parameters
limit
integer <int32>

Limits the maximum number of items that the server will return on a page. The maximum supported number of items per page is 10,000. The default value is 30.

offset
integer <int32>

Excludes from a response page the first N items of a collection resource. The default value is 0.

filter
string

Specifies a keyword to filter mailboxes by the displayName property. You can use wildcard characters such as * and ? to narrow results in response.

organizationId
string

Specifies the identification number of the Microsoft 365 organization. For more information on how to get this parameter, see Get Organizations.

pointInTime
string <date-time>

Specifies point in time that you want to get from a backup repository.

Responses
200

OK

default

Operation failure response.

get/v8/BackupRepositories/{repositoryId}/MailboxData
Request samples
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
  • "results": [
    ],
  • "_links": {
    }
}

Get Mailbox Data by Repository and Mailbox ID

Returns a backed-up mailbox with the specified ID whose data is stored in a backup repository with the specified ID.

SecurityBearer
Request
path Parameters
repositoryId
required
string <uuid>

Specifies the identification number of the backup repository. For more information on how to get this parameter, see Get Backup Repositories.

mailboxId
required
string <uuid>

Specifies the identification number of the mailbox. For more information on how to get this parameter, see Get Mailbox Data by Repository ID.

Example: 00000000-0000-0000-0000-000000000000
Responses
200

OK

default

Operation failure response.

get/v8/BackupRepositories/{repositoryId}/MailboxData/{mailboxId}
Request samples
Response samples
application/json
{
  • "id": "string",
  • "itemType": "Mailbox",
  • "repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
  • "isArchive": true,
  • "displayName": "string",
  • "email": "string",
  • "backedUpTime": "2019-08-24T14:15:22Z",
  • "organizationId": "00000000-0000-0000-0000-000000000000",
  • "backedUpOrganizationId": "string",
  • "_links": {
    }
}

Document updated 12/18/2025

Page content applies to build 8.3.0.2201