Report Pin

The report pin resource.

Basehttps://rest.carbon.ms/reportPin

GET/reportPin

List report pins

Retrieve a paginated list of report pins. 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/reportPin

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

Response

[
  {
    "reportKey": "string",
    "userId": "xyz789",
    "companyId": "xyz789",
    "pinned": true,
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "updatedBy": "string",
    "updatedAt": "2026-01-01T00:00:00Z"
  }
]

GET/reportPin

Retrieve a report pin

Fetch a single report pin by filtering on `reportKey`.

Query parameters

reportKeystring

Match on the report pin's `reportKey`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/reportPin

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

Response

{
  "reportKey": "string",
  "userId": "xyz789",
  "companyId": "xyz789",
  "pinned": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}

POST/reportPin

Create a report pin

Create a new report pin.

Body parameters

pinnedbooleanrequired

POSThttps://rest.carbon.ms/reportPin

curl --request POST \
  --url https://rest.carbon.ms/reportPin \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"pinned":true}'

Response

{
  "reportKey": "string",
  "userId": "xyz789",
  "companyId": "xyz789",
  "pinned": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}

PATCH/reportPin

Update a report pin

Update an existing report pin, matched on `reportKey`.

Body parameters

pinnedbooleanrequired

PATCHhttps://rest.carbon.ms/reportPin

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

Response

{
  "reportKey": "string",
  "userId": "xyz789",
  "companyId": "xyz789",
  "pinned": true,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}

DELETE/reportPin

Delete a report pin

Delete a report pin, matched on `reportKey`. Returns 204 No Content.

Query parameters

reportKeystring

The `reportKey` of the report pin to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/reportPin

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

204 No Content