Skip to content
Rigyx

The REST API

Everything the portal can do, available over HTTP. Scoped tokens, JSON in and out, HMAC-signed webhooks — wire Rigyx into your own stack or any automation tool.

The API is plain HTTPS and JSON, so it works from any language with an HTTP client — no SDK required. Every request is authenticated with a token and scoped to the one business that token belongs to.

Base URL

The API is versioned in the path. Breaking changes ship under a new version; /v1 stays stable.

Base URL
https://rigyx.com/api/public/v1

Quickstart

From zero to a live API call in three steps:

  1. 1
    Create a token
    In the portal, open Settings → Developer and create a token with the scopes you need. Copy it — it is shown only once.
  2. 2
    Confirm it works
    Call /whoami — it echoes back the business and scopes your token is bound to.
  3. 3
    Make a real call
    List your leads. Every list endpoint is cursor-paginated.
curl
# 2 — confirm the token
curl -H "Authorization: Bearer jmt_..." \
  https://rigyx.com/api/public/v1/whoami

# 3 — list leads
curl -H "Authorization: Bearer jmt_..." \
  https://rigyx.com/api/public/v1/leads

The OpenAPI spec

The full API is also published as a machine-readable OpenAPI 3.1 document. Import it into Postman, Insomnia, Stoplight or Swagger UI to get a typed client and a request explorer for free.

OpenAPI
GET https://rigyx.com/api/public/v1/openapi.json
The spec is the authoritative endpoint list — it is generated from the same registries the server uses, so it never drifts out of sync with what the API actually accepts.

What every endpoint shares

JSON only
Requests and responses are JSON. Fields are snake_case to match the data model — company_name, created_at.
Versioned
The version lives in the URL path. A /v2 would only appear for breaking changes; additions never break /v1.
Scoped & isolated
A token carries explicit scopes and is bound to one business. There is no way to read another business's data with it.
Predictable
Cursor pagination, idempotency keys, rate-limit headers and a single error shape — the same across every endpoint.
Where to go next
Authentication covers tokens and scopes in full. Conventions covers pagination, idempotency, rate limits and errors. The Endpoint reference lists every route.
PreviousDocumentation homeNextAuthentication