Carbon

Training Assignment

The training assignment resource.

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

List training assignments

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

Retrieve a training assignment

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/trainingAssignment
curl --request GET \
  --url 'https://rest.carbon.ms/trainingAssignment?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "trainingId": "xyz789",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "groupIds": [],
  "updatedAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string"
}
POST/trainingAssignment

Create a training assignment

Create a new training assignment.

Body parameters

trainingIdstringrequired

References training.id

groupIdsarray
companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/trainingAssignment
curl --request POST \
  --url https://rest.carbon.ms/trainingAssignment \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"trainingId":"xyz789","companyId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "trainingId": "xyz789",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "groupIds": [],
  "updatedAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string"
}
PATCH/trainingAssignment

Update a training assignment

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

Body parameters

trainingIdstringrequired

References training.id

groupIdsarray
companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/trainingAssignment
curl --request PATCH \
  --url 'https://rest.carbon.ms/trainingAssignment?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"trainingId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "trainingId": "xyz789",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "groupIds": [],
  "updatedAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string"
}
DELETE/trainingAssignment

Delete a training assignment

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

Query parameters

idstring

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

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