1. Integration
  2. Integration Instance

Integration Instance GET

URI

https://{DATACENTER}.brightpearlconnect.com/public-api/{ACCOUNT}
/integration-service/integration/instance

Refer to our documentation on URI syntax for more information on how to construct URIs.

Description

This endpoint allows you to fetch your own installed integration instance. It uses the token passed in the Authorization header (OAuth) or brightpearl-instance-token header (instance auth) and returns the associated instance.

Example

Get the instance associated with your authorization token

Request URI

/integration/instance

Response

{
	"response": {
		"installedIntegrationInstanceId": 3,
		"installedIntegrationId": 13,
		"instanceName": "amazingappinstance3"
	}
}