Groups

The groups resource.

Basehttps://rest.carbon.ms/groups

GET/groups

List groupss

Retrieve a paginated list of groupss. 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/groups

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

Response

[
  {
    "name": "Example",
    "id": "abc123def456",
    "isEmployeeTypeGroup": true,
    "isCustomerOrgGroup": true,
    "isCustomerTypeGroup": true,
    "isSupplierOrgGroup": true,
    "isSupplierTypeGroup": true,
    "companyId": "xyz789"
  }
]

GET/groups

Retrieve a groups

Fetch a single groups by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/groups

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

Response

{
  "name": "Example",
  "id": "abc123def456",
  "isEmployeeTypeGroup": true,
  "isCustomerOrgGroup": true,
  "isCustomerTypeGroup": true,
  "isSupplierOrgGroup": true,
  "isSupplierTypeGroup": true,
  "companyId": "xyz789"
}