Join BoxWorks 2024 to discover what's possible with content and AI!

Groups

A list of groups.

A list of groups

limit integer (int64)

example1000

The limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.

offset integer (int64)

example2000

The 0-based offset of the first entry in this set. This will be the same as the offset query parameter.

This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.

order object array

The order by which items are returned.

This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.

[order].by string

exampletype

The field to order by

[order].direction string

exampleASC

The direction to order by, either ascending or descending

Value is one of ASC,DESC

total_count integer (int64)

example5000

One greater than the offset of the last entry in the entire collection. The total number of entries in the collection may be less than total_count.

This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.

Response Example

{
  "entries": [
    {
      "id": "11446498",
      "type": "group",
      "name": "Support",
      "group_type": "managed_group",
      "created_at": "2012-12-12T10:53:43-08:00",
      "modified_at": "2012-12-12T10:53:43-08:00",
      "provenance": "Active Directory",
      "external_sync_identifier": "AD:123456",
      "description": "Support Group - as imported from Active Directory",
      "invitability_level": "admins_only",
      "member_viewability_level": "admins_only",
      "permissions": {
        "can_invite_as_collaborator": true
      }
    }
  ],
  "limit": 1000,
  "offset": 2000,
  "order": [
    {
      "by": "type",
      "direction": "ASC"
    }
  ],
  "total_count": 5000
}