Carbon

Period

The period resource.

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

List periods

Retrieve a paginated list of periods. 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/period
curl --request GET \
  --url 'https://rest.carbon.ms/period?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "startDate": "2026-01-01",
    "endDate": "2026-01-01",
    "periodType": "string",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]
GET/period

Retrieve a period

Fetch a single period by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/period
curl --request GET \
  --url 'https://rest.carbon.ms/period?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "startDate": "2026-01-01",
  "endDate": "2026-01-01",
  "periodType": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
POST/period

Create a period

Create a new period.

Body parameters

startDatedaterequired
endDatedaterequired
periodTypeperiodTyperequired
POSThttps://rest.carbon.ms/period
curl --request POST \
  --url https://rest.carbon.ms/period \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"startDate":"2026-01-01","endDate":"2026-01-01","periodType":"string"}'
Response
{
  "id": "abc123def456",
  "startDate": "2026-01-01",
  "endDate": "2026-01-01",
  "periodType": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
PATCH/period

Update a period

Update an existing period, matched on `id`.

Body parameters

startDatedaterequired
endDatedaterequired
periodTypeperiodTyperequired
PATCHhttps://rest.carbon.ms/period
curl --request PATCH \
  --url 'https://rest.carbon.ms/period?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"startDate":"2026-01-01"}'
Response
{
  "id": "abc123def456",
  "startDate": "2026-01-01",
  "endDate": "2026-01-01",
  "periodType": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
DELETE/period

Delete a period

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

Query parameters

idstring

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

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