Carbon

Group

The group resource.

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

List groups

Retrieve a paginated list of groups. 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/group
curl --request GET \
  --url 'https://rest.carbon.ms/group?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "name": "Example",
    "isIdentityGroup": true,
    "isEmployeeTypeGroup": true,
    "isCustomerOrgGroup": true,
    "isCustomerTypeGroup": true,
    "isSupplierTypeGroup": true,
    "isSupplierOrgGroup": true
  }
]
GET/group

Retrieve a group

Fetch a single group by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/group
curl --request GET \
  --url 'https://rest.carbon.ms/group?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "isIdentityGroup": true,
  "isEmployeeTypeGroup": true,
  "isCustomerOrgGroup": true,
  "isCustomerTypeGroup": true,
  "isSupplierTypeGroup": true,
  "isSupplierOrgGroup": true
}
POST/group

Create a group

Create a new group.

Body parameters

namestringrequired
companyIdstring

References company.id

isIdentityGroupbooleanrequired
isEmployeeTypeGroupbooleanrequired
isCustomerOrgGroupbooleanrequired
isCustomerTypeGroupbooleanrequired
isSupplierTypeGroupbooleanrequired
isSupplierOrgGroupbooleanrequired
POSThttps://rest.carbon.ms/group
curl --request POST \
  --url https://rest.carbon.ms/group \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","isIdentityGroup":true,"isEmployeeTypeGroup":true,"isCustomerOrgGroup":true,"isCustomerTypeGroup":true,"isSupplierTypeGroup":true,"isSupplierOrgGroup":true}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "isIdentityGroup": true,
  "isEmployeeTypeGroup": true,
  "isCustomerOrgGroup": true,
  "isCustomerTypeGroup": true,
  "isSupplierTypeGroup": true,
  "isSupplierOrgGroup": true
}
PATCH/group

Update a group

Update an existing group, matched on `id`.

Body parameters

namestringrequired
companyIdstring

References company.id

isIdentityGroupbooleanrequired
isEmployeeTypeGroupbooleanrequired
isCustomerOrgGroupbooleanrequired
isCustomerTypeGroupbooleanrequired
isSupplierTypeGroupbooleanrequired
isSupplierOrgGroupbooleanrequired
PATCHhttps://rest.carbon.ms/group
curl --request PATCH \
  --url 'https://rest.carbon.ms/group?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",
  "isIdentityGroup": true,
  "isEmployeeTypeGroup": true,
  "isCustomerOrgGroup": true,
  "isCustomerTypeGroup": true,
  "isSupplierTypeGroup": true,
  "isSupplierOrgGroup": true
}
DELETE/group

Delete a group

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

Query parameters

idstring

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

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