Employees

get

http://{{apiurl}}/api/v1/labor/employees

Employees

The Employees endpoint returns a list of all active employees associated with the authenticated license or venue.

Each record represents a single employee profile, including their unique identifier, display name, and basic identifying information.

Endpoint

GET /v1/labor/employees

Description

Retrieves a paginated list of employees.

This endpoint is commonly used to map checks, timecards, or sales data to the corresponding employees in your system.

Request Parameters

Parameter	Type	Required	Default	Description
`limit`	integer	No	20	Maximum number of employee records to return per page.
`cursor`	string	No	—	Cursor token returned by a previous response, used to fetch the next page of results.

💡 Pagination:

The Employees API uses a limit and cursor mechanism for pagination. If limit is not specified, a default of 20 is used.

Response

Field	Type	Description
`records`	array	Array of employee objects.
`length`	integer	Number of records returned in this response.
`status`	string	API request status (e.g., `"SUCCESS"`).
`count`	integer	Total number of records matching the query (may equal `length` if single page).
`duration`	number	Time taken (in seconds) for the API to process the request.
`serverRequestTimestamp`	string (ISO 8601)	Timestamp when the server received the request.
`serverResponseTimestamp`	string (ISO 8601)	Timestamp when the server completed the response.
`serverClientDrift`	number	Time difference (in seconds) between client and server clocks.

Employee Object

Field	Type	Description
`id`	string	Unique identifier for the employee.
`updatedAt`	string (ISO 8601)	Timestamp when the employee record was last updated.
`name`	string	Display name for the employee, typically formatted as `"First L."`.
`firstName`	string	Employee’s first name.
`lastName`	string	Employee’s last name.

Example Response

{
  "records": [
    {
      "id": "10a46292-0553-4f49-9bbd-d613f3d06943",
      "updatedAt": "2025-10-30T05:17:48.323Z",
      "name": "Jonathan A.",
      "firstName": "Jonathan",
      "lastName": "Archer"
    },
    {
      "id": "18c36685-56c8-4f88-992e-b619c3b8a751",
      "updatedAt": "2025-10-30T05:17:48.354Z",
      "name": "Abbey B.",
      "firstName": "Abbey",
      "lastName": "Blake"
    }
    // ... more employee records ...
  ],
  "length": 17,
  "status": "SUCCESS",
  "count": 17,
  "duration": 0.627,
  "serverRequestTimestamp": "2025-11-02T16:55:51.920Z",
  "serverResponseTimestamp": "2025-11-02T16:55:52.547Z",
  "serverClientDrift": 0
}

Notes

The name field is formatted for display convenience and may not always follow a strict pattern if set manually in the POS.
Only employees that exist and are active in the NX system for the given license are included.
The API is read-only — updates to employee records must be performed via the NX POS system or management interface.