{"id":2948,"date":"2026-01-26T08:29:47","date_gmt":"2026-01-26T13:29:47","guid":{"rendered":"https:\/\/www.airsupervision.com\/wp-r\/docs\/administrator\/apis\/common-payloads\/"},"modified":"2026-02-25T08:20:05","modified_gmt":"2026-02-25T13:20:05","slug":"common-payloads","status":"publish","type":"docs","link":"https:\/\/www.airsupervision.com\/wp-r\/docs\/administrator\/apis\/common-payloads\/","title":{"rendered":"Common payloads"},"content":{"rendered":"\n<h3 class=\"wp-block-heading\"><strong>List<a href=\"#list\"><\/a><\/strong><\/h3>\n\n\n\n<pre class=\"wp-block-code\"><code>{\n  \"limit\": 100,\n  \"page\": 1,\n  \"fields\": &#91;\"id\", \"name\"],\n  \"filters\": {\n    \"name\": { \"op\": \"like\", \"value\": \"Value%\" },\n    \"status\": \"active\"\n  },\n  \"order\": &#91;&#91;\"name\", \"ASC\"]]\n}\n<\/code><\/pre>\n\n\n\n<p>Options:<\/p>\n\n\n\n<ul class=\"wp-r_indent50\">\n<li><code>limit<\/code>: 1..500 (default 100).<\/li>\n\n\n\n<li><code>page<\/code>: &gt;= 1.<\/li>\n\n\n\n<li><code>fields<\/code>: array of API field names.<\/li>\n\n\n\n<li><code>filters<\/code>: scalar value or <code>{op, value}<\/code> with ops <code>=<\/code>, <code>like<\/code>, <code>&gt;<\/code>, <code>&lt;<\/code>, <code>&gt;=<\/code>, <code>&lt;=<\/code>.<\/li>\n\n\n\n<li><code>order<\/code>: list of <code>[field, direction]<\/code> pairs.<\/li>\n\n\n\n<li>Join fields defined in <code>*_joins<\/code> can be used in <code>fields<\/code>, <code>filters<\/code>, and <code>order<\/code>.<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Pagination<\/strong><\/h3>\n\n\n\n<p>List responses include pagination metadata in <code>data<\/code>:<\/p>\n\n\n\n<ul class=\"wp-r_indent50\">\n<li><code>page<\/code>: current page number (1-based).<\/li>\n\n\n\n<li><code>total_pages<\/code>: total pages based on <code>limit<\/code>.<\/li>\n\n\n\n<li><code>total_records<\/code>: total records matching the filters.<\/li>\n\n\n\n<li><code>count<\/code>: number of items in the current page.<\/li>\n<\/ul>\n\n\n\n<p>Interpretation:<\/p>\n\n\n\n<ul class=\"wp-r_indent50\">\n<li>Use <code>page<\/code> and <code>limit<\/code> in your request to navigate pages.<\/li>\n\n\n\n<li>When <code>page<\/code> &gt; <code>total_pages<\/code>, <code>items<\/code> is empty.<\/li>\n\n\n\n<li>Stop paging when <code>page<\/code> &gt;= <code>total_pages<\/code>.<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Add<\/strong><\/h3>\n\n\n\n<pre class=\"wp-block-code\"><code>{\n  \"field_a\": \"value\",\n  \"field_b\": 123,\n  \"other_column\": \"pass-through value\"\n}<\/code><\/pre>\n\n\n\n<p>Options:<\/p>\n\n\n\n<ul class=\"wp-r_indent50\">\n<li>Required keys are defined in&nbsp;<code>required_*_add_fields<\/code>.<\/li>\n\n\n\n<li>If&nbsp;<code>*_field_map<\/code>&nbsp;is set, keys are mapped to DB columns.<\/li>\n\n\n\n<li>Any key matching&nbsp;<code>\/^[A-Za-z0-9_]+$\/<\/code>&nbsp;is accepted as a pass-through column name.<\/li>\n<\/ul>\n","protected":false},"featured_media":0,"parent":2919,"menu_order":10,"template":"","doc_tag":[],"_links":{"self":[{"href":"https:\/\/www.airsupervision.com\/wp-r\/wp-json\/wp\/v2\/docs\/2948"}],"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\/2948\/revisions"}],"predecessor-version":[{"id":3357,"href":"https:\/\/www.airsupervision.com\/wp-r\/wp-json\/wp\/v2\/docs\/2948\/revisions\/3357"}],"up":[{"embeddable":true,"href":"https:\/\/www.airsupervision.com\/wp-r\/wp-json\/wp\/v2\/docs\/2919"}],"next":[{"title":"API resources","link":"https:\/\/www.airsupervision.com\/wp-r\/docs\/administrator\/apis\/resources\/","href":"https:\/\/www.airsupervision.com\/wp-r\/wp-json\/wp\/v2\/docs\/2953"}],"prev":[{"title":"Per-endpoint help","link":"https:\/\/www.airsupervision.com\/wp-r\/docs\/administrator\/apis\/per-endpoint-help\/","href":"https:\/\/www.airsupervision.com\/wp-r\/wp-json\/wp\/v2\/docs\/2946"}],"wp:attachment":[{"href":"https:\/\/www.airsupervision.com\/wp-r\/wp-json\/wp\/v2\/media?parent=2948"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.airsupervision.com\/wp-r\/wp-json\/wp\/v2\/doc_tag?post=2948"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}