{"id":2938,"date":"2026-01-26T08:10:18","date_gmt":"2026-01-26T13:10:18","guid":{"rendered":"https:\/\/www.airsupervision.com\/wp-r\/docs\/administrator\/apis\/response-envelope\/"},"modified":"2026-02-25T08:14:37","modified_gmt":"2026-02-25T13:14:37","slug":"response-envelope","status":"publish","type":"docs","link":"https:\/\/www.airsupervision.com\/wp-r\/docs\/administrator\/apis\/response-envelope\/","title":{"rendered":"Response envelope"},"content":{"rendered":"\n<p>Most endpoints return:<\/p>\n\n\n\n<p>All responses are JSON&nbsp;(<code>Content-Type: application\/json<\/code>),&nbsp;including errors&nbsp;(except the bare&nbsp;<code>{\"error\":\"unauthorized\"}<\/code>&nbsp;body which is still JSON without the envelope).<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>{\n  \"meta\": {\n    \"time\": \"2026-01-01T00:00:00+00:00\",\n    \"env\": \"prod\",\n    \"version\": \"v1\",\n    \"endpoint\": \"users\",\n    \"action\": \"list\",\n    \"error\": null,\n    \"status\": 200,\n    \"timezone\": \"America\/Toronto\"\n  },\n  \"data\": {}\n}\n<\/code><\/pre>\n\n\n\n<p>Notes:<\/p>\n\n\n\n<ul class=\"wp-r_indent50\">\n<li>If the payload contains <code>error<\/code>, it is copied into <code>meta.error<\/code>.<\/li>\n\n\n\n<li>Missing or invalid tokens return a bare body: <code>{\"error\":\"unauthorized\"}<\/code> (no envelope).<\/li>\n\n\n\n<li>Errors are exposed in <code>meta.error<\/code> (and sometimes in <code>data.error<\/code> when the payload includes it).<\/li>\n\n\n\n<li><code>meta.version<\/code> reports the API version used for the request.<\/li>\n<\/ul>\n","protected":false},"featured_media":0,"parent":2919,"menu_order":7,"template":"","doc_tag":[],"_links":{"self":[{"href":"https:\/\/www.airsupervision.com\/wp-r\/wp-json\/wp\/v2\/docs\/2938"}],"collection":[{"href":"https:\/\/www.airsupervision.com\/wp-r\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/www.airsupervision.com\/wp-r\/wp-json\/wp\/v2\/types\/docs"}],"version-history":[{"count":4,"href":"https:\/\/www.airsupervision.com\/wp-r\/wp-json\/wp\/v2\/docs\/2938\/revisions"}],"predecessor-version":[{"id":3352,"href":"https:\/\/www.airsupervision.com\/wp-r\/wp-json\/wp\/v2\/docs\/2938\/revisions\/3352"}],"up":[{"embeddable":true,"href":"https:\/\/www.airsupervision.com\/wp-r\/wp-json\/wp\/v2\/docs\/2919"}],"next":[{"title":"Errors","link":"https:\/\/www.airsupervision.com\/wp-r\/docs\/administrator\/apis\/errors\/","href":"https:\/\/www.airsupervision.com\/wp-r\/wp-json\/wp\/v2\/docs\/2943"}],"prev":[{"title":"Limits","link":"https:\/\/www.airsupervision.com\/wp-r\/docs\/administrator\/apis\/limits\/","href":"https:\/\/www.airsupervision.com\/wp-r\/wp-json\/wp\/v2\/docs\/2936"}],"wp:attachment":[{"href":"https:\/\/www.airsupervision.com\/wp-r\/wp-json\/wp\/v2\/media?parent=2938"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.airsupervision.com\/wp-r\/wp-json\/wp\/v2\/doc_tag?post=2938"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}