Tenants · Documentation

Why this endpoint exists

An admin key (sflo_admin_) can reach several organizations, and most endpoints need you to name one. Without this endpoint you would have to copy organization IDs out of the admin console by hand. Organization keys (sflo_live_) can call it too—they simply get their own single organization back, so your integration does not need two code paths.

List accessible organizations

GET/v1/tenants

Scope: tenants:read

Takes no parameters and needs no X-SigFollow-Tenant-Id header—the response is the list of organizations you may target.

Request

curl https://api.sigfollow.com/v1/tenants \
  -H "Authorization: Bearer sflo_admin_xxx"

Response

{
  "data": [
    { "id": "clx7tenantacme01", "name": "Acme Corp" },
    { "id": "clx7tenantglobex", "name": "Globex" }
  ]
}

Sorted by name. An empty dataarray means the key currently has no reachable organization—for an admin key that usually means its issuer's permissions changed.

The list matches what you can actually call

This endpoint and the per-request authorization check derive from the same rule, so an organization listed here will accept your calls, and one that is absent will not. The set is computed on every request rather than cached: when an administrator gains or loses access to an organization, keys they issued follow immediately.

For an admin key the reachable set is the issuer's current permissions, optionally narrowed by an explicit allow-list chosen when the key was created. See Authentication for how to target one of these organizations on the other endpoints.

Existing keys need re-issuing for this scope

tenants:read is a new scope. Keys created before it existed do not carry it and will receive 403—create a new key (or re-issue the existing one) with the scope selected.