Skip to main content

JSON responses

Successful responses use success and data. Metadata includes a request ID and, for paginated collections, pagination fields. This empty-list example is illustrative:
204 No Content responses have no JSON body. CSV downloads use text/csv. Objects and managed-resource collections accept page (starting at 1), per_page (default 50, maximum 500), and search (2–100 characters after trimming). Continue while the current page is below meta.pages. History defaults to 500 points per page. Command, RFID, login-history, and object-event lists use a capped per_page limit rather than page navigation; see each endpoint. Search matches registered fields within the account’s access scope. % and _ are literal characters. Managed-resource lists support registered exact field filters and sort / order. Object lists sort by name, with match ranking when search is supplied; their name, plate, and SIM filters are partial matches.

Limits

Successful authenticated requests expose X-RateLimit-Limit and X-RateLimit-Remaining. On 429, back off before retrying. Avoid immediate retry loops and spread polling over time.

Errors

Log the HTTP status, error.code, and meta.request_id. Avoid automatically retrying command or write requests after an ambiguous timeout: first check whether the original operation completed.