Group Members

The group members resource.

Basehttps://rest.carbon.ms/groupMembers

GET/groupMembers

List group memberss

Retrieve a paginated list of group memberss. 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/groupMembers

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

Response

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

GET/groupMembers

Retrieve a group members

Fetch a single group members by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/groupMembers

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

Response

{
  "id": 0,
  "name": "Example",
  "companyId": "xyz789",
  "isIdentityGroup": true,
  "isEmployeeTypeGroup": true,
  "isCustomerOrgGroup": true,
  "isCustomerTypeGroup": true,
  "isSupplierOrgGroup": true
}