Groups

List group members

Returns a paginated list of members in the group. Any member of the group can list members.

GET
/groups/{group_name}/members

Authorization

token_auth
AuthorizationBearer <token>

Token-based authentication using access tokens.

In: header

Path Parameters

group_name*string

Query Parameters

page?Page

Page number.

Default1
per_page?Per Page

Items per page.

Default20
Range1 <= value <= 100
order?Order

Sort order.

Default"desc"
Value in"asc" | "desc"

Response Body

application/json

application/json

curl -X GET "https://v2.api.piktid.com/groups/string/members"
{
  "members": [
    {
      "email": "string",
      "username": "string",
      "name": "string",
      "role": "string"
    }
  ],
  "pagination": {
    "page": 0,
    "per_page": 0,
    "total": 0,
    "pages": 0,
    "has_next": true,
    "has_prev": true
  }
}
{
  "error": "Invalid request",
  "detail": [
    {
      "field": null,
      "message": "string",
      "position": "query"
    }
  ]
}
Empty