Responses & Pagination
The standard response envelope, pagination, and sync queries.
List response envelope
List endpoints return a standard envelope: your data, a meta block with
pagination, and a _meta block carrying the disclaimers and a docs link.
{
"data": [ /* … array of resources … */ ],
"meta": {
"page": 1,
"per_page": 50,
"total": 142,
"next_page": 2
},
"_meta": {
"disclaimers": [
"coverage_state and gap_amount reflect inventory valuation status, not insurance coverage adequacy. …",
"market_value_estimate is derived from third-party market data and is not a guarantee of resale value. …"
],
"documentation_url": "https://onetakeapp.com/api/v1/docs#adequacy-disclaimer"
}
}Single-resource endpoints (like /items/{id}) return the resource directly,
plus the same _meta block.
_meta fields
| Field | Type | Notes |
|---|---|---|
disclaimers | string[] | Plain-text adequacy disclaimer statements. See The disclaimers below. |
documentation_url | string | Deep link to the adequacy-disclaimer section of the API docs. Open it to read the plain-English explanation of what the valuation fields mean. |
Pagination
Use page and per_page on any list endpoint:
GET /v1/items?page=2&per_page=50- Default page size is 50.
per_pageis clamped to a maximum of 100. Requesting more than 100 silently caps at 100 — it does not return an error.meta.next_pageis the next page number, ornullwhen you're on the last page. You can loopwhile (meta.next_page)without computing page math yourself.
Result ordering
List results are ordered newest-updated first. When two items share the
same updated_at, they are ordered by id descending. This ordering is stable
across pages — you won't see the same item twice or miss an item when paginating
a result set that isn't changing.
Sync with updated_since
Every list endpoint accepts updated_since with an ISO 8601 timestamp, so you
can pull only what changed since your last sync:
GET /v1/items?updated_since=2026-04-01T00:00:00ZThis returns only items updated at or after that timestamp. Passing a value
that isn't a valid timestamp returns a 400 error.
The disclaimers
The _meta.disclaimers array appears on every response — list or single
resource. It contains plain-text statements about the limits of the data:
- One disclaimer notes that
coverage_stateandgap_amountdescribe your inventory's valuation status, not insurance adequacy. - One disclaimer notes that
market_value_estimateis derived from third-party market data and is not a guarantee of resale value.
_meta.documentation_url links directly to the adequacy-disclaimer section of
the API reference docs, where the same statements are explained in plain
English. If you build a tool on top of this API, that URL is the right place to
point users who ask what the valuation fields mean.
See Item schema for what those fields mean.