Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.tumban.com/llms.txt

Use this file to discover all available pages before exploring further.

Read the settings for the authenticated organization.
GET /api/v2/org/settings

Response

org_id
string
required
The organization id.
default_callback_url
string
The webhook URL Tumban falls back to when a scan is submitted without a callback_url. null if not configured.
total_scans_completed
integer
required
Lifetime count of scans that finished successfully for this organization.
total_scans_dropped
integer
required
Lifetime count of scans that did not produce a triage report (failures and timeouts).
created_at
string
required
When the organization was first seen by Tumban.
updated_at
string
required
When settings were last modified.
The webhook signing secret is never returned by this endpoint. Use Rotate webhook secret to obtain a new one.

Example

curl https://api.tumban.com/api/v2/org/settings \
  -H "Authorization: Bearer sk_xxx"
{
  "org_id": "org_2abc...",
  "default_callback_url": "https://your-app.example/webhooks/tumban",
  "total_scans_completed": 1284,
  "total_scans_dropped": 7,
  "created_at": "2026-01-15T08:32:11",
  "updated_at": "2026-04-12T17:14:02"
}

Errors

StatusDetail
404Org settings not found — the credential is valid but the org has no settings record yet (rare; usually auto-provisioned on first request).