Flow Unified API
API ReferenceRestaurant

Employee · employee

Portable restaurant labor employee contract with stable identity and core staffing fields.

Entity type: employee · Methods: GET · POST

Portable restaurant labor employee contract with stable identity and core staffing fields.

Endpoints

GET  /unified/{accountId}/employee   # List normalized employee records
POST /unified/{accountId}/employee   # Create / push one employee

Schema

FieldTypeRequiredDescription
externalIdstringYesStable employee identifier. Used as the idempotency key on writes.
namestringYesDisplay name of the employee.
nicknamestringNickname or short display label.
emailstring · emailEmployee email when available.
rolestringRole such as ADMIN, MANAGER, EMPLOYEE, or a system-specific labor role.
employeeCodestringSystem-specific employee code / custom id.
activebooleanWhether the employee is active.
isOwnerbooleanWhether the employee is marked as owner.

Example object

{
  "externalId": "emp_2214",
  "name": "Marcus Turner",
  "nickname": "Marc",
  "email": "marcus@emberhospitality.com",
  "role": "MANAGER",
  "employeeCode": "EMP-2214",
  "active": true,
  "isOwner": false
}

The same shape is used as the POST request body and returned by GET reads — reads from every connected system are normalized to it.

Requests

read employee
curl "https://dev.flow.staging.linktoany.com/api/1.0/standalone-link-engine-service/unified/{accountId}/employee?mappingKey={readKey}&pageSize=50" \
  -H "authorization: Bearer <token>"
write employee
curl -X POST "https://dev.flow.staging.linktoany.com/api/1.0/standalone-link-engine-service/unified/{accountId}/employee?mappingKey={writeKey}" \
  -H "authorization: Bearer <token>" \
  -H "content-type: application/json" \
  -d '{"externalId":"emp_2214","name":"Marcus Turner","nickname":"Marc","email":"marcus@emberhospitality.com","role":"MANAGER","employeeCode":"EMP-2214","active":true,"isOwner":false}'

Supported systems

SystemReadWriteAuthRate limit
Clover (Asia Pacific)YesYesAPI token5 req / 6s
Clover (US)YesYesAPI token5 req / 6s
Lightspeed K-SeriesYesOAuth 2.0100 req / 60s
ToastYesAPI token5 req / s

On this page