Skip to Content
APIリファレンス招待招待一覧

招待一覧

GET/console/v1/accounts/{accountId}/invitations

承諾されていない、有効期限内の招待の一覧を取得します。

認証

Authorizationstring必須

Bearer <マネジメントトークン> の形式で指定します。 詳しくは認証を参照してください。

パスパラメーター

accountIdstring必須

組織のID。 コンソールのURLの /accounts/ に続く部分です。

レスポンス

viewerobject

マネジメントトークンの発行者の権限。

フィールドを表示フィールドを非表示
canInviteboolean

メンバーを招待できるかどうか。

canCancelboolean

招待を削除できるかどうか。

invitationsarray

招待の配列。 作成日時の新しい順に並びます。

フィールドを表示フィールドを非表示
invitationIdstring

招待のID。

roleobject

招待したメンバーに付与するロール。 roleId と effectiveRole を含みます。

invitedEmailstring | null

招待先のメールアドレス。 リンクでの招待では null です。

createdAtstring

作成日時(ISO 8601)。

expiresAtstring

有効期限(ISO 8601)。

エラー

エラーの形式はエラーを参照してください。

ステータスコードerror原因
401console_authentication_failedマネジメントトークンが正しくない、または有効期限が切れている
403console_authorization_denied操作する権限がない
404not_foundリソースが見つからない、またはIDの形式が正しくない
503console_invitations_unavailableサービスが一時的に利用できない