LIlightspeed
PMS

Get PMS providers

Changed on

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.

get/pms/v1/providers

Request

  • Base URL
    https://api.trial.lsk.lightspeed.app
  • URL
    https://api.trial.lsk.lightspeed.app/pms/v1/providers
  • Auth
    OAuth 2
    Authorization code: https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/auth
    Token URL: https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/token scopes: propertymanagement

Query parameters

businessLocationIdinteger

The unique identifier for the business location.

Example:45454565682155

Response

Result

idinteger

The unique identifier for the provider.

namestring

The name of the PMS provider.

apiKeystring

The API key for the PMS provider.

businessLocationIdinteger

The unique identifier for the business location.

endpointstring

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

featuresPmsApiProviderFeature[]

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

Example response

[
  {
    "id": 3012455645,
    "apiKey": "fake-secret",
    "businessLocationId": 45454565682155,
    "endpoint": "http://integration.com/pms/endpoint",
    "features": [
      "MIRRORING"
    ]
  }
]

Changes

  • 707b55d222abRevision changes
    • breaking

      the / response property's maxLength was unset from 255 for the response status

    • breaking

      the / response property's maxLength was unset from 255 for the response status

    • breaking

      the / response property's maxLength was unset from 255 for the response status

    • breaking

      the / response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the / response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the / response property's minLength was decreased from 1 to 0 for the response status

    • info

      the query request parameter businessLocationId became optional

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

  • f0328406dcdbRevision changes
    • warning

      added the new ENRICHED_PAYLOAD enum value to the // response property for the response status