Employee

The employee resource.

Basehttps://rest.carbon.ms/employee

GET/employee

List employees

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

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

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "employeeTypeId": "xyz789",
    "active": true,
    "pin": "string"
  }
]

GET/employee

Retrieve a employee

Fetch a single employee by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/employee

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "employeeTypeId": "xyz789",
  "active": true,
  "pin": "string"
}

POST/employee

Create a employee

Create a new employee.

Body parameters

employeeTypeIdstringrequired

References employeeType.id

activebooleanrequired

pinstring

POSThttps://rest.carbon.ms/employee

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "employeeTypeId": "xyz789",
  "active": true,
  "pin": "string"
}

PATCH/employee

Update a employee

Update an existing employee, matched on `id`.

Body parameters

employeeTypeIdstringrequired

References employeeType.id

activebooleanrequired

pinstring

PATCHhttps://rest.carbon.ms/employee

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "employeeTypeId": "xyz789",
  "active": true,
  "pin": "string"
}

DELETE/employee

Delete a employee

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/employee

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

204 No Content