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 Users API

User operations

Documentation Provider Profile APIs.io OpenAPI GitHub

Lightspeed Commerce Users 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 User. 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 7 operations across 6 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version 2026-07.

Requests are made against a single base URL, https://{domain_prefix}.retail.lightspeed.app/api/2026-07.

7 operations 6 paths 9 schemas 2 DELETE4 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2026-07
Base URL
https://{domain_prefix}.retail.lightspeed.app
Authentication
HTTP Bearer
Contact
Lightspeed Developer Relations
License
Apache 2.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Lightspeed Commerce Users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer Token for API authentication.

Paths & Operations 7

Across 6 paths, the API surfaces 7 operations — 2 DELETE, 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Users 7

User operations

GET
/user
Get current user
GetUser → 200
GET
/users
List users
ListUsers 3 params → 200
POST
/users/bulk
Get multiple users by id
GetUsersById body → 200
DELETE
/users/{user_id}
Delete a single user
DeleteUserByID 1 param → 200403404
GET
/users/{user_id}
Get a single user
GetUserByID 1 param → 200
GET
/users/{user_id}/sale_totals
Get the sales totals for a single user
GetSalesTotalsForUserByID 1 param → 200
DELETE
/users/{user_id}/sessions
Delete user sessions
DeleteSessionsByUserID 1 param → 200401403404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are User (27 properties), UserSaleTotalCollection (10 properties), UserImages (7 properties), Role (3 properties). Each schema is shown below with its type and property counts.

UserCollection
object
2 properties 2 required
Version
object
An object containing the highest and lowest version numbers for all items of the returned collection.
2 properties 2 required
UserResponse
object
A response for a single user GET request.
1 property
UserSaleTotalResponse
object
1 property
Role
object
3 properties
UserSaleTotalCollection
object
10 properties
GetUsersByIdsRequest
array
An array of user IDs to retrieve.
User
object
27 properties 7 required
UserImages
objectnull
On object containing URLs for different sizes of the user’s avatar.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

lightspeed-users-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
#User
← Back to L APIs
API Details
ID
lightspeed:lightspeed-users-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-users-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/lightspeed-users-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 Users 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.