Skip to main content
The Grantiva API is organized around REST. All requests and responses use JSON. The base URL is:

Health check

See Health for the detailed and per-component checks.

Surfaces

See Authentication for what each surface accepts.

Errors

Errors return a JSON envelope with a stable machine-readable code:
The full envelope, including hint and fields, is described in API Conventions.

Rate limiting

Rate limits vary by plan and by endpoint bucket. When exceeded, the API returns 429 Too Many Requests with a Retry-After header. See API Conventions for the per-tier table.

Pagination

Paginated endpoints take page and a page-size parameter, but the response envelope differs by surface:
  • items + metadata — feature requests, devices under /api/v1/devices, audit log.
  • items + page + per + total (flat) — the /api/v1/org/* console endpoints.
  • data + meta (page, perPage, total, totalPages) — GET /api/v1/analytics/events.
Each endpoint page states which envelope it returns and what its page-size parameter is called.