Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
groups
Groups

List Groups

List Groups

get/groups

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are site_id, workspace_id or name.

If set, return records where the specified field is equal to the supplied value. Valid fields are name and workspace_id. Valid field combinations are [ workspace_id, name ].

If set, return records where the specified field is prefixed by the supplied value. Valid fields are name.

idsstring

Comma-separated list of group ids to include in results.

include_parent_site_groupsboolean

Include groups from the parent site.

Response

A list of Groups objects.

idinteger

Group ID

namestring

Group name

allowed_ipsstring

A list of allowed IPs if applicable. Newline delimited

admin_idsstring

Comma-delimited list of user IDs who are group administrators (separated by commas)

notesstring

Notes about this group

user_idsstring

Comma-delimited list of user IDs who belong to this group (separated by commas)

usernamesstring

Comma-delimited list of usernames who belong to this group (separated by commas)

ai_assistant_personality_idinteger

AI Assistant Personality ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user or Partner assignment overrides it.

ftp_permissionboolean

If true, users in this group can use FTP to login. This will override a false value of ftp_permission on the user level.

sftp_permissionboolean

If true, users in this group can use SFTP to login. This will override a false value of sftp_permission on the user level.

dav_permissionboolean

If true, users in this group can use WebDAV to login. This will override a false value of dav_permission on the user level.

restapi_permissionboolean

If true, users in this group can use the REST API to login. This will override a false value of restapi_permission on the user level.

desktop_configuration_profile_idinteger

Desktop Configuration Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.

integration_centric_profile_idinteger

Integration Centric Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.

site_idinteger

Site ID

workspace_idinteger

Workspace ID

Example response

[
  {
    "id": 1,
    "name": "owners",
    "allowed_ips": "10.0.0.0/8\n127.0.0.1",
    "admin_ids": "1",
    "notes": "example",
    "user_ids": "1",
    "usernames": "user",
    "ai_assistant_personality_id": 1,
    "ftp_permission": true,
    "sftp_permission": true,
    "dav_permission": true,
    "restapi_permission": true,
    "desktop_configuration_profile_id": 1,
    "integration_centric_profile_id": 1,
    "site_id": 1
  }
]