Sign in a staff member

Exchanges a staff member's PIN for a staff token to send as X-Staff-Token on operations performed on their behalf.

From a terminal, send only the pin: PINs are unique per property, so the PIN identifies the person. Send staff_id too when the person is already known.

A wrong or unknown PIN returns 401. After repeated failures the device is locked out for a few minutes (429). Staff tokens expire after a fixed number of hours.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

PIN-based staff login payload.

staff_id is optional: the POS app signs in with the PIN alone (it has no
staff picker, and a device-token caller cannot read staff PINs anyway — see
include_pin in api/staff.py), so the PIN identifies the person. mfd-web
still sends staff_id and keeps the narrower lookup. PINs are unique per
property, so a PIN-only lookup resolves to at most one staff member.

string
required

ID of the staff member signing in. Omit to resolve identity from the PIN alone.

Headers
Responses

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