Get PMS providers

GET /pms/v1/providers
O auth2

Returns a list of PMS providers that have been configured for the business location. Only PMS providers created by the authenticated OAuth client will be returned.

Query parameters

Responses

  • 200 application/json

    Result

    Hide response attributes Show response attributes object
    • id integer(int64)

      The unique identifier for the provider.

    • name string

      The name of the PMS provider.

    • apiKey string

      The API key for the PMS provider.

    • businessLocationId integer(int64)

      The unique identifier for the business location.

    • endpoint string

      The endpoint of the PMS provider. This is where Lightspeed will send PMS requests.

    • features array[string]

      The optional features that the PMS provider supports. See the Integration Guide for more details.

      Values are SEARCH_BY_NAME, MIRRORING, PARTIAL_PAYMENTS, MULTI_PAYMENTS, SERVICE_CHARGE, or ENRICHED_PAYLOAD.
GET /pms/v1/providers 
curl \
 --request GET 'https://api.lsk.lightspeed.app/pms/v1/providers' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
[
  {
    "id": 3012455645,
    "name": "string",
    "apiKey": "fake-secret",
    "businessLocationId": 45454565682155,
    "endpoint": "http://integration.com/pms/endpoint",
    "features": [
      "MIRRORING"
    ]
  }
]