cURL
curl --request GET \
--url https://api.example.com/v1/account/subscriptions/{subscriptionID}/connectionimport requests
url = "https://api.example.com/v1/account/subscriptions/{subscriptionID}/connection"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/account/subscriptions/{subscriptionID}/connection', 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.example.com/v1/account/subscriptions/{subscriptionID}/connection",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/v1/account/subscriptions/{subscriptionID}/connection"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/v1/account/subscriptions/{subscriptionID}/connection")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/account/subscriptions/{subscriptionID}/connection")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"subscriptionUrl": "<string>",
"platform": "<string>",
"platforms": [
{
"slug": "<string>",
"label": "<string>"
}
],
"clients": [
{
"name": "<string>",
"deepLink": "<string>",
"downloadUrl": "<string>",
"instructions": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}account
Get v1accountsubscriptions connection
The access link plus the documented clients for one platform. The catalogue is the operator’s own and is read through one query that the bot reads too, so the two surfaces cannot recommend different applications.
GET
/
v1
/
account
/
subscriptions
/
{subscriptionID}
/
connection
cURL
curl --request GET \
--url https://api.example.com/v1/account/subscriptions/{subscriptionID}/connectionimport requests
url = "https://api.example.com/v1/account/subscriptions/{subscriptionID}/connection"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/account/subscriptions/{subscriptionID}/connection', 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.example.com/v1/account/subscriptions/{subscriptionID}/connection",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/v1/account/subscriptions/{subscriptionID}/connection"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/v1/account/subscriptions/{subscriptionID}/connection")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/account/subscriptions/{subscriptionID}/connection")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"subscriptionUrl": "<string>",
"platform": "<string>",
"platforms": [
{
"slug": "<string>",
"label": "<string>"
}
],
"clients": [
{
"name": "<string>",
"deepLink": "<string>",
"downloadUrl": "<string>",
"instructions": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"request_id": "<string>"
}Path Parameters
Query Parameters
A platform key from the catalogue. An unknown one falls back to the first documented platform rather than erroring, so a stale bookmark still works.
Response
Connection details
The platforms this installation documents, with labels already resolved to the customer's language. They are text rather than keys because the catalogue is operator-editable, and somebody adding a platform from the panel cannot add a message to a compiled catalogue.
Show child attributes
Show child attributes
Show child attributes
Show child attributes