Carbon

Invite

The invite resource.

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

List invites

Retrieve a paginated list of invites. 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/invite
curl --request GET \
  --url 'https://rest.carbon.ms/invite?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "code": "string",
    "email": "string",
    "permissions": "string",
    "role": "string",
    "companyId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]
GET/invite

Retrieve a invite

Fetch a single invite by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/invite
curl --request GET \
  --url 'https://rest.carbon.ms/invite?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "code": "string",
  "email": "string",
  "permissions": "string",
  "role": "string",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
POST/invite

Create a invite

Create a new invite.

Body parameters

codestringrequired
emailstringrequired
permissionsobjectrequired
rolestringrequired
companyIdstringrequired

References company.id

acceptedAttimestamp
revokedAttimestamp
POSThttps://rest.carbon.ms/invite
curl --request POST \
  --url https://rest.carbon.ms/invite \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"code":"string","email":"string","permissions":"string","role":"string","companyId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "code": "string",
  "email": "string",
  "permissions": "string",
  "role": "string",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
PATCH/invite

Update a invite

Update an existing invite, matched on `id`.

Body parameters

codestringrequired
emailstringrequired
permissionsobjectrequired
rolestringrequired
companyIdstringrequired

References company.id

acceptedAttimestamp
revokedAttimestamp
PATCHhttps://rest.carbon.ms/invite
curl --request PATCH \
  --url 'https://rest.carbon.ms/invite?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"code":"string"}'
Response
{
  "id": "abc123def456",
  "code": "string",
  "email": "string",
  "permissions": "string",
  "role": "string",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}
DELETE/invite

Delete a invite

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

Query parameters

idstring

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

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