Work Center

The work center resource.

Base/workCenter

GET/workCenter

List work centers

Retrieve a paginated list of work centers. 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.

GET/workCenter

curl --request GET \
  --url '<your-host>/workCenter?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "name": "Example",
    "laborRate": 0,
    "defaultStandardFactor": "string",
    "active": true,
    "companyId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]

GET/workCenter

Retrieve a work center

Fetch a single work center by filtering on `id`.

Query parameters

idstring

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

GET/workCenter

curl --request GET \
  --url '<your-host>/workCenter?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "name": "Example",
  "laborRate": 0,
  "defaultStandardFactor": "string",
  "active": true,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

POST/workCenter

Create a work center

Create a new work center.

Body parameters

namestringrequired

descriptionstring

laborRatenumberrequired

defaultStandardFactorstringrequired

locationIdstring

References location.id

requiredAbilityIdstring

References ability.id

activebooleanrequired

companyIdstringrequired

References company.id

customFieldsobject

machineRatenumberrequired

overheadRatenumberrequired

tagsarray

departmentIdstring

References department.id

alwaysOnbooleanrequired

batchCapacitynumber

Advisory maximum pieces per batch run; NULL means no capacity model.

minimumBatchQuantitynumber

Advisory minimum pieces to justify a batch run; NULL means no minimum.

POST/workCenter

curl --request POST \
  --url <your-host>/workCenter \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","description":"string","laborRate":0,"defaultStandardFactor":"string","active":true,"companyId":"xyz789","machineRate":0,"overheadRate":0,"alwaysOn":true}'

Response

{
  "id": "abc123def456",
  "name": "Example",
  "laborRate": 0,
  "defaultStandardFactor": "string",
  "active": true,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

PATCH/workCenter

Update a work center

Update an existing work center, matched on `id`.

Body parameters

namestringrequired

descriptionstring

laborRatenumberrequired

defaultStandardFactorstringrequired

locationIdstring

References location.id

requiredAbilityIdstring

References ability.id

activebooleanrequired

companyIdstringrequired

References company.id

customFieldsobject

machineRatenumberrequired

overheadRatenumberrequired

tagsarray

departmentIdstring

References department.id

alwaysOnbooleanrequired

batchCapacitynumber

Advisory maximum pieces per batch run; NULL means no capacity model.

minimumBatchQuantitynumber

Advisory minimum pieces to justify a batch run; NULL means no minimum.

PATCH/workCenter

curl --request PATCH \
  --url '<your-host>/workCenter?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",
  "laborRate": 0,
  "defaultStandardFactor": "string",
  "active": true,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

DELETE/workCenter

Delete a work center

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

Query parameters

idstring

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

DELETE/workCenter

curl --request DELETE \
  --url '<your-host>/workCenter?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content