Get inboxes
Retrieve inboxes available to your team.
curl --request GET \
--url https://api.heymarket.com/v1/inboxes \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.heymarket.com/v1/inboxes"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.heymarket.com/v1/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://api.heymarket.com/v1/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 => [
"Authorization: Bearer <token>"
],
]);
$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.heymarket.com/v1/inboxes"
req, _ := http.NewRequest("GET", url, nil)
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.heymarket.com/v1/inboxes")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heymarket.com/v1/inboxes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"allowed_domains": [
"<string>"
],
"auto_assignable": true,
"bco_chats": true,
"forward_number": "<string>",
"id": 123,
"invited": [
"<string>"
],
"members": [
123
],
"name": "<string>",
"op": "<string>",
"phone": "<string>",
"phones": [
"<string>"
],
"rev": 123,
"team": 123,
"widget_code": "<string>",
"widget_settings": {
"background_color": "<string>",
"button_color": "<string>",
"fab_background_color": "<string>",
"fab_text_color": "<string>",
"message": "<string>",
"name": "<string>",
"phone": "<string>",
"position": 123,
"preview_enabled": true,
"title_background_color": "<string>",
"title_text_color": "<string>",
"tos": "<string>"
}
}
]"<string>"Unauthorizedtoo many requestserrorinbox_id values required by message, conversation, and schedule requests.
GET /v1/inboxes or GET /v1/team as creator_id.Authorizations
Recommended authentication for new integrations. Generate a short-lived JWT from your API Secret ID and API Secret Key, then pass the signed JWT as a bearer token in the Authorization header.
API Secret credentials are available in the Heymarket app under Settings > Integrations > API. The Secret Key is shown only when it is generated, so copy and store it securely before closing the dialog.
Use the following JWT values:
{
"alg": "HS256",
"typ": "JWT"
}
{
"iss": "YOUR_API_SECRET_ID",
"iat": CURRENT_UNIX_TIMESTAMP
}
Replace CURRENT_UNIX_TIMESTAMP with the current Unix timestamp in seconds when generating the token.
Sign the JWT with HMAC-SHA256 using this signing secret:
YOUR_API_SECRET_ID||YOUR_API_SECRET_KEY
Send the signed JWT as a bearer token:
Authorization: Bearer YOUR_SIGNED_JWT
Tokens expire 5 minutes after the iat timestamp. Generate a new JWT per request, or cache it briefly for less than 5 minutes. Generate JWTs only from trusted server-side code; do not expose the API Secret Key in browser, mobile, or other client-side code.
Was this page helpful?
curl --request GET \
--url https://api.heymarket.com/v1/inboxes \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.heymarket.com/v1/inboxes"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.heymarket.com/v1/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://api.heymarket.com/v1/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 => [
"Authorization: Bearer <token>"
],
]);
$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.heymarket.com/v1/inboxes"
req, _ := http.NewRequest("GET", url, nil)
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.heymarket.com/v1/inboxes")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heymarket.com/v1/inboxes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"allowed_domains": [
"<string>"
],
"auto_assignable": true,
"bco_chats": true,
"forward_number": "<string>",
"id": 123,
"invited": [
"<string>"
],
"members": [
123
],
"name": "<string>",
"op": "<string>",
"phone": "<string>",
"phones": [
"<string>"
],
"rev": 123,
"team": 123,
"widget_code": "<string>",
"widget_settings": {
"background_color": "<string>",
"button_color": "<string>",
"fab_background_color": "<string>",
"fab_text_color": "<string>",
"message": "<string>",
"name": "<string>",
"phone": "<string>",
"position": 123,
"preview_enabled": true,
"title_background_color": "<string>",
"title_text_color": "<string>",
"tos": "<string>"
}
}
]"<string>"Unauthorizedtoo many requestserror