Overview

API

Everything the Admin Console does is an API — the console is just a client.

Authentication

Create an API credential in the console (Users & Teams → API credentials): you get a client ID/secret for the OAuth 2.0 client_credentials grant. Each credential carries explicit scopes, an optional IP allow-list, and an expiry; every use is attributable in the audit log.

curl -X POST https://<tenant-api>/oauth/token \
  -d grant_type=client_credentials \
  -d client_id=... -d client_secret=... -d scope="activity:read"

Typical uses

Conventions

JSON in/out; standard HTTP statuses; errors carry a human-readable message. Credentials are revocable instantly from the console.


Revision #1
Created 2026-08-01 13:06:32 UTC by Sentilai Docs
Updated 2026-08-01 13:06:32 UTC by Sentilai Docs