Carbon

Suggestion

The suggestion resource.

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

List suggestions

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

Retrieve a suggestion

Fetch a single suggestion by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/suggestion
curl --request GET \
  --url 'https://rest.carbon.ms/suggestion?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "suggestion": "string",
  "emoji": "string",
  "path": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "attachmentPath": "string",
  "tags": []
}
POST/suggestion

Create a suggestion

Create a new suggestion.

Body parameters

suggestionstringrequired
emojistringrequired
pathstringrequired
attachmentPathstring
tagsarray
userIdstring

References user.id

companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/suggestion
curl --request POST \
  --url https://rest.carbon.ms/suggestion \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"suggestion":"string","emoji":"string","path":"string","companyId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "suggestion": "string",
  "emoji": "string",
  "path": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "attachmentPath": "string",
  "tags": []
}
PATCH/suggestion

Update a suggestion

Update an existing suggestion, matched on `id`.

Body parameters

suggestionstringrequired
emojistringrequired
pathstringrequired
attachmentPathstring
tagsarray
userIdstring

References user.id

companyIdstringrequired

References company.id

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

Delete a suggestion

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

Query parameters

idstring

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

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