Get Company - Sequenzy

GET

api

companies

{companyId}

Get Company

curl --request GET \
  --url https://api.sequenzy.com/api/v1/companies/{companyId} \
  --header 'Authorization: Bearer <token>'

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))

}

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",
    "darkModeLogoStatus": "not_needed",
    "darkModeLogoUrl": null,
    "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",
    "emailStylePreference": "visual",
    "websiteType": "saas",
    "websiteTypeSource": "detected",
    "emailPreset": "branded",
    "footerStyle": "auto",
    "footerTheme": {
      "backgroundColor": "transparent",
      "companyTextColor": "#4b5563",
      "metaTextColor": "#6b7280",
      "linkColor": "#6b7280",
      "borderColor": "#e5e7eb",
      "reasonText": "",
      "unsubscribeText": "",
      "privacyPolicyText": "",
      "showCompanyLine": false,
      "style": "auto"
    },
    "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. footerTheme is the auto-added footer’s resolved colors and copy, defaults included: Sequenzy appends that footer when an email has no footer block. Empty reasonText, unsubscribeText and privacyPolicyText mean the localized default copy is used. Change it with footerTheme on update company. The footer’s font, size and line height live in emailTheme.typography (footerFontFamily, footerFontSize, footerLineHeight); emailTheme leaves out fields that are not set. darkModeLogoStatus says how the company logo is handled in dark-mode inboxes such as the Gmail and Outlook apps, which darken the email but never recolor images. outlined means the logo is a transparent image with dark ink, so emails use darkModeLogoUrl: the same logo with a thin white outline that is invisible on light backgrounds. not_needed means the logo already reads on dark (or is not a PNG on Sequenzy media or brand.dev), and darkModeLogoUrl is null. custom means you uploaded your own version with update company (darkModeLogoUrl), which emails use instead. pending means a new or changed logo has not been checked yet; this happens automatically within about 10 minutes. Both fields are null without a logo.

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",
    "darkModeLogoStatus": "not_needed",
    "darkModeLogoUrl": null,
    "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",
    "emailStylePreference": "visual",
    "websiteType": "saas",
    "websiteTypeSource": "detected",
    "emailPreset": "branded",
    "footerStyle": "auto",
    "footerTheme": {
      "backgroundColor": "transparent",
      "companyTextColor": "#4b5563",
      "metaTextColor": "#6b7280",
      "linkColor": "#6b7280",
      "borderColor": "#e5e7eb",
      "reasonText": "",
      "unsubscribeText": "",
      "privacyPolicyText": "",
      "showCompanyLine": false,
      "style": "auto"
    },
    "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

curl --request GET \
  --url https://api.sequenzy.com/api/v1/companies/{companyId} \
  --header 'Authorization: Bearer <token>'

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))

}

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",
    "darkModeLogoStatus": "not_needed",
    "darkModeLogoUrl": null,
    "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",
    "emailStylePreference": "visual",
    "websiteType": "saas",
    "websiteTypeSource": "detected",
    "emailPreset": "branded",
    "footerStyle": "auto",
    "footerTheme": {
      "backgroundColor": "transparent",
      "companyTextColor": "#4b5563",
      "metaTextColor": "#6b7280",
      "linkColor": "#6b7280",
      "borderColor": "#e5e7eb",
      "reasonText": "",
      "unsubscribeText": "",
      "privacyPolicyText": "",
      "showCompanyLine": false,
      "style": "auto"
    },
    "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"
}

​Request

​Responses

Request

Responses