Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
user
Group Users

List Group Users

List Group Users

get/user/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).

group_idinteger

Group ID. If provided, will return group_users of this group.

user_idinteger

User ID. If provided, will return group_users of this user.

Response

A list of GroupUsers objects.

group_namestring

Group name

group_idinteger

Group ID

user_idinteger

User ID

adminboolean

Is this user an administrator of this group?

usernamestring

Username of the user

Example response

[
  {
    "group_name": "My Group",
    "group_id": 1,
    "user_id": 1,
    "admin": true,
    "username": "example"
  }
]