Get PMS providers

GET /pms/v1/providers

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

Query parameters

Responses

GET /pms/v1/providers
curl \
 -X GET https://api.trial.lsk.lightspeed.app/pms/v1/providers?businessLocationId=45454565682155 \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
[
  {
    "id": 3012455645,
    "businessLocationId": 45454565682155,
    "name": "John Smith",
    "endpoint": "http://integration.com/pms/endpoint",
    "apiKey": "secret-1234",
    "features": [
      "MIRRORING"
    ]
  }
]
Response examples (403)
{
  "status": "string",
  "timestamp": "2024-05-04T09:42:00+00:00",
  "message": "string",
  "apiSubExceptions": [
    {
      "field": "string",
      "rejectedValue": {},
      "message": "string"
    }
  ]
}
Response examples (503)
{
  "status": "string",
  "timestamp": "2024-05-04T09:42:00+00:00",
  "message": "string",
  "apiSubExceptions": [
    {
      "field": "string",
      "rejectedValue": {},
      "message": "string"
    }
  ]
}