TENANTS
Get Tenant Data
API to fetch tenant settings (logo, colors, links, preference) corresponding to a tenant_id. To create or update tenant data, use the Create/Update Tenant endpoint.
GET
/
v1
/
tenant
/
{tenant_id}
/
Get Tenant data
curl --request GET \
--url https://hub.suprsend.com/v1/tenant/{tenant_id}/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://hub.suprsend.com/v1/tenant/{tenant_id}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://hub.suprsend.com/v1/tenant/{tenant_id}/', 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://hub.suprsend.com/v1/tenant/{tenant_id}/",
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://hub.suprsend.com/v1/tenant/{tenant_id}/"
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://hub.suprsend.com/v1/tenant/{tenant_id}/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://hub.suprsend.com/v1/tenant/{tenant_id}/")
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{
"tenant_id": "_tenant_id_",
"tenant_name": "Awesome Tenant",
"logo": "https://ik.imagekit.io/l0quatz6utm/suprsend/staging/media/suprsend-only-logo_c8aa27faef118418e8c5bd7b31a1cafc74e09200.png",
"timezone": null,
"blocked_channels": [
"email"
],
"embedded_preference_url": "https://app.suprsend.com/en/user-settings/notifications",
"hosted_preference_domain": "preferences.suprsend.com",
"primary_color": "#ff0000",
"secondary_color": "#0000ff",
"tertiary_color": "#00ffff",
"social_links": {
"website": "https://suprsend.com",
"facebook": "https://www.company.com",
"linkedin": "",
"x": "",
"instagram": "",
"medium": "",
"discord": "",
"telegram": "",
"youtube": "",
"tiktok": ""
},
"properties": {
"k1": "v1",
"address": "my company address"
},
"updated_at": "2025-04-06T21:01:35.359787Z"
}{
"code": 404,
"error_code": "not_found",
"type": "NotFound",
"message": "No tenant found for tenant_id tenant",
"detail": "No tenant found for tenant_id tenant"
}Authorizations
Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.
Path Parameters
unique identifier of the tenant you want to get the details for
Response
200
Updated Object Payload is returned in response. JSON structure similar to request payload.
Was this page helpful?
⌘I
Get Tenant data
curl --request GET \
--url https://hub.suprsend.com/v1/tenant/{tenant_id}/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://hub.suprsend.com/v1/tenant/{tenant_id}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://hub.suprsend.com/v1/tenant/{tenant_id}/', 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://hub.suprsend.com/v1/tenant/{tenant_id}/",
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://hub.suprsend.com/v1/tenant/{tenant_id}/"
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://hub.suprsend.com/v1/tenant/{tenant_id}/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://hub.suprsend.com/v1/tenant/{tenant_id}/")
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{
"tenant_id": "_tenant_id_",
"tenant_name": "Awesome Tenant",
"logo": "https://ik.imagekit.io/l0quatz6utm/suprsend/staging/media/suprsend-only-logo_c8aa27faef118418e8c5bd7b31a1cafc74e09200.png",
"timezone": null,
"blocked_channels": [
"email"
],
"embedded_preference_url": "https://app.suprsend.com/en/user-settings/notifications",
"hosted_preference_domain": "preferences.suprsend.com",
"primary_color": "#ff0000",
"secondary_color": "#0000ff",
"tertiary_color": "#00ffff",
"social_links": {
"website": "https://suprsend.com",
"facebook": "https://www.company.com",
"linkedin": "",
"x": "",
"instagram": "",
"medium": "",
"discord": "",
"telegram": "",
"youtube": "",
"tiktok": ""
},
"properties": {
"k1": "v1",
"address": "my company address"
},
"updated_at": "2025-04-06T21:01:35.359787Z"
}{
"code": 404,
"error_code": "not_found",
"type": "NotFound",
"message": "No tenant found for tenant_id tenant",
"detail": "No tenant found for tenant_id tenant"
}