最新バージョン
会社のグループのリストを取得
APIバージョン 2024.0
指定した会社のすべてのグループを取得します。会社のグループを調べるには、管理者権限が必要です。
リクエスト
bearer [ACCESS_TOKEN]
application/json
クエリパラメータ
string arrayクエリ内省略可能
id,type,nameレスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。
stringクエリ内省略可能
Engineeringnameが検索語句で始まるグループのみに結果を絞り込みます。
integer (int64)クエリ内省略可能
10001000返す項目の1ページあたりの最大数。
integer (int64)クエリ内省略可能
10000レスポンスが開始される項目のオフセット。
オフセットパラメータ値が10,000を超えているクエリは拒否され、400レスポンスが返されます。
リクエストの例
cURL
curl -i -X GET "https://api.box.com/2.0/groups" \
-H "authorization: Bearer <ACCESS_TOKEN>"Node/TypeScript v10
await client.groups.getGroups();Python v10
client.groups.get_groups().NET v10
await client.Groups.GetGroupsAsync();Swift v10
try await client.groups.getGroups()Java v10
client.getGroups().getGroups()Java v5
Iterable<BoxGroup.Info> groups = BoxGroup.getAllGroups(api);
for (BoxGroup.Info groupInfo : groups) {
// Do something with the group.
}Python v4
groups = client.get_groups()
for group in groups:
print(f'Group "{group.name}" has ID "{group.id}"').NET v6
BoxCollection<BoxGroup> groups = await client.GroupsManager.GetAllGroupsAsync();Node v4
client.groups.getAll()
.then(groups => {
/* groups -> {
total_count: 1,
entries: [ { type: 'group', id: '1786931', name: 'friends' } ],
limit: 100,
offset: 0 }
*/
});レスポンスの例
{
"entries": [
{
"id": "11446498",
"type": "group",
"group_type": "managed_group",
"name": "Support",
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00",
"description": "Support Group - as imported from Active Directory",
"external_sync_identifier": "AD:123456",
"invitability_level": "admins_only",
"member_viewability_level": "admins_only",
"permissions": {
"can_invite_as_collaborator": true
},
"provenance": "Active Directory"
}
],
"limit": 1000,
"offset": 2000,
"order": [
{
"by": "type",
"direction": "ASC"
}
],
"total_count": 5000
}