Skip to main content
GET
List employees

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

active
boolean

Whether the employee has not been deactivated.

ending_before
string

Return records that precede the record with this ID, in list order.

Pattern: ^[0-9]+$
include
enum<string>[]

Credentials to return on each employee. Neither is returned by default. Repeat the parameter to request both, for example ?include=pin&include=badge_barcode.

Requesting a credential without the employees:read_credentials permission is rejected rather than silently omitted.

  • pin — returns pin, the PIN the employee signs in with.
  • badge_barcode — returns badge_barcode, the badge the employee scans to sign in.
Available options:
badge_barcode,
pin
limit
integer
default:20

Maximum number of records to return.

Required range: 1 <= x <= 100
starting_after
string

Return records that follow the record with this ID, in list order.

Pattern: ^[0-9]+$
virtual
boolean

Whether the employee exists only to attribute orders and cannot sign in at a terminal. Omit to match both kinds.

Response

A page of employees.

data
object[]
required
has_more
boolean
required

Whether more records follow this page.