Skip to main content
GET
Retrieve an employee

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required
Pattern: ^[0-9]+$

Query Parameters

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

Response

A staff member at a store, to whom point-of-sale activity can be attributed.

id
string
required

Unique identifier for the record.

authentication_rule
object | null
required

Effective rule that determines how the employee authenticates at the POS.

created_at
string<date-time>
required

When the record was created.

deactivated_at
string<date-time> | null
required

When the employee was deactivated, or null when the employee is active.

editable
boolean
required

Whether the employee can be changed. Employees Vori creates and manages are not editable.

email_address
string<email> | null
required

Employee's email address, or null when none is configured.

Maximum string length: 254
first_name
string
required

Employee's first name.

last_name
string
required

Employee's last name.

roles
object[]
required

Roles assigned to the employee.

updated_at
string<date-time>
required

When the record was last changed.

virtual
boolean
required

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

badge_barcode
string | null

Barcode on the badge the employee scans to sign in at the point of sale, or null when none is configured. Returned only when requested with include=badge_barcode by a caller holding the employees:read_credentials permission, and absent from the response otherwise.

pin
string | null

Numeric PIN used by the employee for POS authentication, or null when none is configured. Returned only when requested with include=pin by a caller holding the employees:read_credentials permission, and absent from the response otherwise.

Required string length: 6
Pattern: ^[0-9]+$