Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

group_id
string<uuid>
required

The unique identifier for the group.

Query Parameters

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0
sort
enum<string>[]

A comma separated list of fields to sort by.

Available options:
email,
-email,
first_name,
-first_name,
last_name,
-last_name
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • email: Filter by email address(es) (case insensitive)
  • name: Filter by name(s) - filters by first and last name (case insensitive)
  • combined: Filter by name(s) and email address(es) (case insensitive)

For more information on using named filters, see the docs

Response

Get a list of the member users of a role group.

JSON API response object

data
A list of group members · object[]
required
meta
object
required
jsonapi
object
required