Skip to main content
GET
/
v1
/
admin
/
hub
/
integrations
cURL
curl --request GET \
  --url https://api.botpress.cloud/v1/admin/hub/integrations \
  --header 'Authorization: Bearer <token>'
{
  "integrations": [
    {
      "id": "<string>",
      "name": "<string>",
      "version": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "title": "<string>",
      "description": "<string>",
      "iconUrl": "<string>",
      "public": true,
      "visibility": "public",
      "verificationStatus": "unapproved",
      "ownerWorkspace": {
        "id": "<string>",
        "handle": "<string>",
        "name": "<string>"
      },
      "meta": {
        "installs": 123,
        "views": 123
      },
      "matchedOn": {
        "name": true,
        "title": true,
        "description": true,
        "actions": [
          "<string>"
        ],
        "interfaces": [
          "<string>"
        ]
      }
    }
  ],
  "meta": {
    "nextToken": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-multiple-integrations
string

Whether the client supports bots with multiple instances of the same integration. Set to "true" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Query Parameters

​
nextToken
string

Provide the meta.nextToken value provided in the last API response to retrieve the next page of results

​
limit
number

Maximum number of results to return per page

​
name
string

Integration Name

​
version
string

Integration version. Either a semver version or tag "latest"

​
interfaceId
string

Filter integrations by implemented interface ID

​
interfaceName
string

Filter integrations by implemented interface name (strict match)

​
installedByBotId
string

Bot ID. Required when filtering for installed integrations

​
verificationStatus
enum<string>

Filter integrations by verification status

Available options:
unapproved,
pending,
approved,
rejected
​
search
string

Search integrations by name, description, actions, and interfaces. Responses include a matchedOn field indicating which fields matched the search.

​
sortBy
enum<string>

Sort integrations by field

Available options:
popularity,
name,
createdAt,
updatedAt,
installCount
​
direction
enum<string>

Sort direction (asc or desc)

Available options:
asc,
desc

Response

Success

​
integrations
object[]
required
​
meta
object
required