User Attribute

The user attribute resource.

Basehttps://rest.carbon.ms/userAttribute

GET/userAttribute

List user attributes

Retrieve a paginated list of user attributes. 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/userAttribute

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

Response

[
  {
    "id": "abc123def456",
    "name": "Example",
    "sortOrder": 0,
    "userAttributeCategoryId": "xyz789",
    "attributeDataTypeId": 0,
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string",
    "listOptions": []
  }
]

GET/userAttribute

Retrieve a user attribute

Fetch a single user attribute by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/userAttribute

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

Response

{
  "id": "abc123def456",
  "name": "Example",
  "sortOrder": 0,
  "userAttributeCategoryId": "xyz789",
  "attributeDataTypeId": 0,
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "listOptions": []
}

POST/userAttribute

Create a user attribute

Create a new user attribute.

Body parameters

namestringrequired

sortOrdernumberrequired

userAttributeCategoryIdstringrequired

References userAttributeCategory.id

attributeDataTypeIdnumberrequired

References attributeDataType.id

listOptionsarray

canSelfManageboolean

activeboolean

POSThttps://rest.carbon.ms/userAttribute

curl --request POST \
  --url https://rest.carbon.ms/userAttribute \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","sortOrder":0,"userAttributeCategoryId":"xyz789","attributeDataTypeId":0}'

Response

{
  "id": "abc123def456",
  "name": "Example",
  "sortOrder": 0,
  "userAttributeCategoryId": "xyz789",
  "attributeDataTypeId": 0,
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "listOptions": []
}

PATCH/userAttribute

Update a user attribute

Update an existing user attribute, matched on `id`.

Body parameters

namestringrequired

sortOrdernumberrequired

userAttributeCategoryIdstringrequired

References userAttributeCategory.id

attributeDataTypeIdnumberrequired

References attributeDataType.id

listOptionsarray

canSelfManageboolean

activeboolean

PATCHhttps://rest.carbon.ms/userAttribute

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

Response

{
  "id": "abc123def456",
  "name": "Example",
  "sortOrder": 0,
  "userAttributeCategoryId": "xyz789",
  "attributeDataTypeId": 0,
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "listOptions": []
}

DELETE/userAttribute

Delete a user attribute

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/userAttribute

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

204 No Content