PaginatedResponse

A wrapper object containing paginated sets of response data. The results value is an array of PartnerAccessExternalRep objects, which hold information about Toast platform restaurants. Also includes pagination details such as how many pages are included in the response, or the total number of objects in the results array.

• currentPageNum:
  integer

  The active page within all repsonse pages. You can see the total amount of pages at the end of the response in the lastPageNum field.

• currentPageToken:
  string <uuid>

  A string that identifies the current page of response data.

• lastPageNum:
  integer

  The last page number in the response data.

• nextPageNum:
  integer

  The next available page in the data. Null if the current page of results is the last available page.

• nextPageToken:
  string <uuid>

  A string that identifies the following page of response data.

• pageSize:
  integer

  The number of restaurants returned in each page of response data.

• previousPageNum:
  integer

  The page number for the page previous to your current page in sequential order. Null if there are no pages previous to your current page.

• results:
  Array of objects (PartnerAccessExternalRep)

  An array of PartnerAccessExternalRep objects that include information about Toast platform restaurants.

• totalCount:
  integer

  The total number of results within the response record.

• totalResultCount:
  integer

  The total number of records returned.

{
  "currentPageNum": 1,
  "results": [
    {
      "restaurantGuid": "7ab295f6-8dc8-4cb6-8cdb-072b83e84184",
      "managementGroupGuid": "75063706-dd6e-4da6-8bb6-3a99e218e686",
      "restaurantName": "Main Street Cafe",
      "locationName": "123 Main Street",
      "createdByEmailAddress": "[e-mail]",
      "externalGroupRef": null,
      "externalRestaurantRef": null,
      "modifiedDate": 1678823073353,
      "createdDate": 1678823073353,
      "isoModifiedDate": "2023-03-14T19:44:33.353Z",
      "isoCreatedDate": "2023-03-14T19:44:33.353Z"
    }
  ],
  "totalResultCount": 3222,
  "pageSize": 1,
  "currentPageToken": "cDoxLHM6MQ==",
  "nextPageToken": "cDoyLHM6MQ==",
  "totalCount": 3222,
  "nextPageNum": 2,
  "lastPageNum": 3222,
  "previousPageNum": null
}