Groups

Manages groups of users in Box for easier collaboration and permission assignment across files and folders.

Table Specific Information

You can retrieve all the Groups or filter them by Id.

SELECT * FROM Groups;

If you're authenticated as an administrator with user impersonation permissions, you can query groups from multiple user accounts:

SELECT * FROM Groups WHERE AsUserId IN (SELECT Id FROM Users);

Note: User impersonation has the following limitations:

The authenticated user cannot be impersonated unless that user is a service account.
If the authenticated user is a standard user account, they can only query groups associated with their account.
Groups shared with multiple users are only returned for one of the users.

Only the Name column is required to create a Group.

INSERT INTO Groups (Name, Provenance, MemberViewabilityLevel) VALUES ('new group', 'google', 'admins_only');

Any column where ReadOnly=False can be updated.

UPDATE Groups SET InvitabilityLevel = 'admins_and_members' WHERE Id = '111';

Delete a group by specifying its Id:

DELETE FROM Groups WHERE Id = '111';


Name	Type	ReadOnly	Description
ID [KEY]	String	True	Unique identifier assigned to the group.
Name	String	False	The display name of the group.
Provenance	String	False	Tracks the external system or source from which the group originated, often used for integration purposes.
ExternalSyncIdentifier	String	False	An identifier used to map the group to an external system when groups are synchronized from outside sources.
Description	String	False	A user-provided description that explains the purpose or membership of the group.
InvitabilityLevel	String	False	Defines who is allowed to invite this group to collaborate on folders, such as admins only or all group members.
MemberViewabilityLevel	String	False	Defines who is allowed to view the membership of the group, such as only admins or all collaborators.
CreatedAt	Datetime	True	The date and time when the group was originally created. An Id must be specified to retrieve this field.
ModifiedAt	Datetime	True	The date and time when the group's details were last updated. An Id must be specified to retrieve this field.
AsUserId	String	False	Identifier of the user to impersonate for API requests, available only for Admin, Co-Admin, and Service Accounts.