Employees

The employees resource.

Basehttps://rest.carbon.ms/employees

GET/employees

List employeess

Retrieve a paginated list of employeess. 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/employees

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

Response

[
  {
    "id": "abc123def456",
    "name": "Example",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "avatarUrl": "string",
    "employeeTypeId": "xyz789",
    "companyId": "xyz789"
  }
]

GET/employees

Retrieve a employees

Fetch a single employees by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/employees

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

Response

{
  "id": "abc123def456",
  "name": "Example",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "avatarUrl": "string",
  "employeeTypeId": "xyz789",
  "companyId": "xyz789"
}