List POS staff

Returns your active POS staff, 50 at a time by default. Page through them with the X-Next-Page header.

Required permission (any one of these):

GroupPermission
Stores & StaffList and view POS sales staff
Stores & StaffCreate, edit and terminate POS sales staff (includes view)
Query Params
integer
1 to 250
Defaults to 50

How many records to return per page. Defaults to 50, maximum 250.

string

Opaque paging cursor. Don't build this yourself: follow the path in the X-Next-Page or X-Prev-Page response header.

integer

Only return staff with an ID greater than this one.

string

Partial match on display_name.

string

Partial match on first_name.

string

Partial match on middle_name.

string

Partial match on last_name.

string

Greater than (not including) the hire_date.

string

Partial match on email.

string

Greater than (not including) the termination_date.

string

Comma-separated list matched against id.

string

Partial match on display_name; Partial match on first_name; Partial match on last_name; Partial match on pos_code; Partial match on email.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json