Skip to content

Conventions

Conventions that hold across the whole API.

https://api.rindee.dev/v1

Every endpoint lives under the /v1 prefix. Breaking changes ship under a new version prefix; additive changes (new fields, new endpoints) can appear within v1, so write tolerant parsers that ignore unknown fields.

  • JSON in, JSON out (Content-Type: application/json).
  • Send your API key as Authorization: Bearer rk_live_… on every request.
  • Resource IDs are UUIDs unless documented otherwise.
  • Timestamps are ISO-8601 in UTC (e.g. 2026-06-29T12:34:56Z).

List endpoints return their items in a data array:

{ "data": [ /* … */ ] }

Larger collections use cursor pagination. Pass limit (page size) and cursor, and read the next page from next_cursor in the response (it’s null on the last page):

Terminal window
curl "https://api.rindee.dev/v1/contacts?limit=20" \
-H "Authorization: Bearer rk_live_your_key_here"
# → { "data": [ … ], "next_cursor": "eyJ…" }
curl "https://api.rindee.dev/v1/contacts?limit=20&cursor=eyJ…" \
-H "Authorization: Bearer rk_live_your_key_here"

The interactive API reference documents the exact query parameters and response shape for each endpoint.