Start here — authentication, pagination and error handling for the Xyte API.
The API is designed to be RESTful, supporting standard HTTP methods such as GET, POST, PUT, and DELETE for interacting with resources.
Authentication & Authorization
All API requests must be Authorized via Headers using a Core API Keys.
Additional APIs
A number of additional APIs are available to select tiers, please contact support at [email protected] for additional information.
Pagination
APIs that return large data sets, might require the use of Pagination.
Error Codes
- 401 Unauthorized: the api_key is not provided or is invalid.
- 403 Forbidden: the user does not have permission to perform the requested action.
- 404 Not Found: a device with the specified ID is not found.
- 422 Unprocessable Entity: a required parameter is missing or invalid.
Reporting & BI
The Organization API is the way to connect reporting and BI tools to Xyte, and there are ready-made tools built on it. Choose the route that fits:
| Route | Best for |
|---|---|
| Organization API (this reference) | Feeding your own reporting or BI tool: devices (model, vendor, serial, firmware version), incidents, status history, spaces and tenant details. |
| Xyte CLI | Generating fleet reports as PDF or Markdown, or exporting data as JSON, without writing code. |
| Xyte MCP Server | Asking your own AI assistant for reports in plain language. |
| Analytics | Portfolio-wide charts in the portal, with Export to PDF (Beta). |
The Postman & Bruno collection is the quickest way to try the endpoints before wiring them into a tool.
API keys are per tenantEach API key belongs to one organization. If you manage several customer tenants, create a key in each one.
Postman / Bruno
A full Postman and Bruno collection is available for download: Postman & Bruno Collection