Platform

Who am I and where am I working (module status)

Polling snapshot: the same current record or collection as the corresponding read endpoint, including its state and progress. List filters, defaults and pagination also apply here. This is not an event history or a changes-since feed. Poll at a sensible interval (start with 30 seconds), respect Retry-After on 429 and stop when the required terminal state is reached.

Returns the acting user, the organisation (tenant) this call resolved to, the modules that organisation has enabled, the commercial tier it holds on each, and the exact set of things this credential may do. CALL THIS FIRST: every other tool is gated on what it reports, so knowing it saves you from guessing which tools exist. Costs nothing and reads no business data.

Examples

  • What can you do in Custodo? GET /api/v1/rest/status
get/api/v1/rest/status

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/status
  • Auth: HTTP bearer

Headers

X-Tenant-Idstring uuid

The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.

Response

Done. data is the tool’s own answer.

oktrue required
dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.