Pagination and requests

The conventions on this page hold for every endpoint, so the resource pages do not repeat them.

The response envelope#

A successful response has success: true, the result in data, and the server's own timing in _timing.

{
  "success": true,
  "data": { },
  "_timing": { "duration_ms": 41 }
}

On a list endpoint data is an array, and the body adds pagination.

Page through a list#

List endpoints take two parameters:

The pagination object tells you where you are:

Loop until has_next is false. Use per_page=100 for syncs; it is the fewest requests against your rate limit.

async function* allOrders() {
  for (let page = 1; ; page++) {
    const res = await fetch(
      `https://api.rendezvu.co/api/brand/v1/orders?per_page=100&page=${page}`,
      { headers: { Authorization: `Bearer ${process.env.RENDEZVU_BRAND_API_KEY}` } },
    );
    const { data, pagination } = await res.json();
    yield* data;
    if (!pagination.has_next) return;
  }
}

import os, requests

def all_orders():
    page = 1
    while True:
        res = requests.get(
            "https://api.rendezvu.co/api/brand/v1/orders",
            params={"per_page": 100, "page": page},
            headers={"Authorization": f"Bearer {os.environ['RENDEZVU_BRAND_API_KEY']}"},
            timeout=30,
        )
        res.raise_for_status()
        body = res.json()
        yield from body["data"]
        if not body["pagination"]["has_next"]:
            return
        page += 1

Query parameters are strict#

An unknown query parameter is a 400, not something the API quietly ignores. A misspelled filter that silently returns everything is worse than an error, so the API refuses it.

There is no partner_id or brand_id parameter anywhere. The brand is always the key's.

Some filters take several values, comma-separated: status=active,completed. The reference marks those as csv.

Dates and times#

Dates in requests and responses are ISO 8601, in UTC. A filter accepts a date (2026-09-01) or a full timestamp (2026-09-01T00:00:00Z). Timestamps in responses carry milliseconds and a Z.

Caching#

Every response is sent with Cache-Control: no-store. If you need the data again, keep it in your own store rather than calling twice; most of it changes on the scale of hours, not seconds.