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

Authorization

AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Path parameters

idstringrequired

Query parameters

cursorstring

limitinteger

default: 10

Responses

200

List 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

401

Unauthorized

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

404

Not 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

429

Too 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

500

Internal 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

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Basic auth usernameBasic auth password

Remember on this deviceInclude my values in samples

Parameters

idpath*cursorquerylimitquery

Request

curl -X GET 'https://fuxam.app/api/v4/users/user-groups/string/members' \
  -H 'Authorization: Basic YOUR_CREDENTIALS'

const response = await fetch("https://fuxam.app/api/v4/users/user-groups/string/members", {
  method: "GET",
  headers: {
    "Authorization": "Basic YOUR_CREDENTIALS"
  }
});

import requests

response = requests.get(
    "https://fuxam.app/api/v4/users/user-groups/string/members",
    headers={
        "Authorization": "Basic YOUR_CREDENTIALS"
    },
)

Response

{
  "data": [
    {
      "id": "string",
      "groupId": "string",
      "userId": "string",
      "institutionId": "string",
      "since": "2019-08-24T14:15:22Z",
      "user": {
        "id": "string",
        "name": "string",
        "email": "user@example.com",
        "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"
  }
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}