User Module Preference

The user module preference resource.

Basehttps://rest.carbon.ms/userModulePreference

GET/userModulePreference

List user module preferences

Retrieve a paginated list of user module preferences. 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/userModulePreference

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

Response

[
  {
    "id": "abc123def456",
    "userId": "xyz789",
    "companyId": "xyz789",
    "module": "string",
    "position": 0,
    "hidden": true,
    "updatedAt": "2026-01-01T00:00:00Z"
  }
]

GET/userModulePreference

Retrieve a user module preference

Fetch a single user module preference by filtering on `id`.

Query parameters

idstring

Match on the user module preference's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/userModulePreference

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

Response

{
  "id": "abc123def456",
  "userId": "xyz789",
  "companyId": "xyz789",
  "module": "string",
  "position": 0,
  "hidden": true,
  "updatedAt": "2026-01-01T00:00:00Z"
}

POST/userModulePreference

Create a user module preference

Create a new user module preference.

Body parameters

userIdstringrequired

References user.id

companyIdstringrequired

References company.id

modulestringrequired

positionnumberrequired

hiddenbooleanrequired

POSThttps://rest.carbon.ms/userModulePreference

curl --request POST \
  --url https://rest.carbon.ms/userModulePreference \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"userId":"xyz789","companyId":"xyz789","module":"string","position":0,"hidden":true}'

Response

{
  "id": "abc123def456",
  "userId": "xyz789",
  "companyId": "xyz789",
  "module": "string",
  "position": 0,
  "hidden": true,
  "updatedAt": "2026-01-01T00:00:00Z"
}

PATCH/userModulePreference

Update a user module preference

Update an existing user module preference, matched on `id`.

Body parameters

userIdstringrequired

References user.id

companyIdstringrequired

References company.id

modulestringrequired

positionnumberrequired

hiddenbooleanrequired

PATCHhttps://rest.carbon.ms/userModulePreference

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

Response

{
  "id": "abc123def456",
  "userId": "xyz789",
  "companyId": "xyz789",
  "module": "string",
  "position": 0,
  "hidden": true,
  "updatedAt": "2026-01-01T00:00:00Z"
}

DELETE/userModulePreference

Delete a user module preference

Delete a user module preference, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the user module preference to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/userModulePreference

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

204 No Content