Elenca le organizzazioni

GET /v1/organizations · autorizzazione organizations:read

Elenca le organizzazioni dell'ambiente, dalla più recente. Esiste solo la paginazione in avanti (after); before e un order diverso da desc restituiscono 422. I filtri sono corrispondenze esatte; le organizzazioni eliminate non vengono elencate.

Richiesta

Campo Tipo Obbligatorio Descrizione
limit integer no Dimensione della pagina, da 1 a 100 (predefinito 20).
after string no Il cursore list_metadata.after della pagina precedente.
status string no Solo le organizzazioni in questo stato: active, disabled o pending_deletion.
slug string no Corrispondenza esatta con lo slug attuale.
external_id string no Corrispondenza esatta con external_id.
domain string no Non ancora supportato; restituisce 422.

Nessun corpo della richiesta.

Risposta

200 OK con una pagina di organizzazioni.

{
  "data": [
    {
      "id": "org_01j9xk3m7q8r2s4t6v8w0y2z4a",
      "name": "Acme Corp",
      "slug": "acme",
      "external_id": "crm-4821",
      "status": "active",
      "metadata": {
        "tier": "gold"
      },
      "brand_color": "#1F6FEB",
      "max_memberships": null,
      "default_zoneinfo": null,
      "created_via": "admin_api",
      "disabled_at": null,
      "deletion_requested_at": null,
      "deletion_due_at": null,
      "created_at": "2026-10-12T09:30:00.123456Z",
      "updated_at": "2026-10-12T09:30:00.123456Z",
      "version": 1
    }
  ],
  "list_metadata": {
    "before": null,
    "after": null
  }
}

Errori

HTTP codice Quando
400 invalid_cursor Il cursore è malformato o appartiene ad altri filtri.
422 validation_failed Un parametro della query non è valido (before, order=asc, domain, status sconosciuto).
401 unauthenticated La credenziale manca, non è valida o è stata revocata.
403 insufficient_permissions La credenziale non ha l'autorizzazione richiesta.
429 rate_limited È stato superato il limite di richieste; riprova dopo il periodo indicato in Retry-After.
503 service_unavailable Una dipendenza non è temporaneamente disponibile; riprova dopo il periodo indicato in Retry-After.

Esempio

curl "https://api.eu.keenauth.com/v1/organizations?status=active&limit=20" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"