Get user progress across course content blocks

Returns aggregate user progress across content blocks in a course layer. Scoped to your integration’s institution via Basic Auth credentials.

GET/users/{id}/progress

Authorization

AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Path parameters

idstringrequired

User ID

Query parameters

layerIdstringrequired

Layer ID of the course (same value as course.layerId on the course entity).

Responses

200

User progress data

dataUserProgressResponserequired

Show properties

userIdstringrequired

layerIdstringrequired

summaryUserProgressSummaryrequired

Show properties

totalBlocksintegerrequired

completedintegerrequired

inProgressintegerrequired

notStartedintegerrequired

completionPercentageintegerrequired

min 0 · max 100

blocksBlockProgress[]required

Show properties

Array of BlockProgress

blockIdstringrequired

blockNamestringrequired

blockTypestringrequired

statusstringrequired

Allowed:NOT_STARTEDIN_PROGRESSFINISHEDREVIEWED

lockStatestringrequired

Allowed:UNLOCKEDBLOCKED

startedAtstring<date-time> | nullrequired

completedAtstring<date-time> | nullrequired

userDataobject

blockedReasonstring

metaResponseMetarequired

Show properties

requestIdstringrequired

timestampstring<date-time>required

versionstringrequired

Allowed:v4

watermarkstring<date-time>

Present on GET /users?updatedSince= pages. Taken at the first page minus a 60s overlap. Bound into pagination.next_cursor. Use it as the next updatedSince after deduping by user id. Delivery is inclusive >= and at-least-once.

401

Unauthorized

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedidempotency_key_in_progressservice_unavailableretryablerate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

existingUserIdstring

Present on 409 email or membership-code conflicts. The user id that already holds the email or code.

activeSessionobject

Present on time-tracking start 409 when a session is already running. Stop this session, then retry start.

Show properties

idstringrequired

startTimestring<date-time>required

conflictingLogobject

Present on time-tracking 409 when the interval being written overlaps an existing log or open session. Start uses [punch, ∞). Stop uses [sessionStart, stop). endTime is null while that session is still open.

Show properties

idstringrequired

startTimestring<date-time>required

endTimestring<date-time> | nullrequired

403

Forbidden

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedidempotency_key_in_progressservice_unavailableretryablerate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

existingUserIdstring

Present on 409 email or membership-code conflicts. The user id that already holds the email or code.

activeSessionobject

Present on time-tracking start 409 when a session is already running. Stop this session, then retry start.

Show properties

idstringrequired

startTimestring<date-time>required

conflictingLogobject

Show properties

idstringrequired

startTimestring<date-time>required

endTimestring<date-time> | nullrequired

404

Not Found

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedidempotency_key_in_progressservice_unavailableretryablerate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

existingUserIdstring

Present on 409 email or membership-code conflicts. The user id that already holds the email or code.

activeSessionobject

Present on time-tracking start 409 when a session is already running. Stop this session, then retry start.

Show properties

idstringrequired

startTimestring<date-time>required

conflictingLogobject

Show properties

idstringrequired

startTimestring<date-time>required

endTimestring<date-time> | nullrequired

429

Too Many Requests — 1000 requests per minute per institution. Includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (ISO-8601), and Retry-After (seconds).

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedidempotency_key_in_progressservice_unavailableretryablerate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

existingUserIdstring

Present on 409 email or membership-code conflicts. The user id that already holds the email or code.

activeSessionobject

Present on time-tracking start 409 when a session is already running. Stop this session, then retry start.

Show properties

idstringrequired

startTimestring<date-time>required

conflictingLogobject

Show properties

idstringrequired

startTimestring<date-time>required

endTimestring<date-time> | nullrequired

500

Internal Server Error

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedidempotency_key_in_progressservice_unavailableretryablerate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

existingUserIdstring

Present on 409 email or membership-code conflicts. The user id that already holds the email or code.

activeSessionobject

Present on time-tracking start 409 when a session is already running. Stop this session, then retry start.

Show properties

idstringrequired

startTimestring<date-time>required

conflictingLogobject

Show properties

idstringrequired

startTimestring<date-time>required

endTimestring<date-time> | nullrequired

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*User IDlayerIdquery*Layer ID of the course (same value as course.layerId on the course entity).

Request

curl -X GET 'https://fuxam.app/api/v4/users/string/progress?layerId=string' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json'

const response = await fetch("https://fuxam.app/api/v4/users/string/progress?layerId=string", {
  method: "GET",
  headers: {
    "Authorization": "Basic YOUR_CREDENTIALS",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://fuxam.app/api/v4/users/string/progress?layerId=string",
    headers={
        "Authorization": "Basic YOUR_CREDENTIALS",
        "Accept": "application/json"
    },
)

Response

{
  "data": {
    "userId": "string",
    "layerId": "string",
    "summary": {
      "totalBlocks": 0,
      "completed": 0,
      "inProgress": 0,
      "notStarted": 0,
      "completionPercentage": 0
    },
    "blocks": [
      {
        "blockId": "string",
        "blockName": "string",
        "blockType": "string",
        "status": "NOT_STARTED",
        "lockState": "UNLOCKED",
        "startedAt": "2019-08-24T14:15:22Z",
        "completedAt": "2019-08-24T14:15:22Z",
        "userData": {},
        "blockedReason": "string"
      }
    ]
  },
  "meta": {
    "requestId": "req_1234567890_abc",
    "timestamp": "2026-06-02T07:00:00.000Z",
    "version": "v4",
    "watermark": "2019-08-24T14:15:22Z"
  }
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "existingUserId": "string",
  "activeSession": {
    "id": "string",
    "startTime": "2019-08-24T14:15:22Z"
  },
  "conflictingLog": {
    "id": "string",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z"
  }
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "existingUserId": "string",
  "activeSession": {
    "id": "string",
    "startTime": "2019-08-24T14:15:22Z"
  },
  "conflictingLog": {
    "id": "string",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z"
  }
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "existingUserId": "string",
  "activeSession": {
    "id": "string",
    "startTime": "2019-08-24T14:15:22Z"
  },
  "conflictingLog": {
    "id": "string",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z"
  }
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "existingUserId": "string",
  "activeSession": {
    "id": "string",
    "startTime": "2019-08-24T14:15:22Z"
  },
  "conflictingLog": {
    "id": "string",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z"
  }
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "existingUserId": "string",
  "activeSession": {
    "id": "string",
    "startTime": "2019-08-24T14:15:22Z"
  },
  "conflictingLog": {
    "id": "string",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z"
  }
}