Lightspeed Retail POS (X-Series) API Authentication

How to authenticate Lightspeed Retail POS (X-Series) API requests: one Bearer API key plus a connectionId. MindCloud runs the OAuth flow and refreshes…

Every Lightspeed Retail POS (X-Series) API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Lightspeed Retail POS (X-Series) account. This page covers both, plus exactly how to send them, so you do not need to visit any other page to get authenticated.

Steps to authenticate

Create a MindCloud account at app.mindcloud.co if you do not already have one.
Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
Create a Lightspeed Retail POS (X-Series) connection in Connections. Lightspeed Retail POS (X-Series) uses OAuth. When you create the connection, you are redirected to sign in to Lightspeed Retail POS (X-Series) and approve access — MindCloud stores the resulting tokens and refreshes them automatically, so your integration never has to.
Copy the connection’s connectionId — you will send it on every request alongside your MindCloud API Key.

How requests are authenticated

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Lightspeed Retail POS (X-Series) account that should run the action. MindCloud stores and refreshes the Lightspeed Retail POS (X-Series) credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions.

For example, calling Get Retailer with an Lightspeed Retail POS (X-Series) connection looks like this:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/lightspeedRetailPOSXSeries/actions/get-retailer/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

The Authorization: Bearer <your MindCloud API Key> header authenticates you to MindCloud; the connectionId tells MindCloud which Lightspeed Retail POS (X-Series) account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Connect Lightspeed Retail POS (X-Series)

You'll need a Lightspeed Retail (X-Series) developer application with the exact redirect URI shown below.

Create or open your Lightspeed developer application
Create an application in the Lightspeed Retail (X-Series) developer portal and copy the client ID and client secret. Unapproved applications can still be used for private and test connections.
Add the MindCloud redirect URI
Set the redirect URI exactly to https://api.mindcloud.co/v1/oauth/lightspeedRetailPOSXSeries/callback.
Start the connection in MindCloud and approve the requested scopes
When MindCloud opens the Lightspeed consent screen, sign in as a retailer admin and approve the requested scopes for the store.

Keep your key safe

Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs. Anyone with the key can call the Universal API as your MindCloud account, across every connection you have created.