Lightspeed

Lightspeed Staff API

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

GitHub OpenAPI

Operations 19

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

Documentation

📖
Documentation
https://x-series-api.lightspeedhq.com/
📖
Documentation
https://developers.lightspeedhq.com/retail/introduction/introduction/
📖
Documentation
https://api-docs.lsk.lightspeed.app/
📖
Documentation
https://api-portal.lsk.lightspeed.app/

Specifications

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

Code Examples

💻
CodeExamples
https://www.postman.com/lightspeedhq/r-series-api/documentation/01jc01h/r-series-collection

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-pos-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-pos-staff-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Lightspeed Pos Staff API
  x-generated-from: documentation
  x-last-validated: '2026-06-02'
  x-refined-note:
  - x-logo differs across the merged source definitions and was not carried
  - x-source-url differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Staff across 2 of this provider''s published API definitions: lightspeed-pos-restaurant-k-series-openapi.yml, lightspeed-pos-retail-r-series-openapi.yml. Each path carries the servers of the definition it was published in.'
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
- url: https://api.lightspeedapp.com/API/V3
  description: Lightspeed Retail R-Series API host.
tags:


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