組織の一覧

GET /v1/organizations · 権限 organizations:read

この環境の組織を新しい順に一覧表示します。ページングは前方向(after)のみ対応しています。before や desc 以外の order を指定すると 422 が返されます。フィルタは完全一致で、削除済みの組織は一覧に含まれません。

リクエスト

フィールド 型 必須 説明
limit integer いいえ ページサイズ(1〜100、既定値は 20)。
after string いいえ 前のページの list_metadata.after カーソル。
status string いいえ 指定したステータスの組織のみ:active、disabled、pending_deletion。
slug string いいえ 現在のスラッグに対する完全一致。
external_id string いいえ external_id に対する完全一致。
domain string いいえ 現時点では未対応です。422 が返されます。

リクエストボディはありません。

レスポンス

組織のページを含む 200 OK が返されます。

{
  "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
  }
}

エラー

HTTP code 発生条件
400 invalid_cursor カーソルの形式が不正であるか、別のフィルタに属しています。
422 validation_failed クエリパラメータが不正です(before、order=asc、domain、未知の status)。
401 unauthenticated 認証情報が指定されていないか、不正であるか、取り消されています。
403 insufficient_permissions 認証情報に必要な権限がありません。
429 rate_limited レート制限を超えました。Retry-After の期間が経過してから再試行してください。
503 service_unavailable 依存先が一時的に利用できません。Retry-After の期間が経過してから再試行してください。

例

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