Lesson Completion

The lesson completion resource.

Basehttps://rest.carbon.ms/lessonCompletion

GET/lessonCompletion

List lesson completions

Retrieve a paginated list of lesson completions. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/lessonCompletion

curl --request GET \
  --url 'https://rest.carbon.ms/lessonCompletion?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "userId": "xyz789",
    "courseId": "xyz789",
    "lessonId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]

GET/lessonCompletion

Retrieve a lesson completion

Fetch a single lesson completion by filtering on `userId`.

Query parameters

userIdstring

Match on the lesson completion's `userId`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/lessonCompletion

curl --request GET \
  --url 'https://rest.carbon.ms/lessonCompletion?userId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "userId": "xyz789",
  "courseId": "xyz789",
  "lessonId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

POST/lessonCompletion

Create a lesson completion

Create a new lesson completion.

POSThttps://rest.carbon.ms/lessonCompletion

curl --request POST \
  --url https://rest.carbon.ms/lessonCompletion \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"userId":"xyz789"}'

Response

{
  "userId": "xyz789",
  "courseId": "xyz789",
  "lessonId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

PATCH/lessonCompletion

Update a lesson completion

Update an existing lesson completion, matched on `userId`.

PATCHhttps://rest.carbon.ms/lessonCompletion

curl --request PATCH \
  --url 'https://rest.carbon.ms/lessonCompletion?userId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'

Response

{
  "userId": "xyz789",
  "courseId": "xyz789",
  "lessonId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

DELETE/lessonCompletion

Delete a lesson completion

Delete a lesson completion, matched on `userId`. Returns 204 No Content.

Query parameters

userIdstring

The `userId` of the lesson completion to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/lessonCompletion

curl --request DELETE \
  --url 'https://rest.carbon.ms/lessonCompletion?userId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content