Zum Inhalt springen
Docs
Deutsch
Esc
navigateopen⌘Jpreview

List members of a user group

Lists members of a user group. Scoped to your integration’s institution via Basic Auth credentials.

GET/users/user-groups/{id}/members
Path parameters
idstringrequired
Query parameters
cursorstring
limitinteger
default: 10
Responses
200List of group members
dataUserGroupMembership[]required
Show properties
Array of UserGroupMembership
idstringrequired
groupIdstringrequired
userIdstringrequired
institutionIdstringrequired
sincestring<date-time>required
userobjectrequired
Show properties
idstringrequired
namestringrequired
emailstring<email>required
imagestring | null
paginationCursorPaginationrequired
Show properties
next_cursorstring | nullrequired
has_morebooleanrequired
limitintegerrequired
metaResponseMetarequired
Show properties
requestIdstringrequired
timestampstring<date-time>required
versionstringrequired
Allowed:v4
401Unauthorized
typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
404Not Found
typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
429Too Many Requests
typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
500Internal Server Error
typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
Request
curl -X GET "https://fuxam.app/api/v4/users/user-groups/string/members"
Response
{
  "data": [
    {
      "id": "string",
      "groupId": "string",
      "userId": "string",
      "institutionId": "string",
      "since": "2024-01-01T00:00:00Z",
      "user": {
        "id": "string",
        "name": "string",
        "email": "<email>",
        "image": "string"
      }
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "has_more": true,
    "limit": 0
  },
  "meta": {
    "requestId": "req_1234567890_abc",
    "timestamp": "2026-06-02T07:00:00.000Z",
    "version": "v4"
  }
}