Ability

The ability resource.

Basehttps://rest.carbon.ms/ability

GET/ability

List abilitys

Retrieve a paginated list of abilitys. 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/ability

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

Response

[
  {
    "id": "abc123def456",
    "name": "Example",
    "curve": "string",
    "shadowWeeks": 0,
    "active": true,
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string"
  }
]

GET/ability

Retrieve a ability

Fetch a single ability by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/ability

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

Response

{
  "id": "abc123def456",
  "name": "Example",
  "curve": "string",
  "shadowWeeks": 0,
  "active": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

POST/ability

Create a ability

Create a new ability.

Body parameters

namestringrequired

curveobjectrequired

shadowWeeksnumberrequired

activebooleanrequired

companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/ability

curl --request POST \
  --url https://rest.carbon.ms/ability \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","curve":"string","shadowWeeks":0,"active":true,"companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "name": "Example",
  "curve": "string",
  "shadowWeeks": 0,
  "active": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

PATCH/ability

Update a ability

Update an existing ability, matched on `id`.

Body parameters

namestringrequired

curveobjectrequired

shadowWeeksnumberrequired

activebooleanrequired

companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/ability

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

Response

{
  "id": "abc123def456",
  "name": "Example",
  "curve": "string",
  "shadowWeeks": 0,
  "active": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string"
}

DELETE/ability

Delete a ability

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/ability

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

204 No Content