Help Center
Choose product document...
Veeam Backup for Microsoft Office 365
RESTful API Reference

Pagination

Veeam Backup for Microsoft Office 365 RESTful API uses pagination to return in a response a defined number of resources per page. By default, the server returns the first 30 items of a resource collection on a page. To change this behavior, you can define the following page attributes:

  • Offset - excludes from a response page the first N items of a resource collection. Default value: 0.
  • Limit - limits the maximum number of items that the server will return on a page. Default value: 30.

Pagination Note:

Veeam Backup for Microsoft Office 365 RESTful API returns resources in the default order based on its own semantics.

For example, to return a page with 10 mailboxes starting from the 20th, send the following request:

GET https://<Backup-Office365>:<Port>/v1/Organizations/{ID}/Mailboxes?offset=19&limit=10

If it is possible to navigate to other pages, the server will also return the links to the first, previous, and next pages. For example:

"_links": {

   "first": {

     "href": "https://support.east.local:4443/v1/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/Organization/Mailboxes/479ae6aa-610b-4652-8966-5db06021903c/Folders?offset=0&limit=10"

   },

   "prev": {

     "href": "https://support.east.local:4443/v1/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/Organization/Mailboxes/479ae6aa-610b-4652-8966-5db06021903c/Folders?offset=9&limit=10"

   },

   "self": {

     "href": "https://support.east.local:4443/v1/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/Organization/Mailboxes/479ae6aa-610b-4652-8966-5db06021903c/Folders?offset=19&limit=10"

   },

   "next": {

     "href": "https://support.east.local:4443/v1/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/Organization/Mailboxes/479ae6aa-610b-4652-8966-5db06021903c/Folders?offset=29&limit=10"

   }

 }

Veeam Backup for Microsoft Office 365 RESTful API uses pagination for the following resources:

  1. Mailboxes:
  1. Backed up mailboxes:
  1. Backed up mailbox folders:
  1. Backed up mailbox items:
Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference