Risk Register

The risk register resource.

Basehttps://rest.carbon.ms/riskRegister

GET/riskRegister

List risk registers

Retrieve a paginated list of risk registers. 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/riskRegister

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

Response

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "companyId": "xyz789",
    "title": "string",
    "source": "string",
    "status": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "type": "string",
    "description": "string"
  }
]

GET/riskRegister

Retrieve a risk register

Fetch a single risk register by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/riskRegister

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

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "companyId": "xyz789",
  "title": "string",
  "source": "string",
  "status": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "type": "string",
  "description": "string"
}

POST/riskRegister

Create a risk register

Create a new risk register.

Body parameters

companyIdstringrequired

References company.id

titlestringrequired

descriptionstring

sourceriskSourcerequired

sourceIdstring

severitynumber

likelihoodnumber

itemIdstring

References item.id

statusriskStatusrequired

assigneestring

References user.id

notesobject

typeriskRegisterTyperequired

POSThttps://rest.carbon.ms/riskRegister

curl --request POST \
  --url https://rest.carbon.ms/riskRegister \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"companyId":"xyz789","title":"string","description":"string","source":"string","status":"string","type":"string"}'

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "companyId": "xyz789",
  "title": "string",
  "source": "string",
  "status": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "type": "string",
  "description": "string"
}

PATCH/riskRegister

Update a risk register

Update an existing risk register, matched on `id`.

Body parameters

companyIdstringrequired

References company.id

titlestringrequired

descriptionstring

sourceriskSourcerequired

sourceIdstring

severitynumber

likelihoodnumber

itemIdstring

References item.id

statusriskStatusrequired

assigneestring

References user.id

notesobject

typeriskRegisterTyperequired

PATCHhttps://rest.carbon.ms/riskRegister

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

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "companyId": "xyz789",
  "title": "string",
  "source": "string",
  "status": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "type": "string",
  "description": "string"
}

DELETE/riskRegister

Delete a risk register

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/riskRegister

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

204 No Content