{"componentChunkName":"component---src-templates-redoc-operation-js","path":"/device-details/tag/Data-definitions/schema/Device/","result":{"data":{"contentItem":{"type":"redoc-operation","link":"/device-details/tag/Data-definitions/schema/Device/","data":{"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"1.0.0\",\"title\":\"Device details API\",\"description\":\"Returns information about devices for a single restaurant.\\n\",\"contact\":{\"name\":\"Enterprise Reporting\"},\"termsOfService\":\"https://pos.toasttab.com/api-terms-of-use\"},\"paths\":{\"/device-info\":{\"get\":{\"tags\":[\"Device details\"],\"operationId\":\"getDeviceInfo\",\"summary\":\"Get devices details for a restaurant\",\"description\":\"Get details about the devices using the Toast POS app at a restaurant.\\n\",\"security\":[{\"oauth2\":[\"device-details.info:read\"]}],\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The identifier for the restaurant.\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\"}}],\"responses\":{\"200\":{\"description\":\"Successful operation\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Device\"}}}}},\"400\":{\"description\":\"Missing or invalid restaurant header.\"},\"401\":{\"description\":\"Unauthorized.\"},\"403\":{\"description\":\"Forbidden.\"},\"429\":{\"description\":\"Too many requests.\"},\"500\":{\"description\":\"An unexpected error occurred.\"}}}}},\"servers\":[{\"url\":\"https://toast-api-server/device-details/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. \\n\\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\":{\"device-details.info:read\":\"Allows reading from the device details API.\"}}}}},\"schemas\":{\"Device\":{\"type\":\"object\",\"description\":\"Device details for a device using the Toast POS app.\",\"properties\":{\"deviceName\":{\"type\":\"string\",\"description\":\"The custom name assigned to the hardware device when initially setting up the Toast POS app.\",\"example\":\"Quick Order - 69a851\"},\"deviceModel\":{\"type\":\"string\",\"description\":\"The hardware model of the device.\",\"example\":\"TT200\"},\"deviceId\":{\"type\":\"string\",\"description\":\"The identifier assigned by the Toast platform to the hardware device.\",\"example\":\"4f49a8734eb214d0\"},\"serialNumber\":{\"type\":\"string\",\"description\":\"The serial number of the hardware device.\",\"example\":\"cb5f9ea\"},\"posAppVersion\":{\"type\":\"string\",\"description\":\"The version of the Toast POS app installed on the device.\",\"example\":\"2.95.1\"}}}}}}},\"options\":{\"hideTryItPanel\":true,\"pagination\":\"item\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"Java\"},{\"lang\":\"Python\"}]},\"showConsole\":false,\"hideHostname\":true,\"hideDownloadButton\":true,\"sortPropsAlphabetically\":true,\"schemaDefinitionsTagName\":\"Data definitions\",\"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":"/device-details/overview/","redocItemId":"tag/Data-definitions/schema/Device","redocHasInfoPage":false,"settings":{"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"Java"},{"lang":"Python"}]},"showConsole":false,"hideHostname":true,"hideDownloadButton":true,"sortPropsAlphabetically":true,"schemaDefinitionsTagName":"Data definitions","hideTryItPanel":true},"requestLogin":false,"lastModified":"2025-12-04T16:29:27.000Z"},"seo":{"title":"Device"}}},"pageContext":{"id":"9fa3adf0-ddae-57da-b8e7-2bce903a4eectag/Data-definitions/schema/Device/__redocly content/device-details/tag/Data-definitions/schema/Device/","seo":{"title":"Device","description":"<SchemaDefinition showWriteOnly={true} schemaRef=\"#/components/schemas/Device\" />","image":"","keywords":null,"jsonLd":null,"lang":null},"pageId":"device-details.reference.page.yaml#tag/Data-definitions/schema/Device/","pageBaseUrl":"/device-details","type":"redoc-operation","toc":{"enable":true,"maxDepth":4,"headings":null},"data":{},"catalogInfo":null,"link":"/device-details/tag/Data-definitions/schema/Device/","sidebarName":"api-reference","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":[{"definitionId":"deviceDetails","id":"deviceDetails","title":"deviceDetails","isDefault":true,"apiId":null}],"apiVersionId":null,"isDefaultApiVersion":true}},"staticQueryHashes":["1123603147","1180902673","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3743992808","561138138"]}