Docs

listIntegrations

List integrations, supports filtering and sorting capabilities

GET/v1/admin/integrations

Authorization

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

Header parameters

x-workspace-idstringrequired
Workspace ID
x-multiple-integrationsstring
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

nextTokenstring
Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
limitnumber
Maximum number of results to return per page
namestring
Integration Name
versionstring
Integration version. Either a semver version or tag "latest"
interfaceIdstring
Filter integrations by implemented interface ID
interfaceNamestring
Filter integrations by implemented interface name (strict match)
installedByBotIdstring
Bot ID. Required when filtering for installed integrations
verificationStatusenum<string>
Filter integrations by verification status
Available options:"unapproved","pending","approved","rejected"
searchstring
Search integrations by name, description, actions, and interfaces. Responses include a matchedOn field indicating which fields matched the search.
sortByenum<string>
Sort integrations by field
Available options:"popularity","name","createdAt","updatedAt","installCount"
directionenum<string>
Sort direction (asc or desc)
Available options:"asc","desc"
visibilityenum<string>
Filter integrations by visibility (public, private)
Available options:"public","private"
devboolean
If true, only dev integrations are returned. Otherwise, only production integrations are returned.

Response

Success

integrationsobject[]required
metaobjectrequired