GET
/
v1
/
admin
/
integrations
curl --request GET \
  --url https://api.botpress.cloud/v1/admin/integrations
{
  "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,
      "verificationStatus": "unapproved",
      "matchedOn": {
        "name": true,
        "title": true,
        "description": true,
        "actions": [
          "<string>"
        ],
        "interfaces": [
          "<string>"
        ]
      },
      "ownerWorkspace": {
        "id": "<string>",
        "handle": "<string>",
        "name": "<string>"
      }
    }
  ],
  "meta": {
    "nextToken": "<string>"
  }
}

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
​
visibility
enum<string>

Filter integrations by visibility (public, private)

Available options:
public,
private
​
dev
boolean

If true, only dev integrations are returned. Otherwise, only production integrations are returned.

Response

200
application/json
Success
​
integrations
object[]
required
​
meta
object
required

Was this page helpful?

Suggest editsRaise issue