メインコンテンツへスキップ
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.

パスパラメータ

collaboration_id
string
必須

コラボレーションのID。

クエリパラメータ

fields
string[]

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

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

レスポンス

コラボレーションオブジェクトを返します。

アクセス制御リストと同様に、コラボレーションではファイルとフォルダに 対するユーザーおよびグループのアクセス権限が定義されます。コラボレーションオブジェクトは、特定のロールによって定義される権限を含んだファイルまたはフォルダへのアクセス権限をユーザーまたはグループに付与します。

id
string
必須

このコラボレーションの一意の識別子。

例:

"12345678"

type
enum<string>
必須

値は常にcollaborationになります。

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

"collaboration"

item
File · object

アクセスが許可されているファイルまたはフォルダ。コラボレーションのstatusがpendingの場合またはコラボレーションがアプリ項目に作成されている場合 (app_itemフィールド参照)、このフィールドはnullです。

app_item
アプリ項目 · object | null

アクセスが許可されているapp_item。コラボレーションが項目に作成されている場合 (itemフィールド参照) またはapp_itemにアクセスできない場合、このフィールドはnullです。ロールは、app_itemに関連付けられたすべての項目にカスケードされます。

accessible_by
ユーザー (コラボレーション) · object

ユーザーのMini版の表示は、ステータスがpendingの場合にのみ返すことができます。

invite_email
string | null

登録済みユーザーでない未登録コラボレータを招待するために使用されたメールアドレス。

例:

"john@example.com"

role
enum<string>

付与されるアクセスレベル。

利用可能なオプション:
editor,
viewer,
previewer,
uploader,
previewer uploader,
viewer uploader,
co-owner,
owner
例:

"editor"

expires_at
string<date-time> | null

コラボレーションの有効期限。有効期限が設定されていない場合はnull。

例:

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

is_access_only
boolean

trueに設定した場合、コラボレータは共有項目にアクセスできますが、これらの項目は [すべてのファイル] リストに表示されません。また、コラボレータには共有項目のルートフォルダのパスも表示されません。

例:

true

status
enum<string>

コラボレーション招待のステータス。ステータスがpendingの場合、nameは空の文字列を返します。

利用可能なオプション:
accepted,
pending,
rejected
例:

"accepted"

acknowledged_at
string<date-time>

コラボレーションオブジェクトのstatusがacceptedまたはrejectedに変更された日時。

例:

"2012-12-12T10:55:20-08:00"

created_by
ユーザー (コラボレーション) · object

コラボレーションオブジェクトを作成したユーザー。

例:
created_at
string<date-time>

コラボレーションオブジェクトが作成された日時。

例:

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

modified_at
string<date-time>

コラボレーションオブジェクトが最後に変更された日時。

例:

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

acceptance_requirements_status
object
最終更新日 2026年1月23日