List users

Returns a cursor-paginated list of users in the institution.

GET/users

Authorization

AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Query parameters

searchstring

Search by name or email

includeInactiveboolean

Include inactive users (default: false)

codestring

Filter by institution membership code

layerIdstring

Filter by course layer ID

cursorstring

Opaque cursor from previous response

limitinteger

min 1 · max 100 · default: 10

Responses

200

List of users

dataUser[]required

Show properties

Array of User

idstringrequired

namestringrequired

emailstring<email>required

imagestring | nullrequired

activityStatusUserActivityStatusrequired

Show properties

isActivebooleanrequired

isActiveFromstring<date-time> | nullrequired

isActiveUntilstring<date-time> | nullrequired

paginationCursorPaginationrequired

Show properties

next_cursorstring | nullrequired

has_morebooleanrequired

limitintegerrequired

metaResponseMetarequired

Show properties

requestIdstringrequired

timestampstring<date-time>required

versionstringrequired

Allowed:v4

400

Bad Request

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

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

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

searchquerySearch by name or emailincludeInactivequeryInclude inactive users (default: false)codequeryFilter by institution membership codelayerIdqueryFilter by course layer IDcursorqueryOpaque cursor from previous responselimitquery

Request

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

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

import requests

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

Response

{
  "data": [
    {
      "id": "clx1234567890",
      "name": "Jane Doe",
      "email": "jane@example.com",
      "image": "string",
      "activityStatus": {
        "isActive": true,
        "isActiveFrom": "2026-01-01T00:00:00.000Z",
        "isActiveUntil": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "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"
    }
  ]
}