User To Company

The user to company resource.

Basehttps://rest.carbon.ms/userToCompany

GET/userToCompany

List user to companys

Retrieve a paginated list of user to companys. 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/userToCompany

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

Response

[
  {
    "userId": "xyz789",
    "companyId": "xyz789",
    "role": "string"
  }
]

GET/userToCompany

Retrieve a user to company

Fetch a single user to company by filtering on `userId`.

Query parameters

userIdstring

Match on the user to company's `userId`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/userToCompany

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

Response

{
  "userId": "xyz789",
  "companyId": "xyz789",
  "role": "string"
}

POST/userToCompany

Create a user to company

Create a new user to company.

Body parameters

rolestringrequired

POSThttps://rest.carbon.ms/userToCompany

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

Response

{
  "userId": "xyz789",
  "companyId": "xyz789",
  "role": "string"
}

PATCH/userToCompany

Update a user to company

Update an existing user to company, matched on `userId`.

Body parameters

rolestringrequired

PATCHhttps://rest.carbon.ms/userToCompany

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

Response

{
  "userId": "xyz789",
  "companyId": "xyz789",
  "role": "string"
}

DELETE/userToCompany

Delete a user to company

Delete a user to company, matched on `userId`. Returns 204 No Content.

Query parameters

userIdstring

The `userId` of the user to company to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/userToCompany

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

204 No Content