Lightspeed Commerce

Lightspeed Commerce Staff API

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

GitHub OpenAPI

Operations 17

GET /staff/v1/businessLocations/{businessLocationId}/shift Get Shifts #
GET /staff/v1/businessLocations/{businessLocationId}/userTypes/POS Get All POS Users #
POST /staff/v1/businessLocations/{businessLocationId}/userTypes/POS Create POS User #
PUT /staff/v1/businessLocations/{businessLocationId}/userTypes/POS/{staffId} Update POS User #
GET /staff/v1/businessLocations/{businessLocationId}/userTypes/BACK_OFFICE Get All Back Office Users #
GET /staff/v1/businessLocations/{businessLocationId}/staff/{staffId} Get Single User #
GET /staff/v1/businessLocations/{businessLocationId}/groups Get All User Groups #
GET /staff/v1/businessLocations/{businessLocationId}/groups/{groupId} Get Single User Group #
POST /staff/v1/business/{businessId}/assignStaff/{staffId} Add Business Location Access #
DELETE /staff/v1/businessLocations/{businessLocationId}/unAssignStaff/{staffId} Remove Business Location Access #
POST /staff/v1/businessLocations/{businessLocationId}/webhooks Create Webhook #
GET /staff/v1/businessLocations/{businessLocationId}/webhooks Get Webhooks #
PATCH /staff/v1/businessLocations/{businessLocationId}/webhooks/{webhookId} Update Existing Webhook #
DELETE /staff/v1/businessLocations/{businessLocationId}/webhooks/{webhookId} Delete Webhook #
GET /staff/v1/businessLocations/{businessLocationId}/userTypes/POS/reportAccess Get Report Access Levels #
GET /staff/v1/businessLocations/{businessLocationId}/userTypes/BACK_OFFICE/roles Get All Back Office User Permissions #
GET /staff/v1/businessLocations/{businessLocationId}/userTypes/POS/roles Get All POS User Permissions #

Documentation

📖
Documentation
https://x-series-api.lightspeedhq.com/docs/introduction
📖
APIReference
https://x-series-api.lightspeedhq.com/reference
📖
GettingStarted
https://x-series-api.lightspeedhq.com/docs/quick_start
📖
Documentation
https://api-portal.lsk.lightspeed.app/
📖
APIReference
https://api-docs.lsk.lightspeed.app/
📖
GettingStarted
https://api-portal.lsk.lightspeed.app/quick-start/intro

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lightspeed/refs/heads/main/openapi/lightspeed-staff-api-openapi.yml

Other Resources

🔗
ChangeLog
https://x-series-api.lightspeedhq.com/changelog
🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/lightspeed/refs/heads/main/llms/lightspeed-llms.txt
🔗
SignUp
https://developers.retail.lightspeed.app/register
🔗
ChangeLog
https://api-docs.lsk.lightspeed.app/changes

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/lightspeed-staff-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lightspeed-staff-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.0.0
  title: Lightspeed Restaurant K Series Staff API
  description: '**Lightspeed Restaurant** offers a **REST API** in order to communicate with the data in the system. These APIs are built using the RESTful standards and adhere to the basic verb interactions as defined by the REST standard.

    Detailed developer guides can be found in the Lightspeed Restaurant API Portal.

    These services are in continuous development and subject to change. Please find our versioning policy here.'
  x-logo:
    altText: Lightspeed Commerce
    url: static/lightspeed@2x.png
servers:
- url: https://api.trial.lsk.lightspeed.app
  description: Demo URL
  x-bump-branch-name: demo
- url: https://api.lsk.lightspeed.app
  description: Production URL
  x-bump-branch-name: prod
tags:


# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lightspeed/refs/heads/main/openapi/lightspeed-staff-api-openapi.yml