FIfiles
group_users
Group Users

List Group Users

Changed on

List Group Users

get/group_users

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/group_users
  • Auth
    none declared

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, returns memberships of this group. Requires a Site Administrator, a Read-only Administrator, a Workspace Administrator for the group's workspace, or a Group Administrator 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"
  }
]

Changes

  • 3bb8c8a06041Revision changes
    • info

      api tag Group Users added

  • 334e0cf90234Revision changes
    • warning

      deleted the query request parameter action

    • warning

      deleted the query request parameter page

    • info

      api operation id getGroupUsers removed and replaced with GetGroupUsers

    • info

      added the new optional query request parameter cursor