Carbon

User

The user resource.

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

List users

Retrieve a paginated list of users. 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/user
curl --request GET \
  --url 'https://rest.carbon.ms/user?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "about": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "acknowledgedITAR": true,
    "flags": "string"
  }
]
GET/user

Retrieve a user

Fetch a single user by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/user
curl --request GET \
  --url 'https://rest.carbon.ms/user?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "about": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "acknowledgedITAR": true,
  "flags": "string"
}
POST/user

Create a user

Create a new user.

Body parameters

emailstringrequired
firstNamestringrequired
lastNamestringrequired
fullNamestring
aboutstringrequired
avatarUrlstring
activeboolean
developerboolean
adminboolean
acknowledgedITARbooleanrequired
flagsobjectrequired
isConsoleOperatorbooleanrequired
phonestring
POSThttps://rest.carbon.ms/user
curl --request POST \
  --url https://rest.carbon.ms/user \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"email":"string","firstName":"string","lastName":"string","about":"string","acknowledgedITAR":true,"flags":"string","isConsoleOperator":true}'
Response
{
  "id": "abc123def456",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "about": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "acknowledgedITAR": true,
  "flags": "string"
}
PATCH/user

Update a user

Update an existing user, matched on `id`.

Body parameters

emailstringrequired
firstNamestringrequired
lastNamestringrequired
fullNamestring
aboutstringrequired
avatarUrlstring
activeboolean
developerboolean
adminboolean
acknowledgedITARbooleanrequired
flagsobjectrequired
isConsoleOperatorbooleanrequired
phonestring
PATCHhttps://rest.carbon.ms/user
curl --request PATCH \
  --url 'https://rest.carbon.ms/user?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"email":"string"}'
Response
{
  "id": "abc123def456",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "about": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "acknowledgedITAR": true,
  "flags": "string"
}
DELETE/user

Delete a user

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

Query parameters

idstring

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

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