Lightspeed · OAuth Scopes

Lightspeed OAuth Scopes

OAuth 2.0 derived

Lightspeed publishes 24 OAuth 2.0 scopes via the authorizationCode flow. Scopes are the fine-grained permissions an application requests at authorization time to act against the Lightspeed API on a user’s behalf.

Tokens are issued from /oauth/token.

This index is generated from the provider’s OpenAPI security definitions (and, where available, its documented scope reference) and refreshes on every APIs.io network build. Browse every provider’s scopes at scopes.apis.io.

POSRetailRestaurantEcommerce
Scopes: 24 Flows: authorizationCode Method: derived

OAuth endpoints

Authorization URL
/oauth/authorize https://cloud.lightspeedapp.com/oauth/authorize.php https://secure.retail.lightspeed.app/connect
Token URL
/oauth/token https://cloud.lightspeedapp.com/oauth/access_token.php https://{domainPrefix}.retail.lightspeed.app/api/1.0/token
Flows
authorizationCode

Scopes (24)

ScopeDescriptionFlows
customers.read Read customers. authorizationCode
customers.write Create or modify customers. authorizationCode
employee:admin Manage employees and shops. authorizationCode
employee:all Full access to all account resources. authorizationCode
employee:customers Create and modify customers. authorizationCode
employee:customers_read Read customers. authorizationCode
employee:inventory Create and modify inventory items. authorizationCode
employee:inventory_read Read inventory items and catalog. authorizationCode
employee:register Create sales at the register. authorizationCode
employee:reports Read sales and reporting data. authorizationCode
financial-api Read financial data authorizationCode
id-cards Create and manage ID card batches and cards. authorizationCode
items Read and write items authorizationCode
orders-api Read business information, floors, menus, discounts, and production instructions. Read and write orders and payments. Read [Rich Item](https://api-docs.lsk.lightspeed.app/prod/group/endpoint-rich-item) data. authorizationCode
products.read Read products, brands, and inventory. authorizationCode
products.write Create or modify products, brands, and inventory. authorizationCode
propertymanagement Read and write Property Management System configurations. authorizationCode
reservation-*** Platform reservations scope. The `***` will be replaced by the [platform-code](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-servicesetbyplatformcode#operation-reservation-servicesetbyplatformcode-platform-code) of the reservation platform. authorizationCode
reservation-platform-code
reservations-api Configure *legacy* reservation integrations. **Note:** This API will eventually be deprecated in favour of the new [Reservations for Platforms](https://api-docs.lsk.lightspeed.app/group/endpoint-reservations-for-platforms) API. More information on the new reservations workflows can be found in the [Integration Guide](https://api-portal.lsk.lightspeed.app/category/reservations). authorizationCode
sales.read Read sales transactions. authorizationCode
sales.write Create or modify sales. authorizationCode
staff-api Read shift information, read and write user information. authorizationCode
user-token-by-authorization-code

📄 Provider scope reference:

Source

OAuth Scopes

lightspeed-pos-scopes.yml Raw ↑ 
generated: '2026-07-11'
method: derived
source: openapi/lightspeed-pos-restaurant-k-series-openapi.yml, openapi/lightspeed-pos-retail-r-series-openapi.yml,
  openapi/lightspeed-pos-retail-x-series-openapi.yml
schemes:
- name: OAuth2
  source: openapi/lightspeed-pos-restaurant-k-series-openapi.yml
  flows:
  - flow: authorizationCode
    authorizationUrl: /oauth/authorize
    tokenUrl: /oauth/token
  description: |-
    The Lightspeed Restaurant K-Series APIs support OAuth2 authentication using the [authorization code grant flow](https://www.oauth.com/oauth2-servers/server-side-apps/authorization-code/).
    See our [Authorization Quick Start Guide](https://api-portal.lsk.lightspeed.app/quick-start/authentication/authorization-overview) for more details on how to authenticate.
- name: OAuth2
  source: openapi/lightspeed-pos-retail-r-series-openapi.yml
  flows:
  - flow: authorizationCode
    authorizationUrl: https://cloud.lightspeedapp.com/oauth/authorize.php
    tokenUrl: https://cloud.lightspeedapp.com/oauth/access_token.php
  description: OAuth 2.0 authorization-code flow with scope-based access control.
- name: OAuth2
  source: openapi/lightspeed-pos-retail-x-series-openapi.yml
  flows:
  - flow: authorizationCode
    authorizationUrl: https://secure.retail.lightspeed.app/connect
    tokenUrl: https://{domainPrefix}.retail.lightspeed.app/api/1.0/token
  description: OAuth 2.0 authorization-code flow with scope-based access.
scopes:
- scope: customers.read
  description: Read customers.
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-pos-retail-x-series-openapi.yml
- scope: customers.write
  description: Create or modify customers.
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-pos-retail-x-series-openapi.yml
- scope: employee:admin
  description: Manage employees and shops.
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-pos-retail-r-series-openapi.yml
- scope: employee:all
  description: Full access to all account resources.
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-pos-retail-r-series-openapi.yml
- scope: employee:customers
  description: Create and modify customers.
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-pos-retail-r-series-openapi.yml
- scope: employee:customers_read
  description: Read customers.
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-pos-retail-r-series-openapi.yml
- scope: employee:inventory
  description: Create and modify inventory items.
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-pos-retail-r-series-openapi.yml
- scope: employee:inventory_read
  description: Read inventory items and catalog.
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-pos-retail-r-series-openapi.yml
- scope: employee:register
  description: Create sales at the register.
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-pos-retail-r-series-openapi.yml
- scope: employee:reports
  description: Read sales and reporting data.
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-pos-retail-r-series-openapi.yml
- scope: financial-api
  description: Read financial data
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-pos-restaurant-k-series-openapi.yml
- scope: id-cards
  description: Create and manage ID card batches and cards.
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-pos-restaurant-k-series-openapi.yml
- scope: items
  description: Read and write items
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-pos-restaurant-k-series-openapi.yml
- scope: orders-api
  description: |-
    Read business information, floors, menus, discounts, and production instructions.
    Read and write orders and payments. Read [Rich Item](https://api-docs.lsk.lightspeed.app/prod/group/endpoint-rich-item) data.
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-pos-restaurant-k-series-openapi.yml
- scope: products.read
  description: Read products, brands, and inventory.
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-pos-retail-x-series-openapi.yml
- scope: products.write
  description: Create or modify products, brands, and inventory.
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-pos-retail-x-series-openapi.yml
- scope: propertymanagement
  description: Read and write Property Management System configurations.
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-pos-restaurant-k-series-openapi.yml
- scope: reservation-***
  description: Platform reservations scope. The `***` will be replaced by the [platform-code](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-servicesetbyplatformcode#operation-reservation-servicesetbyplatformcode-platform-code)
    of the reservation platform.
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-pos-restaurant-k-series-openapi.yml
- scope: reservation-platform-code
  sources:
  - openapi/lightspeed-pos-restaurant-k-series-openapi.yml
- scope: reservations-api
  description: |-
    Configure *legacy* reservation integrations.
    **Note:** This API will eventually be deprecated in favour of the new [Reservations for Platforms](https://api-docs.lsk.lightspeed.app/group/endpoint-reservations-for-platforms) API.
    More information on the new reservations workflows can be found in the [Integration Guide](https://api-portal.lsk.lightspeed.app/category/reservations).
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-pos-restaurant-k-series-openapi.yml
- scope: sales.read
  description: Read sales transactions.
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-pos-retail-x-series-openapi.yml
- scope: sales.write
  description: Create or modify sales.
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-pos-retail-x-series-openapi.yml
- scope: staff-api
  description: Read shift information, read and write user information.
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-pos-restaurant-k-series-openapi.yml
- scope: user-token-by-authorization-code
  sources:
  - openapi/lightspeed-pos-restaurant-k-series-openapi.yml