Skip to main content
GET
/
groups
/
{id}
/
members
Get Group Members
curl --request GET \
  --url https://{tenantDomain}/api/v2/groups/{id}/members \
  --header 'Authorization: Bearer <token>'
{
  "members": [
    {
      "id": "<string>",
      "member_type": "user",
      "type": "connection",
      "connection_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Unique identifier for the group (service-generated).

Required string length: 25 - 26
Pattern: ^grp_[1-9a-km-zA-HJ-NP-Z]{21,22}$

Query Parameters

​
fields
string

A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields

Maximum string length: 256
Pattern: ^((id)|(member_type)|(type)|(connection_id)|(created_at))(,((id)|(member_type)|(type)|(connection_id)|(created_at)))*$
​
include_fields
boolean

Whether specified fields are to be included (true) or excluded (false).

​
from
string

Optional Id from which to start selection.

​
take
integer

Number of results per page. Defaults to 50.

Required range: 1 <= x <= 100

Response

Group members successfully retrieved.

​
members
object[]
required
​
next
string

A cursor to be used as the "from" query parameter for the next page of results.