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

Lightspeed 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 Staff API is one of 27 APIs that Lightspeed 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, and code examples.

This API exposes 19 operations across 16 paths, and defines 41 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

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

19 operations 16 paths 41 schemas 2 DELETE12 GET1 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://x-series-api.lightspeedhq.com/api/2.0
Authentication
OAuth 2.0
Contact
Lightspeed Commerce
Resource Areas
1

Authentication & Security 1

Lightspeed 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 19

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

Staff 19

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

GET
/staff/v1/businessLocations/{businessLocationId}/shift
Lightspeed Get Shifts
staff-apiGetShift 7 params → 200
GET
/staff/v1/businessLocations/{businessLocationId}/userTypes/POS
Lightspeed Get All POS Users
staff-apiGetPOSStaff 7 params → 200
POST
/staff/v1/businessLocations/{businessLocationId}/userTypes/POS
Lightspeed Create POS User
staff-apiCreatePOSStaff 1 param body → 201400401403500
PUT
/staff/v1/businessLocations/{businessLocationId}/userTypes/POS/{staffId}
Lightspeed Update POS User
staff-apiUpdatePOSStaff 2 params body → 201400401403500
GET
/staff/v1/businessLocations/{businessLocationId}/userTypes/BACK_OFFICE
Lightspeed Get All Back Office Users
staff-apiGetBackOfficeStaff 8 params → 200
GET
/staff/v1/businessLocations/{businessLocationId}/staff/{staffId}
Lightspeed Get Single User
staff-apiGetSingleStaff 2 params → 200
GET
/staff/v1/businessLocations/{businessLocationId}/groups
Lightspeed Get All User Groups
staff-apiGetPosUserGroups 6 params → 200
GET
/staff/v1/businessLocations/{businessLocationId}/groups/{groupId}
Lightspeed Get Single User Group
staff-apiGetPosUserGroupById 2 params → 200
POST
/staff/v1/business/{businessId}/assignStaff/{staffId}
Lightspeed Add Business Location Access
staff-apiAddStaffBusinessLocationAccess 2 params body → 200400401403500
DELETE
/staff/v1/businessLocations/{businessLocationId}/unAssignStaff/{staffId}
Lightspeed Remove Business Location Access
staff-apiDeleteStaffBusinessLocationAccess 2 params → 204400401403500
POST
/staff/v1/businessLocations/{businessLocationId}/webhooks
Lightspeed Create Webhook
staff-apiCreateWebhook 1 param body → 200
GET
/staff/v1/businessLocations/{businessLocationId}/webhooks
Lightspeed Get Webhooks
staff-apiGetWebhooks 1 param → 200
PATCH
/staff/v1/businessLocations/{businessLocationId}/webhooks/{webhookId}
Lightspeed Update Existing Webhook
staff-apiUpdateWebhook 2 params body → 200400404409
DELETE
/staff/v1/businessLocations/{businessLocationId}/webhooks/{webhookId}
Lightspeed Delete Webhook
staff-apiDeleteWebhook 2 params → 200
GET
/staff/v1/businessLocations/{businessLocationId}/userTypes/POS/reportAccess
Lightspeed Get Report Access Levels
staff-apiGetReportAccessLevels 1 param → 200
GET
/staff/v1/businessLocations/{businessLocationId}/userTypes/BACK_OFFICE/roles
Lightspeed Get All Back Office User Permissions
staff-apiGetBackOfficeUserPermissions 1 param → 200
GET
/staff/v1/businessLocations/{businessLocationId}/userTypes/POS/roles
Lightspeed Get All POS User Permissions
staff-apiGetPosUserPermissions 1 param → 200
GET
/Account/{accountID}/Employee.json
Lightspeed List Employees
getEmployees 1 param → 200
GET
/Account/{accountID}/Shop.json
Lightspeed List Shops
getShops 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 (15 properties), staff-apiPOSStaff (14 properties), staff-apiBOStaff (13 properties), staff-apiCreatePosStaffDto (9 properties). Each schema is shown below with its type and property counts.

staff-apiFirstName
string
The first name of the user.
staff-apiStaffGroup
object
4 properties
staff-apiStaffId
integer
The unique identifier for the user.
staff-apiBusinessLocationId
integer
The unique identifier for the business location.
staff-apiBOStaff
object
13 properties
staff-apiActiveNoDefault
boolean
Indicates if the user is active.
staff-apiStaffRoleDto
object
2 properties
staff-apiBusinessId
integer
The unique identifier for the business.
staff-apiPinCodeSet
boolean
Indicates if the user has a PIN code set. Relevant for POS users only.
staff-apiStaffGroupIdDto
object
2 properties
staff-apiReportAccess
string
User report permissions.
staff-apiUpdatePosStaffDto
object
9 properties 8 required
staff-apiStaff
object
15 properties
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-apiCreateWebhookRequest
object
3 properties 3 required
staff-apiReportAccessNoDefault
string
User report permissions.
staff-apiPageInfo
object
4 properties
staff-apiVisible
boolean
Indicates if the user is visible.
staff-apiFirstNameNoDefault
string
The first name of the user.
Shop
object
A store location.
4 properties
staff-apiShift
object
Shift details.
8 properties
staff-apiEmail
string
The email associated with the user. Only used for Back Office staff.
staff-apiCreatePosStaffDto
object
9 properties 1 required
staff-apiWebhookTopic
string
The type of webhook notification.
staff-apiEventType
string
The type of event.
staff-apiLastName
string
The last name of the user.
staff-apiModifiedOn
string
The timestamp of the last update to the user.
staff-apiUserType
string
The user type.
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-apiVisibleNoDefault
boolean
Indicates if the user is visible.
staff-apiBusinessLocationIds
object
1 property
Employee
object
An employee of the retail account.
5 properties
staff-apiUsername
string
The staff username. Only used for POS staff.
staff-apiLastNameNoDefault
string
The last name of the user.
staff-apiCreatedOn
string
The timestamp of the creation of the user.
staff-apiUserPermission
object
2 properties
staff-apiResponseSchema
object
3 properties
staff-apiPOSStaff
object
14 properties
staff-apiActive
boolean
Indicates if the user is active.
staff-apiWebhookDto
object
7 properties
staff-apiReportAccessLevel
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightspeed-pos-staff-api-openapi.yml Raw ↑

Other APIs Lightspeed publishes across the network.

Lightspeed eCom C-Series API
AE Profile APIs.io
Lightspeed eCom E-Series API (Ecwid)
AE Profile APIs.io
Lightspeed Restaurant L-Series API
AE Profile APIs.io
Lightspeed Restaurant O-Series API (Kounta)
AE Profile APIs.io
Lightspeed Restaurant G-Series API (Gastrofix)
AE Profile APIs.io
Lightspeed ChronoGolf Partner API
AE Profile APIs.io
Lightspeed Account API
AE Profile APIs.io
Lightspeed Brands API
AE Profile APIs.io
Lightspeed Catalog API
AE Profile APIs.io
Lightspeed Customer API
AE Profile APIs.io
Lightspeed Customers API
AE Profile APIs.io
Lightspeed Financial API
AE Profile APIs.io
#Staff
← Back to L APIs
API Details
ID
lightspeed-pos:lightspeed-pos-staff-api
Base URL
https://x-series-api.lightspeedhq.com/api/2.0
Docs
https://x-series-api.lightspeedhq.com/
Provider
Lightspeed
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-pos-staff-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/lightspeed-pos-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 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.