Box Developerドキュメント
ログイン
最新バージョン

ユーザー招待ステータスを取得

get
https://api.box.com/2.0
/invites/:invite_id

ユーザー招待のステータスを返します。

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
213723

招待のID。

クエリパラメータ

string arrayクエリ内省略可能
id,type,name

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

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

レスポンス

application/jsonInvite

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

application/jsonクライアントエラー

予期しないクライアントエラー。

get
ユーザー招待ステータスを取得
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X GET "https://api.box.com/2.0/invites/213723" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.invites.getInviteById(invitation.id);
Python Gen
client.invites.get_invite_by_id(invitation.id)
.NET Gen
await client.Invites.GetInviteByIdAsync(inviteId: invitation.Id);

レスポンスの例

{
  "id": "11446498",
  "type": "invite",
  "actionable_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "created_at": "2012-12-12T10:53:43-08:00",
  "invited_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "invited_to": {
    "id": "11446498",
    "type": "enterprise",
    "name": "Acme Inc."
  },
  "modified_at": "2012-12-12T10:53:43-08:00",
  "status": "pending"
}