Membership

The membership resource.

Basehttps://rest.carbon.ms/membership

GET/membership

List memberships

Retrieve a paginated list of memberships. 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/membership

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

Response

[
  {
    "id": 0,
    "groupId": "xyz789",
    "memberGroupId": "xyz789",
    "memberUserId": "xyz789"
  }
]

GET/membership

Retrieve a membership

Fetch a single membership by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/membership

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

Response

{
  "id": 0,
  "groupId": "xyz789",
  "memberGroupId": "xyz789",
  "memberUserId": "xyz789"
}

POST/membership

Create a membership

Create a new membership.

Body parameters

groupIdstringrequired

References group.id

memberGroupIdstring

References group.id

memberUserIdstring

References user.id

POSThttps://rest.carbon.ms/membership

curl --request POST \
  --url https://rest.carbon.ms/membership \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"groupId":"xyz789"}'

Response

{
  "id": 0,
  "groupId": "xyz789",
  "memberGroupId": "xyz789",
  "memberUserId": "xyz789"
}

PATCH/membership

Update a membership

Update an existing membership, matched on `id`.

Body parameters

groupIdstringrequired

References group.id

memberGroupIdstring

References group.id

memberUserIdstring

References user.id

PATCHhttps://rest.carbon.ms/membership

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

Response

{
  "id": 0,
  "groupId": "xyz789",
  "memberGroupId": "xyz789",
  "memberUserId": "xyz789"
}

DELETE/membership

Delete a membership

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/membership

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

204 No Content