メインコンテンツへスキップ
GET
cURL
このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

承認

Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

パスパラメータ

invite_id
string
必須

招待のID。

クエリパラメータ

fields
string[]

レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。

このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。

レスポンス

招待オブジェクトを返します。

会社へのユーザーの招待。

id
string
必須

この招待の一意の識別子。

例:

"11446498"

type
enum<string>
必須

値は常にinviteになります。

利用可能なオプション:
invite
例:

"invite"

invited_to
Enterprise · object

Box Enterpriseのレプリゼンテーション。

actionable_by
ユーザー (Mini) · object

他のリソース内にネストされたときに返される可能性があるユーザーのMini版の表示。

invited_by
ユーザー (Mini) · object

他のリソース内にネストされたときに返される可能性があるユーザーのMini版の表示。

status
string

招待のステータス。

例:

"pending"

created_at
string<date-time>

招待が作成された日時。

例:

"2012-12-12T10:53:43-08:00"

modified_at
string<date-time>

招待が変更された日時。

例:

"2012-12-12T10:53:43-08:00"

最終更新日 2026年1月23日