Skip to content
Docs
English
Esc
navigateopen⌘Jpreview

Get progress for a user on a content block

Returns a user’s progress on a content block. Scoped to your integration’s institution via Basic Auth credentials.

GET/content-blocks/{id}/progress/{userId}
Path parameters
idstringrequired
Content block ID
userIdstringrequired
User ID
Responses
200Progress details
dataBlockProgressDetailrequired
Show properties
blockIdstringrequired
userIdstringrequired
statusstringrequired
Allowed:NOT_STARTEDIN_PROGRESSFINISHEDREVIEWED
lockStatestringrequired
Allowed:UNLOCKEDBLOCKED
startedAtstring<date-time> | nullrequired
completedAtstring<date-time> | nullrequired
userDataobject
conditionsConditionStatus[]required
Show properties
Array of ConditionStatus
conditionIdstringrequired
requiredBlockIdstringrequired
requiredBlockNamestringrequired
metbooleanrequired
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
403Forbidden
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/content-blocks/string/progress/string"
Response
{
  "data": {
    "blockId": "string",
    "userId": "string",
    "status": "NOT_STARTED",
    "lockState": "UNLOCKED",
    "startedAt": "2024-01-01T00:00:00Z",
    "completedAt": "2024-01-01T00:00:00Z",
    "userData": {},
    "conditions": [
      {
        "conditionId": "string",
        "requiredBlockId": "string",
        "requiredBlockName": "string",
        "met": true
      }
    ]
  },
  "meta": {
    "requestId": "req_1234567890_abc",
    "timestamp": "2026-06-02T07:00:00.000Z",
    "version": "v4"
  }
}