How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Lightspeed Commerce

Lightspeed Commerce Staff API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Lightspeed Commerce Staff API is one of 58 APIs that Lightspeed Commerce publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Staff. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and a changelog.

This API exposes 17 operations across 14 paths, and defines 41 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.trial.lsk.lightspeed.app, https://api.lsk.lightspeed.app.

17 operations 14 paths 41 schemas 2 DELETE10 GET1 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://{domain_prefix}.retail.lightspeed.app
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Lightspeed Commerce Staff API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 8 scopes.

  • OAuth2 — The Lightspeed Restaurant K-Series APIs support OAuth2 authentication using the [authorization code grant flow](https://www.oauth.com/oauth2-servers/server-sid…

Paths & Operations 17

Across 14 paths, the API surfaces 17 operations — 2 DELETE, 10 GET, 1 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Staff 17

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

GET
/staff/v1/businessLocations/{businessLocationId}/shift
Get Shifts
staff-apiGetShift 7 params → 200
GET
/staff/v1/businessLocations/{businessLocationId}/userTypes/POS
Get All POS Users
staff-apiGetPOSStaff 7 params → 200
POST
/staff/v1/businessLocations/{businessLocationId}/userTypes/POS
Create POS User
staff-apiCreatePOSStaff 1 param body → 201400401403500
PUT
/staff/v1/businessLocations/{businessLocationId}/userTypes/POS/{staffId}
Update POS User
staff-apiUpdatePOSStaff 2 params body → 201400401403500
GET
/staff/v1/businessLocations/{businessLocationId}/userTypes/BACK_OFFICE
Get All Back Office Users
staff-apiGetBackOfficeStaff 8 params → 200
GET
/staff/v1/businessLocations/{businessLocationId}/staff/{staffId}
Get Single User
staff-apiGetSingleStaff 2 params → 200
GET
/staff/v1/businessLocations/{businessLocationId}/groups
Get All User Groups
staff-apiGetPosUserGroups 6 params → 200
GET
/staff/v1/businessLocations/{businessLocationId}/groups/{groupId}
Get Single User Group
staff-apiGetPosUserGroupById 2 params → 200
POST
/staff/v1/business/{businessId}/assignStaff/{staffId}
Add Business Location Access
staff-apiAddStaffBusinessLocationAccess 2 params body → 200400401403500
DELETE
/staff/v1/businessLocations/{businessLocationId}/unAssignStaff/{staffId}
Remove Business Location Access
staff-apiDeleteStaffBusinessLocationAccess 2 params → 204400401403500
POST
/staff/v1/businessLocations/{businessLocationId}/webhooks
Create Webhook
staff-apiCreateWebhook 1 param body → 200
GET
/staff/v1/businessLocations/{businessLocationId}/webhooks
Get Webhooks
staff-apiGetWebhooks 1 param → 200
PATCH
/staff/v1/businessLocations/{businessLocationId}/webhooks/{webhookId}
Update Existing Webhook
staff-apiUpdateWebhook 2 params body → 200400404409
DELETE
/staff/v1/businessLocations/{businessLocationId}/webhooks/{webhookId}
Delete Webhook
staff-apiDeleteWebhook 2 params → 200
GET
/staff/v1/businessLocations/{businessLocationId}/userTypes/POS/reportAccess
Get Report Access Levels
staff-apiGetReportAccessLevels 1 param → 200
GET
/staff/v1/businessLocations/{businessLocationId}/userTypes/BACK_OFFICE/roles
Get All Back Office User Permissions
staff-apiGetBackOfficeUserPermissions 1 param → 200
GET
/staff/v1/businessLocations/{businessLocationId}/userTypes/POS/roles
Get All POS User Permissions
staff-apiGetPosUserPermissions 1 param → 200

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are staff-apiStaff (16 properties), staff-apiPOSStaff (15 properties), staff-apiBOStaff (13 properties), staff-apiUpdatePosStaffDto (9 properties). Each schema is shown below with its type and property counts.

staff-apiEmail
string
The email associated with the user. Only used for Back Office staff.
staff-apiStaffGroup
object
5 properties
staff-apiResponseSchema
object
3 properties
staff-apiFirstName
string
The first name of the user.
staff-apiUserPermission
object
2 properties
staff-apiVisible
boolean
Indicates if the user is visible.
staff-apiUserType
string
The user type.
staff-apiPinCodeSet
boolean
Indicates if the user has a PIN code set. Relevant for POS users only.
staff-apiPageInfo
object
4 properties
staff-apiUsername
string
The staff username. Only used for POS staff.
staff-apiPOSStaff
object
15 properties
staff-apiStaff
object
16 properties
staff-apiPinLength
integer
Length of the user's PIN code. Null when PIN is not set.
staff-apiCreateWebhookRequest
object
3 properties 3 required
staff-apiWebhookEventDto
object
2 properties
staff-apiShift
object
Shift details.
8 properties
staff-apiVisibleNoDefault
boolean
Indicates if the user is visible.
staff-apiStaffId
integer
The unique identifier for the user.
staff-apiCreatestaffRoleDto
string
List of roles assigned to the user. Normally, these are the default POS user roles. See [Get All POS User Permissions](https://api-docs.lsk.lightspeed.app/oper…
staff-apiEventType
string
The type of event.
staff-apiActive
boolean
Indicates if the user is active.
staff-apiBOStaff
object
13 properties
staff-apiBusinessLocationId
integer
The unique identifier for the business location.
staff-apiBusinessLocationIds
object
1 property
staff-apiStaffGroupIdDto
object
2 properties
staff-apiWebhookTopic
string
The type of webhook notification.
staff-apiEvent
object
Shift event such as clock in/out, please use the newest one when multiple events existing with same event type.
4 properties
staff-apiBusinessId
integer
The unique identifier for the business.
staff-apiReportAccess
string
User report permissions.
staff-apiUpdatePosStaffDto
object
9 properties 8 required
staff-apiModifiedOn
string
The timestamp of the last update to the user.
staff-apiCreatePosStaffDto
object
9 properties 1 required
staff-apiActiveNoDefault
boolean
Indicates if the user is active.
staff-apiCreatedOn
string
The timestamp of the creation of the user.
staff-apiReportAccessLevel
object
2 properties
staff-apiReportAccessNoDefault
string
User report permissions.
staff-apiLastNameNoDefault
string
The last name of the user.
staff-apiStaffRoleDto
object
2 properties
staff-apiLastName
string
The last name of the user.
staff-apiWebhookDto
object
7 properties
staff-apiFirstNameNoDefault
string
The first name of the user.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightspeed-staff-api-openapi.yml Raw ↑

Other APIs Lightspeed Commerce publishes across the network.

Lightspeed Retail R-Series API
AE Profile APIs.io
Lightspeed eCom API
AE Profile APIs.io
Lightspeed eCom E-Series (Ecwid) API
AE Profile APIs.io
Lightspeed Restaurant O-Series (Kounta) API
AE Profile APIs.io
Lightspeed Golf (Chronogolf) Partner API
AE Profile APIs.io
Lightspeed Commerce Audit API
AE Profile APIs.io
Lightspeed Commerce Brands API
AE Profile APIs.io
Lightspeed Commerce Channel Request Log API
AE Profile APIs.io
Lightspeed Commerce Consignment Products API
AE Profile APIs.io
Lightspeed Commerce Consignments API
AE Profile APIs.io
Lightspeed Commerce Customer Addresses API
AE Profile APIs.io
Lightspeed Commerce Customer Groups API
AE Profile APIs.io
#Staff
← Back to L APIs
API Details
ID
lightspeed:lightspeed-staff-api
Base URL
https://{domain_prefix}.retail.lightspeed.app
Docs
https://x-series-api.lightspeedhq.com/
Provider
Lightspeed Commerce
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=lightspeed-staff-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/lightspeed-staff-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Lightspeed Commerce Staff API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.