List integrations

import requests
url = "https://example.ada.support/api/v2/platform-integrations/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "data": [
    {
      "id": "5df263b7db5a7e6ea03fae9b",
      "status": "development",
      "identifier_field_path": "credentials.knowledgeHubUrl",
      "name": "Connect to Cool Shop Knowledge Hub",
      "description": "Connect to Cool Shop Knowledge Hub to sync articles with your AI Agent's knowledge base",
      "author": "Cool Shop",
      "contact": "help@coolshop.support",
      "uninstallation_url": "http://coolshop.com/uninstall",
      "oauth_callback_url": "http://coolshop.com/",
      "tags": [
        "knowledge"
      ],
      "scopes": [
        "articles:read",
        "knowledge_sources:write"
      ],
      "configuration_fields": {
        "title": "Connect to Cool Shop Knowledge Hub",
        "type": "object",
        "description": "Complete this form to integrate your Knowledge Hub with your AI Agent",
        "required": [
          "credentials"
        ],
        "properties": {
          "credentials": {
            "type": "object",
            "title": "My Knowledge Hub credentials",
            "description": "The following information is found in your Cool Shop admin center",
            "properties": {
              "knowledgeHubUrl": {
                "type": "string",
                "title": "Knowledge Hub URL",
                "description": "The URL of your Knowledge Hub"
              },
              "secretKey": {
                "type": "string",
                "title": "Secret key",
                "description": "Find your Knowledge Hub secret key on the Knowledge Hub Management page",
                "format": "password"
              }
            },
            "required": [
              "knowledgeHubUrl",
              "secretKey"
            ]
          }
        }
      },
      "created": "2020-09-20T00:00:00+00:00",
      "updated": "2020-09-20T00:00:00+00:00",
      "icon_url": "https://example.com/icon.png",
      "call_to_action": "Connect to Cool Shop Knowledge Hub",
      "error_codes": {
        "error_403": "Unauthorized",
        "error_404": "Not Found"
      }
    }
  ],
  "meta": {
    "next_page_url": "https://example.ada.support/api/v2/api-name?cursor=6658f91ea88ff7e389eff34d"
  }
}

import requests
url = "https://example.ada.support/api/v2/platform-integrations/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "data": [
    {
      "id": "5df263b7db5a7e6ea03fae9b",
      "status": "development",
      "identifier_field_path": "credentials.knowledgeHubUrl",
      "name": "Connect to Cool Shop Knowledge Hub",
      "description": "Connect to Cool Shop Knowledge Hub to sync articles with your AI Agent's knowledge base",
      "author": "Cool Shop",
      "contact": "help@coolshop.support",
      "uninstallation_url": "http://coolshop.com/uninstall",
      "oauth_callback_url": "http://coolshop.com/",
      "tags": [
        "knowledge"
      ],
      "scopes": [
        "articles:read",
        "knowledge_sources:write"
      ],
      "configuration_fields": {
        "title": "Connect to Cool Shop Knowledge Hub",
        "type": "object",
        "description": "Complete this form to integrate your Knowledge Hub with your AI Agent",
        "required": [
          "credentials"
        ],
        "properties": {
          "credentials": {
            "type": "object",
            "title": "My Knowledge Hub credentials",
            "description": "The following information is found in your Cool Shop admin center",
            "properties": {
              "knowledgeHubUrl": {
                "type": "string",
                "title": "Knowledge Hub URL",
                "description": "The URL of your Knowledge Hub"
              },
              "secretKey": {
                "type": "string",
                "title": "Secret key",
                "description": "Find your Knowledge Hub secret key on the Knowledge Hub Management page",
                "format": "password"
              }
            },
            "required": [
              "knowledgeHubUrl",
              "secretKey"
            ]
          }
        }
      },
      "created": "2020-09-20T00:00:00+00:00",
      "updated": "2020-09-20T00:00:00+00:00",
      "icon_url": "https://example.com/icon.png",
      "call_to_action": "Connect to Cool Shop Knowledge Hub",
      "error_codes": {
        "error_403": "Unauthorized",
        "error_404": "Not Found"
      }
    }
  ],
  "meta": {
    "next_page_url": "https://example.ada.support/api/v2/api-name?cursor=6658f91ea88ff7e389eff34d"
  }
}

Get a list of platform integrations owned by your account (e.g. a developer sandbox)

Authentication

AuthorizationBearer

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

Query parameters

cursorstringOptionalformat: "id"

The ID that marks the start or beginning of the returned records

limitintegerOptional1-100

The number of records to return

Response

Platform integrations

datalist of objects

metaobject

Errors

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

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

1	{
2	"data": [
3	{
4	"id": "5df263b7db5a7e6ea03fae9b",
5	"status": "development",
6	"identifier_field_path": "credentials.knowledgeHubUrl",
7	"name": "Connect to Cool Shop Knowledge Hub",
8	"description": "Connect to Cool Shop Knowledge Hub to sync articles with your AI Agent's knowledge base",
9	"author": "Cool Shop",
10	"contact": "help@coolshop.support",
11	"uninstallation_url": "http://coolshop.com/uninstall",
12	"oauth_callback_url": "http://coolshop.com/",
13	"tags": [
14	"knowledge"
15	],
16	"scopes": [
17	"articles:read",
18	"knowledge_sources:write"
19	],
20	"configuration_fields": {
21	"title": "Connect to Cool Shop Knowledge Hub",
22	"type": "object",
23	"description": "Complete this form to integrate your Knowledge Hub with your AI Agent",
24	"required": [
25	"credentials"
26	],
27	"properties": {
28	"credentials": {
29	"type": "object",
30	"title": "My Knowledge Hub credentials",
31	"description": "The following information is found in your Cool Shop admin center",
32	"properties": {
33	"knowledgeHubUrl": {
34	"type": "string",
35	"title": "Knowledge Hub URL",
36	"description": "The URL of your Knowledge Hub"
37	},
38	"secretKey": {
39	"type": "string",
40	"title": "Secret key",
41	"description": "Find your Knowledge Hub secret key on the Knowledge Hub Management page",
42	"format": "password"
43	}
44	},
45	"required": [
46	"knowledgeHubUrl",
47	"secretKey"
48	]
49	}
50	}
51	},
52	"created": "2020-09-20T00:00:00+00:00",
53	"updated": "2020-09-20T00:00:00+00:00",
54	"icon_url": "https://example.com/icon.png",
55	"call_to_action": "Connect to Cool Shop Knowledge Hub",
56	"error_codes": {
57	"error_403": "Unauthorized",
58	"error_404": "Not Found"
59	}
60	}
61	],
62	"meta": {
63	"next_page_url": "https://example.ada.support/api/v2/api-name?cursor=6658f91ea88ff7e389eff34d"
64	}
65	}