For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Home Docs API Reference MCP Server Chat SDKs Release Notes

Home Docs API Reference MCP Server Chat SDKs Release Notes

Introduction
Knowledge
End Users
Integrations
Conversations
Webhooks
- Overview
Data Compliance
- Overview
Data Export
- Overview
- Getting started
- Conversations
- Messages

Integrations Integrations

Get an installation

GET

https://example.ada.support/api/v2/platform-integrations/:id/installations/self

GET

/api/v2/platform-integrations/:id/installations/self

1 import requests
2 
3 url = "https://example.ada.support/api/v2/platform-integrations/id/installations/self"
4 
5 headers = {"Authorization": "Bearer <token>"}
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:00+00:00",
5   "updated": "2020-09-20T00:00:00+00:00",
6   "configuration": {
7     "credentials": {
8       "helpCenterUrl": "https://example.com",
9       "consumerKey": "123",
10       "consumerSecret": "456"
11     }
12   },
13   "status": "complete"
14 }

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.

Was this page helpful?

Update installation status

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequiredformat: "id"

The ID of the platform integration to fetch installation for

Response

Success

idstringformat: "id"

The unique identifier for the integration installation

platform_integration_idstringformat: "id"

The unique identifier for the integration

createdstringformat: "date-time"

The date and time the installation was created

updatedstringformat: "date-time"

The date and time the installation was last updated

configurationobject

The configuration settings for the integration

statusstring

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

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error