User Defaults

The user defaults resource.

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

List user defaultss

Retrieve a paginated list of user defaultss. 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/userDefaults
curl --request GET \
  --url 'https://rest.carbon.ms/userDefaults?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "userId": "xyz789",
    "companyId": "xyz789",
    "locationId": "xyz789"
  }
]
GET/userDefaults

Retrieve a user defaults

Fetch a single user defaults by filtering on `userId`.

Query parameters

userIdstring

Match on the user defaults's `userId`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/userDefaults
curl --request GET \
  --url 'https://rest.carbon.ms/userDefaults?userId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "userId": "xyz789",
  "companyId": "xyz789",
  "locationId": "xyz789"
}