getIntegrationByName
Get integration
GET
/
v1
/
admin
/
integrations
/
{name}
/
{version}
cURL
curl --request GET \
--url https://api.botpress.cloud/v1/admin/integrations/{name}/{version} \
--header 'Authorization: Bearer <token>' \
--header 'x-workspace-id: <x-workspace-id>'import requests
url = "https://api.botpress.cloud/v1/admin/integrations/{name}/{version}"
headers = {
"x-workspace-id": "<x-workspace-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-workspace-id': '<x-workspace-id>', Authorization: 'Bearer <token>'}
};
fetch('https://api.botpress.cloud/v1/admin/integrations/{name}/{version}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.botpress.cloud/v1/admin/integrations/{name}/{version}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"x-workspace-id: <x-workspace-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.botpress.cloud/v1/admin/integrations/{name}/{version}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-workspace-id", "<x-workspace-id>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.botpress.cloud/v1/admin/integrations/{name}/{version}")
.header("x-workspace-id", "<x-workspace-id>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.botpress.cloud/v1/admin/integrations/{name}/{version}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-workspace-id"] = '<x-workspace-id>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"integration": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"identifier": {
"fallbackHandlerScript": "<string>",
"extractScript": "<string>"
},
"url": "<string>",
"signingSecret": "<string>",
"name": "<string>",
"version": "<string>",
"interfaces": {},
"configuration": {
"identifier": {
"required": true,
"linkTemplateScript": "<string>"
},
"schema": {},
"title": "<string>",
"description": "<string>"
},
"configurations": {},
"channels": {},
"states": {},
"events": {},
"actions": {},
"user": {
"tags": {},
"creation": {
"enabled": true,
"requiredTags": [
"<string>"
]
}
},
"entities": {},
"dev": true,
"title": "<string>",
"description": "<string>",
"iconUrl": "<string>",
"readmeUrl": "<string>",
"public": true,
"visibility": "public",
"verificationStatus": "unapproved",
"lifecycleStatus": "published",
"secrets": [
"<string>"
],
"sandbox": {
"identifierExtractScript": "<string>",
"messageExtractScript": "<string>"
},
"maxExecutionTime": 123,
"attributes": {}
}
}{
"integration": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"identifier": {
"fallbackHandlerScript": "<string>",
"extractScript": "<string>"
},
"url": "<string>",
"signingSecret": "<string>",
"name": "<string>",
"version": "<string>",
"interfaces": {},
"configuration": {
"identifier": {
"required": true,
"linkTemplateScript": "<string>"
},
"schema": {},
"title": "<string>",
"description": "<string>"
},
"configurations": {},
"channels": {},
"states": {},
"events": {},
"actions": {},
"user": {
"tags": {},
"creation": {
"enabled": true,
"requiredTags": [
"<string>"
]
}
},
"entities": {},
"dev": true,
"title": "<string>",
"description": "<string>",
"iconUrl": "<string>",
"readmeUrl": "<string>",
"public": true,
"visibility": "public",
"verificationStatus": "unapproved",
"lifecycleStatus": "published",
"secrets": [
"<string>"
],
"sandbox": {
"identifierExtractScript": "<string>",
"messageExtractScript": "<string>"
},
"maxExecutionTime": 123,
"attributes": {}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Workspace ID
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.
Path Parameters
Integration Name
Integration version. Either a semver version, semver version range, or the constant string "latest"
Response
Success
Show child attributes
Show child attributes
Last modified on March 20, 2026
Was this page helpful?
⌘I
cURL
curl --request GET \
--url https://api.botpress.cloud/v1/admin/integrations/{name}/{version} \
--header 'Authorization: Bearer <token>' \
--header 'x-workspace-id: <x-workspace-id>'import requests
url = "https://api.botpress.cloud/v1/admin/integrations/{name}/{version}"
headers = {
"x-workspace-id": "<x-workspace-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-workspace-id': '<x-workspace-id>', Authorization: 'Bearer <token>'}
};
fetch('https://api.botpress.cloud/v1/admin/integrations/{name}/{version}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.botpress.cloud/v1/admin/integrations/{name}/{version}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"x-workspace-id: <x-workspace-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.botpress.cloud/v1/admin/integrations/{name}/{version}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-workspace-id", "<x-workspace-id>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.botpress.cloud/v1/admin/integrations/{name}/{version}")
.header("x-workspace-id", "<x-workspace-id>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.botpress.cloud/v1/admin/integrations/{name}/{version}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-workspace-id"] = '<x-workspace-id>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"integration": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"identifier": {
"fallbackHandlerScript": "<string>",
"extractScript": "<string>"
},
"url": "<string>",
"signingSecret": "<string>",
"name": "<string>",
"version": "<string>",
"interfaces": {},
"configuration": {
"identifier": {
"required": true,
"linkTemplateScript": "<string>"
},
"schema": {},
"title": "<string>",
"description": "<string>"
},
"configurations": {},
"channels": {},
"states": {},
"events": {},
"actions": {},
"user": {
"tags": {},
"creation": {
"enabled": true,
"requiredTags": [
"<string>"
]
}
},
"entities": {},
"dev": true,
"title": "<string>",
"description": "<string>",
"iconUrl": "<string>",
"readmeUrl": "<string>",
"public": true,
"visibility": "public",
"verificationStatus": "unapproved",
"lifecycleStatus": "published",
"secrets": [
"<string>"
],
"sandbox": {
"identifierExtractScript": "<string>",
"messageExtractScript": "<string>"
},
"maxExecutionTime": 123,
"attributes": {}
}
}{
"integration": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"identifier": {
"fallbackHandlerScript": "<string>",
"extractScript": "<string>"
},
"url": "<string>",
"signingSecret": "<string>",
"name": "<string>",
"version": "<string>",
"interfaces": {},
"configuration": {
"identifier": {
"required": true,
"linkTemplateScript": "<string>"
},
"schema": {},
"title": "<string>",
"description": "<string>"
},
"configurations": {},
"channels": {},
"states": {},
"events": {},
"actions": {},
"user": {
"tags": {},
"creation": {
"enabled": true,
"requiredTags": [
"<string>"
]
}
},
"entities": {},
"dev": true,
"title": "<string>",
"description": "<string>",
"iconUrl": "<string>",
"readmeUrl": "<string>",
"public": true,
"visibility": "public",
"verificationStatus": "unapproved",
"lifecycleStatus": "published",
"secrets": [
"<string>"
],
"sandbox": {
"identifierExtractScript": "<string>",
"messageExtractScript": "<string>"
},
"maxExecutionTime": 123,
"attributes": {}
}
}