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

default

Operation failure response.

get/v8/BackupRepositories/{repositoryId}/MailboxData

Request samples

curl
Python
JavaScript
C#
Go

Response samples

200
default

application/json

{"offset": "0",
"limit": "30",
"setId": "f0e1d2c3-b4a5-6789-0123-456789abcdef",
"results": [{"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"itemType": "Mailbox",
"repositoryId": "c3d4e5f6-a7b8-9012-cdef-012345678892",
"isArchive": "false",
"displayName": "John Smith",
"email": "john.smith@abc.onmicrosoft.com",
"backedUpTime": "2025-01-15T04:00:00Z",
"organizationId": "b2c3d4e5-f6a7-8901-bcde-f01234567891",
"backedUpOrganizationId": "b2c3d4e5-f6a7-8901-bcde-f01234567891",
"_links": {"self": {"href": "/v8/BackupRepositories/c3d4e5f6-a7b8-9012-cdef-012345678892/MailboxData/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
},
{"id": "d5e6f7a8-b9c0-1234-efab-cd1234567892",
"itemType": "Mailbox",
"repositoryId": "c3d4e5f6-a7b8-9012-cdef-012345678892",
"isArchive": "true",
"displayName": "Jane Doe (Archive)",
"email": "jane.doe@abc.onmicrosoft.com",
"backedUpTime": "2025-01-15T04:00:00Z",
"organizationId": "b2c3d4e5-f6a7-8901-bcde-f01234567891",
"backedUpOrganizationId": "b2c3d4e5-f6a7-8901-bcde-f01234567891",
"_links": {"self": {"href": "/v8/BackupRepositories/c3d4e5f6-a7b8-9012-cdef-012345678892/MailboxData/d5e6f7a8-b9c0-1234-efab-cd1234567892"
}
}
}
],
"_links": {"self": {"href": "/v8/BackupRepositories/c3d4e5f6-a7b8-9012-cdef-012345678892/MailboxData"
}
}
}

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.