Get an installation

Get the platform integration installation associated with the access token. Use this endpoint to get the details of an installation, including the configuration form completed by the admin.

Path parameters

idstringRequired

The id of the platform integration to fetch installation for

Response

Success

idstringOptional

The unique identifier for the integration installation

platform_integration_idstringOptional

The unique identifier for the integration

createddatetimeOptional

The date and time the installation was created

updateddatetimeOptional

The date and time the installation was last updated

configurationmap from strings to anyOptional

The configuration settings for the integration

statusstringOptional

The current state of the integration installation (incomplete, complete)

1	import requests
2
3	url = "https://example.ada.support/api/v2/platform-integrations/5df263b7db5a7e6ea03fae9b/installations/self"
4
5	headers = {"Authorization": "Bearer <apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"id": "5df263b7db5a7e6ea03fae9b",
3	"platform_integration_id": "5df263b7db5a7e6ea03fae9b",
4	"created": "2020-09-20T00:00:00Z",
5	"updated": "2020-09-20T00:00:00Z",
6	"configuration": {
7	"key": "value"
8	},
9	"status": "complete"
10	}

Path parameters

Headers

Response

Errors