Carbon

Training Completion

The training completion resource.

Basehttps://rest.carbon.ms/trainingCompletion
GET/trainingCompletion

List training completions

Retrieve a paginated list of training 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/trainingCompletion
curl --request GET \
  --url 'https://rest.carbon.ms/trainingCompletion?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": 0,
    "trainingAssignmentId": "xyz789",
    "employeeId": "xyz789",
    "companyId": "xyz789",
    "completedAt": "2026-01-01T00:00:00Z",
    "completedBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string"
  }
]
GET/trainingCompletion

Retrieve a training completion

Fetch a single training completion by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/trainingCompletion
curl --request GET \
  --url 'https://rest.carbon.ms/trainingCompletion?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": 0,
  "trainingAssignmentId": "xyz789",
  "employeeId": "xyz789",
  "companyId": "xyz789",
  "completedAt": "2026-01-01T00:00:00Z",
  "completedBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}
POST/trainingCompletion

Create a training completion

Create a new training completion.

Body parameters

trainingAssignmentIdstringrequired

References trainingAssignment.id

employeeIdstringrequired

References user.id

companyIdstringrequired

References company.id

completedAttimestamprequired
completedBystringrequired
periodstring
POSThttps://rest.carbon.ms/trainingCompletion
curl --request POST \
  --url https://rest.carbon.ms/trainingCompletion \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"trainingAssignmentId":"xyz789","employeeId":"xyz789","companyId":"xyz789","completedAt":"2026-01-01T00:00:00Z","completedBy":"string"}'
Response
{
  "id": 0,
  "trainingAssignmentId": "xyz789",
  "employeeId": "xyz789",
  "companyId": "xyz789",
  "completedAt": "2026-01-01T00:00:00Z",
  "completedBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}
PATCH/trainingCompletion

Update a training completion

Update an existing training completion, matched on `id`.

Body parameters

trainingAssignmentIdstringrequired

References trainingAssignment.id

employeeIdstringrequired

References user.id

companyIdstringrequired

References company.id

completedAttimestamprequired
completedBystringrequired
periodstring
PATCHhttps://rest.carbon.ms/trainingCompletion
curl --request PATCH \
  --url 'https://rest.carbon.ms/trainingCompletion?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"trainingAssignmentId":"xyz789"}'
Response
{
  "id": 0,
  "trainingAssignmentId": "xyz789",
  "employeeId": "xyz789",
  "companyId": "xyz789",
  "completedAt": "2026-01-01T00:00:00Z",
  "completedBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}
DELETE/trainingCompletion

Delete a training completion

Delete a training completion, matched on `id`. Returns 204 No Content.

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/trainingCompletion
curl --request DELETE \
  --url 'https://rest.carbon.ms/trainingCompletion?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content