How to start

Hello, we're trying to start using the API, but we're asked for many required fields but no explaining on how to get them:


Authorization Overview

Obtaining an access token using the OAuth2 authorization code grant flow consists of three steps:

1. Authorization Request
  • In a browser window, the end user is directed to the Lightspeed authorization URL (see Endpoints table)
  • The following query parameters must be passed in the URL:
  • response_type (required) - must be code for the authorization code grant
  • client_id (required) - the unique identifier of the OAuth client
  • scope (required) - the access scopes being requested, space delimited (URL encoded)
  • redirect_uri (required) - the URL that the user will be redirected to after authenticating and authorizing the integration
  • state (optional) - a unique string supplied by the external client that is persisted throughout the process to track the request

where do we get the client_id, and redirect_url fields from?



  • YorickYorick Moderator, Lightspeed Staff Posts: 112 moderator


    The client_id is emailed to you when creating your API client.

    You need to provide the redirect_uri when you ask for the API client creation, it's the URL used after the merchant authentication.

    Please be aware that the K-series API is currently closed to everyone except for partners. If you're not a partner and would like to request access, please contact your account manager.

    Thank you.

    API integration specialist
    Lightspeed HQ
  • ursinursin Member Posts: 2

    Thank you, I have been writing back and forth with support. Where can I create an API client? What kind of user or permissions do I need for that. So far I can login (Web-UI) but I have no possibility to actually create api credentials. And your support is not able to help me.

  • Ali_MasoumieAli_Masoumie Moderator, Lightspeed Staff Posts: 383 moderator

    Access to the Lightspeed Restaurant API is limited to Partners and pre-selected developers only. Please reach out to your Account Manager about this.

Sign In or Register to comment.