Sign in

v1

latestOpenAPI 3.1.02026-08-06911,228852.2 KB
PMS

Get a PMS provider by ID

Returns the details of a specific PMS provider.

Only PMS providers created by the authenticated OAuth client will be returned.

get/pms/v1/providers/{id}

Path parameters

idinteger required

The unique identifier for the provider.

Example:3012455645

Response

Provider found

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"
  ]
}