Lightspeed

Lightspeed Customers API

The Customers API from Lightspeed — 2 operation(s) for customers.

Documentation GitHub OpenAPI

Operations 3

GET /customers Lightspeed List Customers #

POST /customers Lightspeed Create a Customer #

GET /customers/{id} Lightspeed Get a Customer by ID #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/lightspeed-pos-customers-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Lightspeed Retail X-Series Customers API
  description: 'Partial OpenAPI 3.1 representation of the Lightspeed Retail X-Series

    (formerly Vend) REST API. The X-Series API is documented at

    https://x-series-api.lightspeedhq.com/ and uses OAuth 2.0 with scope-based

    access control. The base URL is per-tenant under the

    https://x-series-api.lightspeedhq.com domain. Authentication uses Bearer

    access tokens issued via the OAuth 2.0 authorization-code flow.

    '
  version: 2.0.0
  contact:
    name: Lightspeed Commerce
    url: https://x-series-api.lightspeedhq.com/
servers:
- url: https://{domainPrefix}.retail.lightspeed.app/api/2.0
  description: Per-retailer X-Series API host.
  variables:
    domainPrefix:
      default: example
      description: Retailer subdomain prefix.
security:
- OAuth2: []
tags:
- name: Customers
paths:
  /customers:
    get:
      summary: Lightspeed List Customers
      operationId: listCustomers
      security:
      - OAuth2:
        - customers.read
      responses:
        '200':
          description: A page of customers.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Customers
    post:
      summary: Lightspeed Create a Customer
      operationId: createCustomer
      security:
      - OAuth2:
        - customers.write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Customer'
            examples:
              CreateCustomerRequestExample:
                summary: Default createCustomer request
                x-microcks-default: true
                value:
                  id: 3f2504e0-4f89-41d3-9a0c-0305e82c3301
                  first_name: Sample first_name
                  last_name: Sample last_name
                  email: guest@example.com
                  phone: example
                  customer_code: example
      responses:
        '201':
          description: Customer created.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Customers
  /customers/{id}:
    get:
      summary: Lightspeed Get a Customer by ID
      operationId: getCustomer
      security:
      - OAuth2:
        - customers.read
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: The customer.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Customer'
              examples:
                GetCustomer200Example:
                  summary: Default getCustomer 200 response
                  x-microcks-default: true
                  value:
                    id: 3f2504e0-4f89-41d3-9a0c-0305e82c3301
                    first_name: Sample first_name
                    last_name: Sample last_name
                    email: guest@example.com
                    phone: example
                    customer_code: example
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Customers
components:
  schemas:
    Customer:
      type: object
      properties:
        id:
          type: string
          format: uuid
        first_name:
          type: string
        last_name:
          type: string
        email:
          type: string
          format: email
        phone:
          type: string
        customer_code:
          type: string
  securitySchemes:
    OAuth2:
      type: oauth2
      description: OAuth 2.0 authorization-code flow with scope-based access.
      flows:
        authorizationCode:
          authorizationUrl: https://secure.retail.lightspeed.app/connect
          tokenUrl: https://{domainPrefix}.retail.lightspeed.app/api/1.0/token
          scopes:
            products.read: Read products, brands, and inventory.
            products.write: Create or modify products, brands, and inventory.
            sales.read: Read sales transactions.
            sales.write: Create or modify sales.
            customers.read: Read customers.
            customers.write: Create or modify customers.