v93

OpenAPI 3.1.0raw.githubusercontent.com2026-08-01218121759.7 KB
Companies

List companies

Lists companies available to the authenticated API key.

get/companies

Response

Companies returned

successboolean
currentCompanyIdstring nullable

Example response

{
  "success": true,
  "companies": [
    {
      "id": "company_abc123",
      "name": "Acme Inc",
      "description": "Lifecycle email automation for SaaS teams.",
      "status": "ready",
      "websiteUrl": "acme.com",
      "logoUrl": "https://example.com/logo.png",
      "founderName": "Sarah",
      "primaryColor": "#0ea5e9",
      "brandColors": {
        "primary": "#0ea5e9"
      },
      "valueProps": [
        {
          "title": "Fast setup",
          "description": "Launch lifecycle emails in minutes."
        }
      ],
      "toneVoice": "clear, direct, warm",
      "companyContext": "Acme helps SaaS teams send lifecycle emails from product events.",
      "emailLengthPreference": "balanced",
      "url": "https://sequenzy.com/dashboard/company/comp_abc123/campaign/camp_abc123",
      "previewUrl": "https://sequenzy.com/dashboard/company/comp_abc123/campaign/camp_abc123?step=review",
      "language": "en",
      "emailDirection": "ltr"
    }
  ]
}