Companies
Get Company
Get one company workspace
GET
/
api
/
v1
/
companies
/
{companyId}
Get Company
curl --request GET \
--url https://api.sequenzy.com/api/v1/companies/{companyId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sequenzy.com/api/v1/companies/{companyId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sequenzy.com/api/v1/companies/{companyId}', 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.sequenzy.com/api/v1/companies/{companyId}",
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.sequenzy.com/api/v1/companies/{companyId}"
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.sequenzy.com/api/v1/companies/{companyId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sequenzy.com/api/v1/companies/{companyId}")
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{
"success": true,
"company": {
"id": "company_abc123",
"name": "Acme",
"status": "ready",
"websiteUrl": "acme.com",
"logoUrl": "https://example.com/logo.png",
"primaryColor": "#0ea5e9",
"brandColors": { "primary": "#0ea5e9" },
"description": "Lifecycle email automation for SaaS teams.",
"toneVoice": "clear, direct, warm",
"companyContext": "Acme helps SaaS teams send lifecycle emails from product events.",
"emailDesignPrompt": "Editorial and calm. One idea per email, no feature grids.",
"emailLengthPreference": "concise",
"defaultSenderProfileId": "sender_abc123",
"defaultFromName": "Acme",
"defaultFromEmail": "hello@acme.com",
"defaultReplyProfileId": "reply_abc123",
"defaultReplyToName": "Acme Support",
"defaultReplyToEmail": "support@acme.com",
"replyTrackingEnabled": true,
"replyTrackingDomainMode": "sequenzy",
"forwardReplies": true,
"replyRetentionDays": 30,
"defaultSubscriberListIds": ["list_abc123"],
"emailBranding": {
"visible": true,
"removalEntitled": false,
"reason": "free_plan",
"managedBy": "owner_subscription",
"removalAction": "upgrade",
"subscriptionTier": null,
"subscriptionStatus": null,
"subscriptionUrl": "https://sequenzy.com/dashboard/company/company_abc123/account?tab=subscription"
},
"createdAt": "2026-05-01T10:30:00Z",
"language": "en",
"emailLocalizationConfig": {
"enabled": false,
"locales": []
}
}
}
{
"success": false,
"error": "Unauthorized"
}
{
"success": false,
"error": "Company not found"
}
Get company details for a company the authenticated key can access.
emailBranding reports the effective, read-only “Sent with Sequenzy”
entitlement. visible is what future renders and sends will show;
removalEntitled, reason, subscriptionTier, and subscriptionStatus
explain why. Use subscriptionUrl for the owner-facing upgrade or billing
handoff. The badge is injected when an email is rendered, so an entitlement
change also applies to future sends from existing live sequences without
editing their stored footer blocks.
The response includes defaultSubscriberListIds, the workspace default lists new contacts join when nothing targets them explicitly: null means every current and future list, [] means no list at all, and an array means exactly those lists. Read it before connecting an integration whose provider has no per-integration list targeting of its own: contacts created by live ingestion and payment-provider backfills land wherever this points. PostHog history imports are an exception and create contacts without list memberships. Change the setting with update company.
Request
string
required
Company ID.
curl "https://api.sequenzy.com/api/v1/companies/company_abc123" \
-H "Authorization: Bearer YOUR_API_KEY"
Responses
{
"success": true,
"company": {
"id": "company_abc123",
"name": "Acme",
"status": "ready",
"websiteUrl": "acme.com",
"logoUrl": "https://example.com/logo.png",
"primaryColor": "#0ea5e9",
"brandColors": { "primary": "#0ea5e9" },
"description": "Lifecycle email automation for SaaS teams.",
"toneVoice": "clear, direct, warm",
"companyContext": "Acme helps SaaS teams send lifecycle emails from product events.",
"emailDesignPrompt": "Editorial and calm. One idea per email, no feature grids.",
"emailLengthPreference": "concise",
"defaultSenderProfileId": "sender_abc123",
"defaultFromName": "Acme",
"defaultFromEmail": "hello@acme.com",
"defaultReplyProfileId": "reply_abc123",
"defaultReplyToName": "Acme Support",
"defaultReplyToEmail": "support@acme.com",
"replyTrackingEnabled": true,
"replyTrackingDomainMode": "sequenzy",
"forwardReplies": true,
"replyRetentionDays": 30,
"defaultSubscriberListIds": ["list_abc123"],
"emailBranding": {
"visible": true,
"removalEntitled": false,
"reason": "free_plan",
"managedBy": "owner_subscription",
"removalAction": "upgrade",
"subscriptionTier": null,
"subscriptionStatus": null,
"subscriptionUrl": "https://sequenzy.com/dashboard/company/company_abc123/account?tab=subscription"
},
"createdAt": "2026-05-01T10:30:00Z",
"language": "en",
"emailLocalizationConfig": {
"enabled": false,
"locales": []
}
}
}
{
"success": false,
"error": "Unauthorized"
}
{
"success": false,
"error": "Company not found"
}
⌘I
Get Company
curl --request GET \
--url https://api.sequenzy.com/api/v1/companies/{companyId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sequenzy.com/api/v1/companies/{companyId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sequenzy.com/api/v1/companies/{companyId}', 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.sequenzy.com/api/v1/companies/{companyId}",
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.sequenzy.com/api/v1/companies/{companyId}"
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.sequenzy.com/api/v1/companies/{companyId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sequenzy.com/api/v1/companies/{companyId}")
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{
"success": true,
"company": {
"id": "company_abc123",
"name": "Acme",
"status": "ready",
"websiteUrl": "acme.com",
"logoUrl": "https://example.com/logo.png",
"primaryColor": "#0ea5e9",
"brandColors": { "primary": "#0ea5e9" },
"description": "Lifecycle email automation for SaaS teams.",
"toneVoice": "clear, direct, warm",
"companyContext": "Acme helps SaaS teams send lifecycle emails from product events.",
"emailDesignPrompt": "Editorial and calm. One idea per email, no feature grids.",
"emailLengthPreference": "concise",
"defaultSenderProfileId": "sender_abc123",
"defaultFromName": "Acme",
"defaultFromEmail": "hello@acme.com",
"defaultReplyProfileId": "reply_abc123",
"defaultReplyToName": "Acme Support",
"defaultReplyToEmail": "support@acme.com",
"replyTrackingEnabled": true,
"replyTrackingDomainMode": "sequenzy",
"forwardReplies": true,
"replyRetentionDays": 30,
"defaultSubscriberListIds": ["list_abc123"],
"emailBranding": {
"visible": true,
"removalEntitled": false,
"reason": "free_plan",
"managedBy": "owner_subscription",
"removalAction": "upgrade",
"subscriptionTier": null,
"subscriptionStatus": null,
"subscriptionUrl": "https://sequenzy.com/dashboard/company/company_abc123/account?tab=subscription"
},
"createdAt": "2026-05-01T10:30:00Z",
"language": "en",
"emailLocalizationConfig": {
"enabled": false,
"locales": []
}
}
}
{
"success": false,
"error": "Unauthorized"
}
{
"success": false,
"error": "Company not found"
}