curl --request GET \
--url https://core-api.getaptly.com/api/inboxes \
--header 'x-token: <api-key>'import requests
url = "https://core-api.getaptly.com/api/inboxes"
headers = {"x-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-token': '<api-key>'}};
fetch('https://core-api.getaptly.com/api/inboxes', 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://core-api.getaptly.com/api/inboxes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-token: <api-key>"
],
]);
$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://core-api.getaptly.com/api/inboxes"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://core-api.getaptly.com/api/inboxes")
.header("x-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/inboxes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"channelId": "<string>",
"type": "email",
"provider": "<string>",
"name": "<string>",
"email": "<string>",
"number": "<string>",
"isShared": true,
"access": "owned"
}
]
}{
"error": "<string>",
"message": "<string>"
}List inboxes you can query
Returns the email and phone/SMS inboxes available to the credential, for use
as the channelId on the messages and analytics endpoints.
With delegate-token auth (inboxes:* scope) results are limited to
inboxes the authenticated user can reach, and each entry carries access:
owned when the user is a member of the inbox (directly or through a team),
monitored when it is another user’s private inbox that the caller is
permitted to monitor. scope filters on that value.
Monitoring requires the conversations.monitor_admin permission on the
caller and conversations.monitor_access on the inbox owner’s role, so a
caller without those permissions sees only owned inboxes.
API keys and partner tokens are company-scoped and carry no user identity, so
they return every inbox in the company, omit access, and reject scope
with a 400.
curl --request GET \
--url https://core-api.getaptly.com/api/inboxes \
--header 'x-token: <api-key>'import requests
url = "https://core-api.getaptly.com/api/inboxes"
headers = {"x-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-token': '<api-key>'}};
fetch('https://core-api.getaptly.com/api/inboxes', 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://core-api.getaptly.com/api/inboxes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-token: <api-key>"
],
]);
$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://core-api.getaptly.com/api/inboxes"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://core-api.getaptly.com/api/inboxes")
.header("x-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/inboxes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"channelId": "<string>",
"type": "email",
"provider": "<string>",
"name": "<string>",
"email": "<string>",
"number": "<string>",
"isShared": true,
"access": "owned"
}
]
}{
"error": "<string>",
"message": "<string>"
}Authorizations
Query Parameters
Filter by access type. Delegate-token auth only — rejected for company-scoped credentials.
owned, monitored, all Response
Inboxes available to the credential.
Show child attributes
Show child attributes