Capabilities

Read what this version of the API can do

Returns the ceilings, the vocabularies and the guarantees this version publishes, so a client can read them instead of hard-coding them: how many sections a report takes, which shapes a widget can have, which periods a report can be built for, how long a confirmation token lives, which endpoints confirm and which accept if_version, and whether write access is enabled for the account that is calling. Everything else in this document is fixed at publication time; this endpoint is the one that answers for today.

post/capabilities

Request

  • Base URL: https://api.reportingninja.com/v1
  • URL: https://api.reportingninja.com/v1/capabilities
  • Auth: HTTP bearer

Request body

CapabilitiesRequest required

No parameters.

Response

The call succeeded. This endpoint reports its errors with a real HTTP status, so a 200 always carries status=ok.

status'ok' required

Changes

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