Carbon

Employee Type

The employee type resource.

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

List employee types

Retrieve a paginated list of employee types. 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/employeeType
curl --request GET \
  --url 'https://rest.carbon.ms/employeeType?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "name": "Example",
    "companyId": "xyz789",
    "protected": true,
    "createdAt": "2026-01-01T00:00:00Z",
    "updatedAt": "2026-01-01T00:00:00Z",
    "systemType": "string"
  }
]
GET/employeeType

Retrieve a employee type

Fetch a single employee type by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/employeeType
curl --request GET \
  --url 'https://rest.carbon.ms/employeeType?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "companyId": "xyz789",
  "protected": true,
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z",
  "systemType": "string"
}
POST/employeeType

Create a employee type

Create a new employee type.

Body parameters

namestringrequired
companyIdstringrequired

References company.id

protectedbooleanrequired
systemTypeemployeeTypeSystemType
POSThttps://rest.carbon.ms/employeeType
curl --request POST \
  --url https://rest.carbon.ms/employeeType \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","companyId":"xyz789","protected":true}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "companyId": "xyz789",
  "protected": true,
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z",
  "systemType": "string"
}
PATCH/employeeType

Update a employee type

Update an existing employee type, matched on `id`.

Body parameters

namestringrequired
companyIdstringrequired

References company.id

protectedbooleanrequired
systemTypeemployeeTypeSystemType
PATCHhttps://rest.carbon.ms/employeeType
curl --request PATCH \
  --url 'https://rest.carbon.ms/employeeType?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "companyId": "xyz789",
  "protected": true,
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z",
  "systemType": "string"
}
DELETE/employeeType

Delete a employee type

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

Query parameters

idstring

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

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