Box Developerドキュメント

グループを取得

get
https://api.box.com/2.0
/groups/:group_id

グループに関する情報を取得します。このグループのメンバー、または管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
57645

グループのID。

クエリパラメータ

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

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

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

レスポンス

application/jsonグループ (Full)

グループオブジェクトを返します

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

get
グループを取得
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X GET "https://api.box.com/2.0/groups/57645" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.groups.getGroupById(group.id);
Python Gen
client.groups.get_group_by_id(group.id)
.NET Gen
await client.Groups.GetGroupByIdAsync(groupId: group.Id);
Java
String groupID = "92875";
BoxGroup.Info groupInfo = new BoxGroup(api, groupID).getInfo();
Python
group = client.group(group_id='11111').get()
print(f'Got group {group.name}')
.NET
BoxGroup group = await client.GroupsManager.GetGroupAsync("11111");
Node
client.groups.get('11111')
	.then(group => {
		/* group -> {
			type: 'group',
			id: '11111',
			name: 'Everyone',
			created_at: '2014-09-15T13:15:35-07:00',
			modified_at: '2014-09-15T13:15:35-07:00' }
		*/
	});
iOS
client.groups.get(groupId: "12345") {
(result: Result<Group, BoxSDKError>) in
    guard case let .success(group) = result else {
        print("Error getting group information")
        return
    }

    print("Group with name \(group.name) was retrieved.")
}

レスポンスの例

{
  "id": "11446498",
  "type": "group",
  "created_at": "2012-12-12T10:53:43-08:00",
  "description": "Support Group - as imported from Active Directory",
  "external_sync_identifier": "AD:123456",
  "group_type": "managed_group",
  "invitability_level": "admins_only",
  "member_viewability_level": "admins_only",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "name": "Support",
  "permissions": {
    "can_invite_as_collaborator": true
  },
  "provenance": "Active Directory"
}