Guides Reference

Using this reference

The API reference is an interactive, always-current view of the API. It is generated from the same OpenAPI contract the API is built on, and it is scoped to this environment (production), so every URL, audience and example on it already points at https://api.cybersentriq.com. This guide explains how to read it and how to try a call.

Find an endpoint

Endpoints are grouped in the left sidebar by area (for example General, Your account and Organization). Use the search box to jump to an endpoint by path or name, and select any endpoint to open its full detail on the right.

Read an endpoint

Each endpoint shows what it needs and what it returns:

  • Required permission. A callout at the top of the endpoint states what your token needs. A 🔑 callout names the permission (and the coarse api:full:* scope that also authorizes it): for example self:profile:write or api:full:write. A 🔐 callout means the endpoint needs only a signed-in user, with no specific permission. See Permissions.
  • Parameters. Path, query and header inputs, with their types and whether each is required. Every versioned endpoint takes an api-version query parameter; see Endpoints you call for how to pin it.
  • Request and response bodies. The schema of each, with an example. Responses may gain fields over time, so decode leniently.

Try a request

Open Test Request on an endpoint to send a live call from your browser and see the real response.

  • Set the parameters and, for a write, the request body.
  • Add your token: paste an access token as the Authorization value (see Authentication overview for how to get one). On a signed-in browser session on this origin, the reference reuses your session automatically. On development you can use the Log in button at the top of the page.
  • Send the request and read the status, headers and body inline.

Test Request calls the real API for this environment. Send reads freely; take the same care with writes that you would from your own client.

Tell us what you rely on

Every endpoint carries a Declare reliance control. Use it to record the endpoint, field or permission your integration depends on. We use those declarations to notify you before we change or retire something you rely on. See API contract and stability.

Read it as data

The reference is a rendering of two machine-readable sources you can consume directly:

Both grow as more of the API opens up.

Next