Carbon

Tracked Activity

The tracked activity resource.

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

List tracked activitys

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

Retrieve a tracked activity

Fetch a single tracked activity by filtering on `id`.

Query parameters

idstring

Match on the tracked activity's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/trackedActivity
curl --request GET \
  --url 'https://rest.carbon.ms/trackedActivity?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "type": "string",
  "attributes": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "sourceDocument": "string",
  "sourceDocumentId": "xyz789"
}
POST/trackedActivity

Create a tracked activity

Create a new tracked activity.

Body parameters

typestringrequired
sourceDocumentstring
sourceDocumentIdstring
sourceDocumentReadableIdstring
attributesobjectrequired
companyIdstringrequired

References company.id

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

Update a tracked activity

Update an existing tracked activity, matched on `id`.

Body parameters

typestringrequired
sourceDocumentstring
sourceDocumentIdstring
sourceDocumentReadableIdstring
attributesobjectrequired
companyIdstringrequired

References company.id

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

Delete a tracked activity

Delete a tracked activity, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the tracked activity to delete, e.g. `eq.{id}`.

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