List Integrations

Query Parameters

nextToken?string

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

pageSize?integer

Number of items to return per page (default 20, max 100)

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?string

Filter integrations by verification status

Value in

"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?string

Sort integrations by field

Value in

"popularity"
"name"
"createdAt"
"updatedAt"
"installCount"

direction?string

Sort direction (asc or desc)

Value in

"asc"
"desc"

visibility?string

Filter integrations by visibility (public, private)

Value in

"public"
"private"

dev?boolean

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

Header Parameters

x-workspace-id*string

Workspace ID

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.

Response Body

`application/json`

curl -X GET "https://example.com/v1/admin/integrations" \  -H "x-workspace-id: string"

{  "integrations": [    {      "id": "stringstringstringstringstri",      "name": "string",      "version": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "title": "string",      "description": "string",      "iconUrl": "string",      "public": true,      "visibility": "public",      "verificationStatus": "unapproved",      "lifecycleStatus": "published",      "matchedOn": {        "name": true,        "title": true,        "description": true,        "actions": [          "string"        ],        "interfaces": [          "string"        ]      },      "ownerWorkspace": {        "id": "string",        "handle": "string",        "name": "string"      },      "attributes": {        "property1": "string",        "property2": "string"      }    }  ],  "meta": {    "nextToken": "string"  }}

{  "integrations": [    {      "id": "stringstringstringstringstri",      "name": "string",      "version": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "title": "string",      "description": "string",      "iconUrl": "string",      "public": true,      "visibility": "public",      "verificationStatus": "unapproved",      "lifecycleStatus": "published",      "matchedOn": {        "name": true,        "title": true,        "description": true,        "actions": [          "string"        ],        "interfaces": [          "string"        ]      },      "ownerWorkspace": {        "id": "string",        "handle": "string",        "name": "string"      },      "attributes": {        "property1": "string",        "property2": "string"      }    }  ],  "meta": {    "nextToken": "string"  }}

Query Parameters

Header Parameters

Response Body

200application/json

defaultapplication/json

`application/json`

`application/json`