Discovery

GET /v1

Connectivity check

api:discovery

Request exampleNo request body

curl

curl https://api.rieckflow.com/v1 \
  -H "Authorization: Bearer $RIECK_API_KEY"

TypeScript

const svar = await rieck.request("GET", "/v1");

Response

{
  "data": {
    "apiVersion": "v1",
    "organizationId": "f38d6d63-a127-45a8-8efd-02cd1239578f",
    "scopes": [
      "api:discovery",
      "customers:read",
      "invoices:read",
      "invoices:write"
    ]
  }
}

200 API version, organisation id and the key’s scopes.application/json

Response fields 3

Field	Type	Description
data.apiVersion	string	Current path-version of the API.
data.organizationId	uuid	Organisation authenticated by the API key.
data.scopes	string[]	Scopes granted to the current key.

Possible errors 4

HTTP	Code	Meaning
401	invalid_api_key	The API key is missing, invalid, expired or revoked.
403	api_not_included	The organisation’s plan does not include API access.
403	insufficient_scope	The key does not have the required scope.
429	rate_limited	The organisation’s rate budget is exhausted.

---

GET /v1/status

Service status

Unauthenticated. Intended for uptime monitors: it consumes no rate budget and writes no audit entry, so it can be polled continuously. Returns 503 while the service cannot serve requests. Does not report the status of your own data or integrations.

Request exampleNo request body

curl

curl https://api.rieckflow.com/v1/status \
  -H "Authorization: Bearer $RIECK_API_KEY"

TypeScript

const svar = await rieck.request("GET", "/v1/status");

Response

{
  "data": {}
}

200 API version and whether the service is currently serving requests.application/json

Possible errors 3

HTTP	Code	Meaning
401	invalid_api_key	The API key is missing, invalid, expired or revoked.
403	api_not_included	The organisation’s plan does not include API access.
429	rate_limited	The organisation’s rate budget is exhausted.