{"componentChunkName":"component---src-templates-redoc-operation-js","path":"/partners/tag/Data-definitions/schema/PaginatedResponse/","result":{"data":{"contentItem":{"type":"redoc-operation","link":"/partners/tag/Data-definitions/schema/PaginatedResponse/","data":{"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"1.0.1\",\"title\":\"Partners API\",\"description\":\"Returns information about the Toast restaurants that a partner \\nAPI client can access.\\n\",\"contact\":{\"name\":\"Toast developer support\"}},\"paths\":{\"/restaurants\":{\"get\":{\"operationId\":\"restaurantsGet\",\"summary\":\"Get accessible restaurants\",\"description\":\"Returns an array of `PartnerAccessExternalRep` \\nobjects that contain information about the Toast restaurants that your partner \\nAPI client can access. If a `lastModified` date is specified, the API returns \\nall objects that were created or modified after that date.\\n\",\"parameters\":[{\"name\":\"lastModified\",\"description\":\"Limits the return data to restaurants that changed their \\naccess configuration for a partner API client after a \\nspecific date and time.\\n\\nRestaurants returned either:\\n\\n* Gave access to a partner API client for a partner \\n  integration service after a specific date and time.\\n\\n* Modified the configuration for a partner integration \\n  after a specific date and time. \\n\\nYou must specify the date and time as a UTC timestamp in \\nISO 8601 format, for example: \\n`2020-03-01T00:00:00.000-0000`. URL encode the timestamp. \\nFor example, `2020-03-01T00%3A00%3A00.000-0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date\"}}],\"responses\":{\"200\":{\"description\":\"Returns the list of external partner accesses\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/PartnerAccessExternalRep\"}}}}},\"403\":{\"description\":\"Your Toast API client does not have permission to use the \\n`/restaurants` endpoint.\\n\"}},\"security\":[{\"oauth2\":[]}]}},\"/connectedRestaurants\":{\"get\":{\"operationId\":\"connectedRestaurantsGet\",\"summary\":\"Get connected restaurants\",\"description\":\"Returns a `PaginatedResponse` object that contains a paginated array of\\nthe restaurants that have connected to your integrated partner service.\\nInformation about each restaurant is included in the array as a\\n`PartnerAccessExternalRep` object.\\n\\nUse the `pageSize` query parameter to control the number of restaurants\\nreturned in the response. The default `pageSize` is 100. The maximum\\n`pageSize` is 200.\\n\\nRequest the next page of restaurant information using the `pageToken`\\nquery parameter. You get the token string for the next page from the\\n`nextPageToken` value of the `PaginatedResponse` object for a page of\\nresults. You can also get the token strings for the first and next pages\\nfrom [the `link` response header\\nfields](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Link).\\n\",\"parameters\":[{\"name\":\"lastModified\",\"description\":\"Limits the return data to restaurants that changed their access\\nconfiguration for your partner service after a specific date and\\ntime. You can use this parameter to identify new or updated\\nrestaurants connected to your partner service.\\n\\nThe restaurants included in the response data either:\\n\\n* Gave access to your integrated partner service after a specific\\n  date and time.\\n\\n* Modified the configuration for your integrated partner service after\\n  a specific date and time. \\n\\nYou must [specify the date and\\ntime](https://doc.toasttab.com/doc/devguide/api_dates_and_timestamps.html)\\nas a UTC timestamp in ISO 8601 format, for example:\\n`2020-03-01T00:00:00.000-0000`. URL-encode the timestamp. For\\nexample, `2020-03-01T00%3A00%3A00.000-0000`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date\"}},{\"name\":\"pageSize\",\"description\":\"Controls the number of `PartnerAccessExternalRep` objects that the\\nendpoint will return in each page of response data. The default page\\nsize is `100`. The maximum page size is `200`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"integer\",\"minimum\":1,\"maximum\":200}},{\"name\":\"pageToken\",\"description\":\"Returns a specific set of restaurants in the response value. You get\\nthe token string for the next page of connected restaurants from the\\n`nextPageToken` value of the `PaginatedResponse` object for a page\\nof results. You can also get the token strings for the first and\\nnext pages from [the `link` response header\\nfields](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Link).\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `PaginatedResponse` object that contains a paginated array of\\nthe restaurants that have connected to your integrated partner service.\\n\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/PaginatedResponse\"}}}}},\"403\":{\"description\":\"Your Toast API client does not have permission to use the \\n`/connectedRestaurants` endpoint.\\n\"}},\"security\":[{\"oauth2\":[]}]}}},\"servers\":[{\"url\":\"https://toast-api-server/partners/v1\"}],\"components\":{\"securitySchemes\":{\"oauth2\":{\"description\":\"Access to Toast APIs, specific endpoints, \\nand specific API endpoint operations is \\ncontrolled by the scopes that are associated \\nwith your API account. \\nA full reference for Toast API scopes and \\ntheir capabilities can be found in the\\n[_Toast Developer Guide_](https://doc.toasttab.com/doc/devguide/apiScopes.html).\\n\",\"type\":\"oauth2\",\"flows\":{\"clientCredentials\":{\"tokenUrl\":\"https://toast-api-server/authentication/v1/authentication/login\",\"scopes\":{}}}}},\"schemas\":{\"PartnerAccessExternalRep\":{\"type\":\"object\",\"description\":\"Information about a Toast platform restaurant.\\n\",\"properties\":{\"restaurantGuid\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The unique Toast POS identifier for the restaurant.\\n\",\"example\":\"e728cd53-2fa7-4e63-8f8f-93e78ea66b03\"},\"managementGroupGuid\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The guid of the management group containing the restaurant.\\n\",\"example\":\"bdfda703-2a83-4e0f-9b8a-8ea0ee6cab79\"},\"deleted\":{\"type\":\"boolean\",\"description\":\"Indicates whether the restaurant is actively using the Toast \\nplatform. For example, if a restaurant is no longer operating, \\nor is no longer using the Toast platform, this value is `true`.\\n\"},\"restaurantName\":{\"type\":\"string\",\"description\":\"The human-readable name of the restaurant location.\\n\",\"example\":\"Main Street Cafe\"},\"locationName\":{\"type\":\"string\",\"description\":\"The identifier of a specific restaurant location, set on the \\n*Restaurant Info* page of Toast Web. \\nFor example, a restaurant group might assign a location code \\nsuch as #1234 to a specific location.\\n\",\"example\":\"123 Main Street\"},\"createdByEmailAddress\":{\"type\":\"string\",\"description\":\"The email address of the restaurant employee who connected the\\nrestaurant to your integrated partner service, or who edited the\\nconnection details.\\n\",\"example\":\"clefebvre@mainstreetcafe.com\"},\"externalGroupRef\":{\"type\":\"string\",\"description\":\"An identifier for the restaurant group that is recognized by your\\nintegrated partner service. This information is entered by the\\nrestaurant administrator. If you need information about the restaurant\\ngroup in this data string, you instruct the restaurant administrator\\nto enter it in the Toast platform configuration for the integration\\npartner connection.\\n\"},\"externalRestaurantRef\":{\"type\":\"string\",\"description\":\"An identifier for the restaurant location that is recognized by your\\nintegrated partner service. This information is entered by the\\nrestaurant administrator. If you need information about the restaurant\\nlocation in this data string, you instruct the restaurant\\nadministrator to enter it in the Toast platform configuration for the\\nintegration partner connection.\\n\"},\"modifiedDate\":{\"type\":\"integer\",\"format\":\"int64\",\"description\":\"The most recent date and time that the partner connection\\nwas edited in epoch time (milliseconds since 1970-01-01 00:00:00).\\n\",\"example\":1678846869551},\"createdDate\":{\"type\":\"integer\",\"format\":\"int64\",\"description\":\"The date and time that the partner connection was created in epoch\\ntime (milliseconds since 1970-01-01 00:00:00).\\n\",\"example\":1643858534451},\"isoModifiedDate\":{\"type\":\"string\",\"description\":\"The most recent date and time that the partner connection\\nwas edited in ISO8601 format.\\n\",\"example\":\"2023-03-12T08:32:34.008Z\"},\"isoCreatedDate\":{\"type\":\"string\",\"description\":\"The date and time that the partner connection was created in ISO8601\\nformat.\\n\",\"example\":\"2022-05-17T10:21:38.008Z\"}}},\"PartnerAccessExternalWebhookRep\":{\"type\":\"object\",\"description\":\"Information about a Toast platform restaurant.\\n\",\"properties\":{\"restaurantGuid\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The unique Toast platform identifier for the restaurant.\\n\",\"example\":\"e728cd53-2fa7-4e63-8f8f-93e78ea66b03\"},\"managementGroupGuid\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The unique Toast platform identifier for the management group\\ncontaining the restaurant.\\n\",\"example\":\"bdfda703-2a83-4e0f-9b8a-8ea0ee6cab79\"},\"restaurantName\":{\"type\":\"string\",\"description\":\"The human-readable name of the restaurant location.\\n\"},\"locationName\":{\"type\":\"string\",\"description\":\"The identifier of a specific restaurant location, set on the\\n*Restaurant Info* page of Toast Web.\\nFor example, a restaurant group might assign a location code\\nsuch as `Location1234` to a specific location.\\n\",\"example\":\"Location1234\"},\"externalGroupRef\":{\"type\":\"string\",\"description\":\"An identifier for the restaurant group that is recognized by your\\nintegrated partner service. This information is entered by the\\nrestaurant administrator. If you need information about the restaurant\\ngroup in this data string, you instruct the restaurant administrator\\nto enter it in the Toast platform configuration for the integration\\npartner connection.\\n\"},\"externalRestaurantRef\":{\"type\":\"string\",\"description\":\"An identifier for the restaurant location that is recognized by your\\nintegrated partner service. This information is entered by the\\nrestaurant administrator. If you need information about the restaurant\\nlocation in this data string, you instruct the restaurant\\nadministrator to enter it in the Toast platform configuration for the\\nintegration partner connection.\\n\"},\"modifiedDate\":{\"type\":\"integer\",\"format\":\"int64\",\"description\":\"The most recent date and time that the partner connection\\nwas edited in epoch time (milliseconds since 1970-01-01 00:00:00).\\n\",\"example\":1678846869551},\"createdDate\":{\"type\":\"integer\",\"format\":\"int64\",\"description\":\"The date and time that the partner connection was created in epoch time (milliseconds since 1970-01-01 00:00:00).\\n\",\"example\":1643858534451},\"isoModifiedDate\":{\"type\":\"string\",\"description\":\"The most recent date and time that the partner connection\\nwas edited in ISO8601 format.\\n\",\"example\":\"2023-03-12T08:32:34.008Z\"},\"isoCreatedDate\":{\"type\":\"string\",\"description\":\"The date and time that the partner connection was created in ISO8601 format.\\n\",\"example\":\"2022-05-17T10:21:38.008Z\"},\"createdByFirstName\":{\"type\":\"string\",\"description\":\"The first name of the restaurant employee who initiated the event.\\n\",\"example\":\"Clemence\"},\"createdByLastName\":{\"type\":\"string\",\"description\":\"The last name of the restaurant employee who initiated the event.\\n\",\"example\":\"Lefebvre\"},\"createdByEmailAddress\":{\"type\":\"string\",\"description\":\"The email address of the restaurant employee who connected the\\nrestaurant to your integrated partner service, or who edited the\\nconnection details.\\n\",\"example\":\"clefebvre@mainstreetcafe.com\"},\"createdByPhoneNumber\":{\"type\":\"string\",\"description\":\"The phone number of the user who initiated the event.\\n\",\"example\":\"9876543210\"},\"restaurantPhoneNumber\":{\"type\":\"string\",\"description\":\"The phone number of the restaurant.\\n\",\"example\":\"8765432109\"},\"restaurantAddressLine1\":{\"type\":\"string\",\"description\":\"The physical address of the restaurant location.\\n\",\"example\":\"123 Main Street\"},\"restaurantAddressLine2\":{\"type\":\"string\",\"description\":\"Optional additional physical address of the restaurant location.\\n\",\"example\":\"Suite 321\"},\"restaurantCity\":{\"type\":\"string\",\"description\":\"The city in which the restaurant is located.\\n\",\"example\":\"Gatineau\"},\"restaurantState\":{\"type\":\"string\",\"description\":\"The state in which the restaurant is located.\\n\",\"example\":\"Massachusetts\"},\"restaurantZipCode\":{\"type\":\"string\",\"description\":\"The zip code of the restaurant location.\\n\",\"example\":\"01234\"},\"restaurantLatitude\":{\"type\":\"string\",\"description\":\"The latitude of the restaurant location.\\n\"},\"restaurantLongitude\":{\"type\":\"string\",\"description\":\"The longitude of the restaurant location.\\n\"},\"restaurantCountryCode\":{\"type\":\"string\",\"description\":\"The ISO 3166-1 alpha-2 country code of the restaurant location.\\n\",\"example\":\"US\"},\"restaurantTimezone\":{\"type\":\"string\",\"description\":\"The IANA time zone identifier of the restaurant location.\\nFor example, `America/New_York`.\\n\",\"example\":\"America/New_York\"}}},\"PaginatedResponse\":{\"type\":\"object\",\"description\":\"A wrapper object containing paginated sets of response data. The `results`\\nvalue is an array of `PartnerAccessExternalRep` objects, which hold\\ninformation about Toast platform restaurants. Also includes pagination\\ndetails such as how many pages are included in the response, or the total\\nnumber of objects in the `results` array.\\n\",\"example\":{\"currentPageNum\":1,\"results\":[{\"restaurantGuid\":\"7ab295f6-8dc8-4cb6-8cdb-072b83e84184\",\"managementGroupGuid\":\"75063706-dd6e-4da6-8bb6-3a99e218e686\",\"restaurantName\":\"Main Street Cafe\",\"locationName\":\"123 Main Street\",\"createdByEmailAddress\":\"clefebvre@mainstreetcafe.com\",\"externalGroupRef\":\"\",\"externalRestaurantRef\":\"\",\"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},\"properties\":{\"currentPageNum\":{\"type\":\"integer\",\"description\":\"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.\\n\",\"example\":12},\"results\":{\"type\":\"array\",\"description\":\"An array of `PartnerAccessExternalRep` objects that include\\ninformation about Toast platform restaurants.\\n\",\"items\":{\"$ref\":\"#/components/schemas/PartnerAccessExternalRep\"}},\"totalResultCount\":{\"type\":\"integer\",\"description\":\"The total number of records returned.\\n\",\"example\":1234},\"pageSize\":{\"type\":\"integer\",\"description\":\"The number of restaurants returned in each page of response data.\\n\",\"example\":100},\"currentPageToken\":{\"type\":\"string\",\"description\":\"A string that identifies the current page of response data.\\n\",\"example\":\"cDoxLHM6MQ==\"},\"nextPageToken\":{\"type\":\"string\",\"description\":\"A string that identifies the following page of response data.\\n\",\"example\":\"cDoyLHM6MQ==\"},\"totalCount\":{\"type\":\"integer\",\"description\":\"The total number of results within the response record.\\n\",\"example\":1234},\"nextPageNum\":{\"type\":\"integer\",\"description\":\"The next available page in the data. `Null` if the current page of\\nresults is the last available page.\\n\",\"example\":14},\"lastPageNum\":{\"type\":\"integer\",\"description\":\"The last page number in the response data.\\n\",\"example\":13},\"previousPageNum\":{\"type\":\"integer\",\"description\":\"The page number for the page previous to your current page in\\nsequential order. `Null` if there are no pages previous to your\\ncurrent page.\\n\",\"example\":12}}}}}}},\"options\":{\"hideTryItPanel\":true,\"pagination\":\"item\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"Java\"},{\"lang\":\"Python\"},{\"lang\":\"Node.js\"},{\"lang\":\"C#\"}]},\"showConsole\":false,\"hideHostname\":true,\"hideDownloadButton\":false,\"sortPropsAlphabetically\":true,\"schemaDefinitionsTagName\":\"Data definitions\",\"showAccessMode\":true,\"downloadDefinitionUrl\":\"https://doc.toasttab.com/toast-api-specifications/toast-partners-api.yaml\",\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","redocHasSecurityDefinitions":false,"redocInfoPageLink":"/partners/overview/","redocItemId":"tag/Data-definitions/schema/PaginatedResponse","redocHasInfoPage":false,"settings":{"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"Java"},{"lang":"Python"},{"lang":"Node.js"},{"lang":"C#"}]},"showConsole":false,"hideHostname":true,"hideDownloadButton":false,"sortPropsAlphabetically":true,"schemaDefinitionsTagName":"Data definitions","hideTryItPanel":true,"showAccessMode":true,"downloadDefinitionUrl":"https://doc.toasttab.com/toast-api-specifications/toast-partners-api.yaml"},"requestLogin":false,"lastModified":"2024-09-05T12:56:37.000Z"},"seo":{"title":"PaginatedResponse"}}},"pageContext":{"id":"76deaa57-0927-538c-8af4-302f931b8d6etag/Data-definitions/schema/PaginatedResponse/__redocly content/partners/tag/Data-definitions/schema/PaginatedResponse/","seo":{"title":"PaginatedResponse","description":"<SchemaDefinition showWriteOnly={true} schemaRef=\"#/components/schemas/PaginatedResponse\" />","image":"","keywords":null,"jsonLd":null,"lang":null},"pageId":"partners.reference.page.yaml#tag/Data-definitions/schema/PaginatedResponse/","pageBaseUrl":"/partners","type":"redoc-operation","toc":{"enable":true,"maxDepth":4,"headings":null},"data":{},"catalogInfo":null,"link":"/partners/tag/Data-definitions/schema/PaginatedResponse/","sidebarName":"api-reference","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":[{"definitionId":"partners","id":"partners","title":"partners","isDefault":true,"apiId":null}],"apiVersionId":null,"isDefaultApiVersion":true}},"staticQueryHashes":["1123603147","1180902673","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3743992808","561138138"]}