# Platform Profile Details

**GET /reservation/api/1/platform/{platform-code}/profile**

Retrieve platform profile details.


## Servers
- Demo URL: https://api.trial.lsk.lightspeed.app (Demo URL)
- Production URL: https://api.lsk.lightspeed.app (Production URL)


## Authentication methods
- O auth2


## Parameters

#### Path parameters
- **platform-code** (string)
  The unique code assigned to the reservation platform.



## Responses
### 200: Platform profile details

#### Body Parameters: application/json (object)
- **baseUrl** (string(uri))
  The base URL of the external platform (optional).
- **depositSupported** (boolean)
  Whether or not the platform supports deposits.
- **displayName** (string)
  The official platform name that will be displayed.
- **errorsWebhookUrl** (string(uri))
  The URL where notifications for any issues will be sent. <br> Required for [`error` notificationTypes](https://api-docs.lsk.lightspeed.app/prod/operation/operation-reservation-servicesetbyplatformcode#operation-reservation-servicesetbyplatformcode-body-application-json-notificationtypes).<br> See [Get Sample Error notification](https://api-docs.lsk.lightspeed.app/operation/operation-reservationErrorNotification).

- **integrationWebhookUrl** (string(uri))
  The URL where notifications for activation or deactivation of the customer's integration will be sent. <br> Required for [`integration` notificationTypes](https://api-docs.lsk.lightspeed.app/prod/operation/operation-reservation-servicesetbyplatformcode#operation-reservation-servicesetbyplatformcode-body-application-json-notificationtypes).<br> See [Integration notification](https://api-docs.lsk.lightspeed.app/operation/operation-reservationintegrationnotification).

- **notificationTypes** (array[string])
  The events that trigger a notification.
- **onboardingWebhookUrl** (string(uri))
  The URL where notifications for the customer's integration onboarding will be sent. <br> Required for [`onboarding` notificationTypes](https://api-docs.lsk.lightspeed.app/prod/operation/operation-reservation-servicesetbyplatformcode#operation-reservation-servicesetbyplatformcode-body-application-json-notificationtypes).<br> See [Onboarding notification](https://api-docs.lsk.lightspeed.app/prod/operation/operation-reservationonboardingnotification).

- **orderWebhookUrl** (string(uri))
  The URL where order notifications will be sent. <br> Required for [`order` notificationTypes](https://api-docs.lsk.lightspeed.app/prod/operation/operation-reservation-servicesetbyplatformcode#operation-reservation-servicesetbyplatformcode-body-application-json-notificationtypes).<br> See [Order Notification](https://api-docs.lsk.lightspeed.app/prod/operation/operation-reservationordernotification).

- **posReservationUpdateWebhookUrl** (string(uri))
  The URL where notifications about reservation changes on POS will be sent.
- **ownNotificationsOnly** (boolean)
  When `true`, notifications will only be sent for orders linked to the reservation platform.
- **webhookAuthType** (string)
  The type of authentication used by the webhook.
- **allowCourseNumberUpdates** (boolean)
  If true, table statuses can be customized using a number format.
- **inServiceTableStatuses** (array[object])
  List of customizable table statuses that will be used to notify platforms about reservation progress with outbound API.
- **allowedPosStatuses** (array[string])
  Reservation statuses allowed for setting on a POS. PARTIALLY_ARRIVED should be included only with ARRIVED, and PARTIALLY_SEATED only with SEATED. Requires posReservationUpdateWebhookUrl to be set.

### 400: Non relevant request

### 403: Scope 'reservation-{platform-code}' not found in the token


[Powered by Bump.sh](https://bump.sh)