Skip to main content
POST
Employee login

POST /employee/login

Validate employee credentials and create a session token. Send Authorization: Bearer YOUR_API_KEY and X-Device-ID: YOUR_DEVICE_ID. See authentication. Use the returned token as X-Employee-Token on employee-protected requests. sessionExpiresAt gives the expiration time; sessions currently last 24 hours. Non-admin employees must be assigned to the API key’s location. An empty locationIds array grants no location access. isAdmin: true bypasses this location assignment check. accessHistory and deleteScanHistory describe history permissions. This endpoint has an additional limit of 20 requests per minute per IP.

Example request

Example response

Authorizations

Authorization
string
header
required

Location API key. Also requires X-Device-ID.

Headers

X-Device-ID
string
required

Stable device identifier. API key binds to this value on first use.

Body

application/json
username
string
required
password
string
required

Response

Success

employee
object
required
token
string
required
sessionExpiresAt
string<date-time>
required
message
string
required