Common payloads

Published 26 January 2026, Updated 26 January 2026

List

{
  "limit": 100,
  "page": 1,
  "fields": ["id", "name"],
  "filters": {
    "name": { "op": "like", "value": "Value%" },
    "status": "active"
  },
  "order": [["name", "ASC"]]
}

Options:

• limit: 1..500 (default 100).
• page: >= 1.
• fields: array of API field names.
• filters: scalar value or {op, value} with ops =, like, >, <, >=, <=.
• order: list of [field, direction] pairs.
• Join fields defined in *_joins can be used in fields, filters, and order.

Pagination

List responses include pagination metadata in data:

• page: current page number (1-based).
• total_pages: total pages based on limit.
• total_records: total records matching the filters.
• count: number of items in the current page.

Interpretation:

• Use page and limit in your request to navigate pages.
• When page > total_pages, items is empty.
• Stop paging when page >= total_pages.

Add

{
  "field_a": "value",
  "field_b": 123,
  "other_column": "pass-through value"
}

Options:

• Required keys are defined in required_*_add_fields.
• If *_field_map is set, keys are mapped to DB columns.
• Any key matching /^[A-Za-z0-9_]+$/ is accepted as a pass-through column name.