Get a PMS provider by ID

GET /pms/v1/providers/{id}

O auth2

Returns the details of a specific PMS provider.

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

Path parameters

id integer(int64) Required

The unique identifier for the provider.

Responses

200 application/json

Provider found
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.
400 */*

Bad Request
Hide response attributes Show response attributes object
- status string
- timestamp string(date-time)
- message string
- apiSubExceptions array[object]
  
  Hide apiSubExceptions attributes Show apiSubExceptions attributes object
  
  field string
  
  rejectedValue object
  
  message string
404 */*

Provider not found
Hide response attributes Show response attributes object
- status string
- timestamp string(date-time)
- message string
- apiSubExceptions array[object]
  
  Hide apiSubExceptions attributes Show apiSubExceptions attributes object
  
  field string
  
  rejectedValue object
  
  message string

GET /pms/v1/providers/{id}

curl \
 --request GET 'https://api.trial.lsk.lightspeed.app/pms/v1/providers/3012455645' \
 --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"
  ]
}

Response examples (400)

{
  "status": "string",
  "timestamp": "2025-05-04T09:42:00Z",
  "message": "string",
  "apiSubExceptions": [
    {
      "field": "string",
      "rejectedValue": {},
      "message": "string"
    }
  ]
}

Response examples (404)

{
  "status": "string",
  "timestamp": "2025-05-04T09:42:00Z",
  "message": "string",
  "apiSubExceptions": [
    {
      "field": "string",
      "rejectedValue": {},
      "message": "string"
    }
  ]
}