User Data Backups

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

Get List of Users by Repository ID

Returns a collection of backed-up users 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.

Responses
200

OK

default

Operation failure response.

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

Get User Data by Repository and User ID

Returns a backed-up or user 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.

userId
required
string

Specifies the identification number of the user. For more information on how to get this parameter, see Get Organization Users.

Responses
200

OK

default

Operation failure response.

get/v8/BackupRepositories/{repositoryId}/UserData/{userId}
Request samples
Response samples
application/json
{
  • "itemType": "Mailbox",
  • "repositoryId": "5aa3e9fa-2d0a-4c21-ad54-43217e2bc9c0",
  • "mailboxBackedUpTime": "2019-08-24T14:15:22Z",
  • "archiveBackedUpTime": "2019-08-24T14:15:22Z",
  • "oneDriveBackedUpTime": "2019-08-24T14:15:22Z",
  • "personalSiteBackedUpTime": "2019-08-24T14:15:22Z",
  • "isMailboxBackedUp": true,
  • "isOneDriveBackedUp": true,
  • "isArchiveBackedUp": true,
  • "isPersonalSiteBackedUp": true,
  • "accountType": "User",
  • "archiveName": "string",
  • "id": "string",
  • "accountId": "string",
  • "displayName": "string",
  • "email": "string",
  • "oneDriveUrl": [
    ],
  • "personalSiteUrl": [
    ],
  • "organizationId": "00000000-0000-0000-0000-000000000000",
  • "backedUpOrganizationId": "string",
  • "_links": {
    }
}

Document updated 12/18/2025

Page content applies to build 8.3.0.2201