tenancy

GET /v1/orgs

List organizations in scope.

すべての tenancy エンドポイント

認証

ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

curl -X GET https://api.zinndigital.com/v1/orgs \
  -H "Authorization: Bearer zdk_live_…"

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

Lists the organizations the principal can access, walking the tenancy tree. Cursor-paginated. RLS guarantees no organization outside the principal's subtree is ever returned (CLAUDE.md §2.3).

パラメータ

名前タイプ必須これがその内容です
cursor (query)stringいいえOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerいいえMaximum items to return (page size).
type (query)OrgTypeいいえFilter by organization type.

返信

名前タイプ必須これがその内容です
dataOrganization[]はい
pagePageMetaはい

このエンドポイントが返すエラー

401 · 429