Lightspeed Commerce Staff API

Staff API. Authorisation Code grant type is required for this API with permission ROLE_CONFIG_USERS.

Documentation GitHub OpenAPI

Operations 17

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /staff/v1/businessLocations/{businessLocationId}/shift List staff shifts at a business location · Get Shifts #

Ask an LLM

“Which staff members clocked shifts at my restaurant last week?”

“Can I filter shift records to a single employee and a start and end time?”

Tell an agent

List shifts at business location {location} between {start} and {end}.

Show the shifts worked by staff member {staff} at location {location}.

GET /staff/v1/businessLocations/{businessLocationId}/userTypes/POS List POS users at a business location · Get All POS Users #

Ask an LLM

“Who has a login on the point-of-sale devices at this venue?”

“Can I see only active POS users, or those created within a date range?”

Tell an agent

List POS users at business location {location} with active status {active}.

Show POS users at location {location} added between {start} and {end}.

POST /staff/v1/businessLocations/{businessLocationId}/userTypes/POS Create a POS user · Create POS User #

Ask an LLM

“How do I add a new server or cashier who logs in on the POS terminal?”

“Can I give a new POS user a PIN code and assign them to a user group when creating them?”

Tell an agent

Create POS user {username} at location {location} with PIN {pin}.

Add a new POS user {username} named {first} {last} to business location {location}.

PUT /staff/v1/businessLocations/{businessLocationId}/userTypes/POS/{staffId} Update an existing POS user · Update POS User #

Ask an LLM

“Can I change the PIN code or roles of a POS user who already exists?”

“What fields must I resend when editing a POS user's profile?”

Tell an agent

Change the PIN of POS user {staff} at location {location} to {pin}.

Set POS user {staff} at business location {location} to active {active}.

GET /staff/v1/businessLocations/{businessLocationId}/userTypes/BACK_OFFICE List back office users at a location · Get All Back Office Users #

Ask an LLM

“Which managers have back office access to this restaurant's dashboard?”

“Can I look up a back office user by their email address?”

Tell an agent

List back office users at business location {location}.

Find the back office user with email {email} at location {location}.

GET /staff/v1/businessLocations/{businessLocationId}/staff/{staffId} Get one staff member's details · Get Single User #

Ask an LLM

“What details are stored for a specific employee at a business location?”

“Can I fetch a single staff profile by its staff ID?”

Tell an agent

Get the profile of staff member {staff} at location {location}.

Show me who staff ID {staff} is at business location {location}.

GET /staff/v1/businessLocations/{businessLocationId}/groups List POS user groups · Get All User Groups #

Ask an LLM

“What user groups exist for grouping POS staff at my venue?”

“Can I find user groups by name or by the roles they grant?”

Tell an agent

List all POS user groups at business location {location}.

Find the user group named {name} at location {location}.

GET /staff/v1/businessLocations/{businessLocationId}/groups/{groupId} Get a single POS user group · Get Single User Group #

Ask an LLM

“Which roles and settings does a particular user group carry?”

“Can I retrieve one user group by its group ID?”

Tell an agent

Show user group {group} at business location {location}.

Get the roles in POS user group {group} for location {location}.

POST /staff/v1/business/{businessId}/assignStaff/{staffId} Grant a staff member access to locations · Add Business Location Access #

Ask an LLM

“Can I give an employee access to additional restaurants within the same business?”

“How do I assign a staff member to several business locations at once?”

Tell an agent

Give staff member {staff} access to business locations {locations} in business {business}.

Assign staff {staff} to more locations under business {business}.

DELETE /staff/v1/businessLocations/{businessLocationId}/unAssignStaff/{staffId} Remove a staff member's location access · Remove Business Location Access #

Ask an LLM

“Can I take away an employee's access to one specific restaurant?”

“What happens when I unassign staff from a business location?”

Tell an agent destructive · confirm first

Remove staff member {staff} from business location {location}.

Revoke location {location} access for staff {staff}.

POST /staff/v1/businessLocations/{businessLocationId}/webhooks Register a staff webhook · Create Webhook #

Ask an LLM

“Can I get notified at my own URL when staff records change?”

“What notification types can a staff webhook subscribe to?”

Tell an agent

Create staff webhook {name} for location {location} sending {type} notifications to {url}.

Subscribe {url} to staff notifications of type {type} at location {location}, named {name}.

GET /staff/v1/businessLocations/{businessLocationId}/webhooks List staff webhooks for a location · Get Webhooks #

Ask an LLM

“Which staff-related webhooks are registered for this business location?”

“Can I see the notification URLs set up for staff events?”

Tell an agent

List the staff webhooks configured for location {location}.

Show every staff notification webhook at business location {location}.

PATCH /staff/v1/businessLocations/{businessLocationId}/webhooks/{webhookId} Update a staff webhook · Update Existing Webhook #

Ask an LLM

“Can I point an existing staff webhook at a new URL?”

“Is it possible to rename a staff webhook or change its notification type?”

Tell an agent

Change the URL of staff webhook {webhook} at location {location} to {url}.

Rename staff webhook {webhook} at location {location} to {name}.

DELETE /staff/v1/businessLocations/{businessLocationId}/webhooks/{webhookId} Delete a staff webhook · Delete Webhook #

Ask an LLM

“Can I stop a staff notification webhook from firing by removing it?”

“What is the way to delete a staff webhook I no longer need?”

Tell an agent destructive · confirm first

Delete staff webhook {webhook} at business location {location}.

Remove the staff notification webhook {webhook} from location {location}.

GET /staff/v1/businessLocations/{businessLocationId}/userTypes/POS/reportAccess List report access levels for POS users · Get Report Access Levels #

Ask an LLM

“What report access levels can I give a POS user?”

“Which reporting permissions are available for point-of-sale staff?”

Tell an agent

List the report access levels available to POS users at location {location}.

Show POS report access options for business location {location}.

GET /staff/v1/businessLocations/{businessLocationId}/userTypes/BACK_OFFICE/roles List back office user permissions · Get All Back Office User Permissions #

Ask an LLM

“What permissions can a back office user be granted?”

“Which roles exist for back office accounts at my location?”

Tell an agent

List all back office permissions at business location {location}.

Show the back office user roles available for location {location}.

GET /staff/v1/businessLocations/{businessLocationId}/userTypes/POS/roles List POS user permissions · Get All POS User Permissions #

Ask an LLM

“What roles can I assign to a POS user on the terminal?”

“Which point-of-sale permissions exist for cashiers and servers?”

Tell an agent

List all POS user permissions at business location {location}.

Show the roles I can give POS staff at location {location}.

Lightspeed Commerce Staff API

Operations 17

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification