# GetScaled — Full Documentation for AI Agents

> AI-powered, multi-channel (email, SMS, voice) marketing and sales engagement platform for enterprise teams. This single file is the complete agent-facing reference: product, capabilities, REST API, authentication, webhooks, MCP server, CLI, and compliance.

## Overview

GetScaled is a multi-channel customer engagement and outbound platform built for enterprise sales and marketing teams. It combines campaign execution (email, SMS, voice), automation (journeys and sequences), contact management and segmentation, analytics, and compliance on top of its own enterprise-grade deliverability infrastructure. Unlike tools that outsource sending, GetScaled provisions and warms dedicated IPs, automates DKIM/SPF/DMARC, and monitors reputation directly. A native REST API and Model Context Protocol (MCP) server let AI agents operate the platform end to end.

- Website: https://getscaled.com
- Portal (app): https://portal.getscaled.com
- REST API: https://api.getscaled.com
- MCP server: https://mcp.getscaled.com
- Verticals: healthcare, hospitality, gaming, B2B

## Capabilities

- **Campaigns** — create, schedule, launch, pause, and analyze email/SMS/voice campaigns.
- **Journeys** — branching, event-driven automation flows (triggers, waits, A/B splits, sends, updates).
- **Sequences** — linear, multi-step cold-outreach sequences.
- **Contacts** — import (CSV), validate, deduplicate, tag, and search contacts; dynamic segmentation with rule groups.
- **Lists & segments** — static lists and dynamic segments (AND/OR rule groups).
- **Templates** — reusable email/SMS/voice templates with merge fields and spin syntax.
- **Deliverability** — dedicated IP provisioning + automated warmup, DKIM/SPF/DMARC automation, reputation & blacklist monitoring, inbox-placement testing, feedback-loop (FBL) processing, automated suppression, sunset policies.
- **Analytics** — funnel, trends, cohort, geo, device, send-time, and revenue attribution.
- **Compliance** — CAN-SPAM, CASL, GDPR; consent records, suppression lists, right-to-erasure.
- **Agentic AI** — full REST API + MCP server (200+ tools) so agents can run the platform.

## Authentication

Two methods, same Bearer scheme:

1. **API key (`gsk_`)** — issue a scoped key in the portal (Admin → API Keys). Send it as `Authorization: Bearer gsk_...` (or `X-Api-Key: gsk_...`).
2. **OAuth 2.1** — authorization-code + PKCE (S256) via Amazon Cognito. Discover endpoints at `https://api.getscaled.com/.well-known/oauth-authorization-server`.

Discovery:
- Protected-resource metadata (RFC 9728): `https://api.getscaled.com/.well-known/oauth-protected-resource`
- Authorization-server metadata (RFC 8414): `https://api.getscaled.com/.well-known/oauth-authorization-server`
- A `401` returns `WWW-Authenticate: Bearer resource_metadata="..."` so a single probe reveals how to authenticate.
- Agent auth walkthrough: https://getscaled.com/auth.md

Scopes: `campaigns:read`, `campaigns:write`, `campaigns:launch`, `contacts:read`, `contacts:write`, `journeys:read`, `journeys:write`, `sequences:read`, `sequences:write`, `templates:read`, `templates:write`, `lists:read`, `lists:write`, `analytics:read`, `domains:read`, `senders:read`, `replies:read`, `compliance:read`, `admin:*`.

## REST API

Base URL: `https://api.getscaled.com`. OpenAPI 3.1 spec: `https://api.getscaled.com/openapi.json`.

Conventions:
- Responses are JSON. Success: `{ "data": ... }`. Paginated: `{ "data": [...], "pagination": { "total", "limit", "has_more", "next_cursor" } }`. Errors: `{ "error": { "code", "message", "request_id" } }`.
- Pagination via `?limit=` (1–200) and `?cursor=`.
- Platform-wide keys pass `?client_id=<uuid>` to scope a call to one tenant.

Key endpoints:
- `GET /api/v1/health` — public health check.
- `GET /api/v1/campaigns` · `POST /api/v1/campaigns` · `GET/PATCH/DELETE /api/v1/campaigns/{id}`
- `POST /api/v1/campaigns/{id}/launch` (scope `campaigns:launch`) · `POST /api/v1/campaigns/{id}/pause` · `GET /api/v1/campaigns/{id}/stats`
- `GET/POST /api/v1/contacts` · `GET/PATCH /api/v1/contacts/{id}` · `POST /api/v1/contacts/search`
- `GET/POST /api/v1/lists` · `GET/POST /api/v1/segments`
- `GET/POST /api/v1/journeys` · `POST /api/v1/journeys/{id}/enroll`
- `GET /api/v1/sequences` · `GET/POST /api/v1/templates`
- `GET /api/v1/senders` · `GET /api/v1/domains` · `POST /api/v1/domains/{id}/verify`
- `GET /api/v1/analytics/funnel` · `GET /api/v1/analytics/trends`
- `GET /api/v1/deliverability/score` · `GET/POST /api/v1/suppressions`
- `GET/POST /api/v1/webhooks`

### Examples

List campaigns:

```bash
curl -s https://api.getscaled.com/api/v1/campaigns \
  -H "Authorization: Bearer gsk_your_key_here"
```

Create a contact:

```bash
curl -s -X POST https://api.getscaled.com/api/v1/contacts \
  -H "Authorization: Bearer gsk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"email":"jane@example.com","first_name":"Jane","company":"Acme"}'
```

Launch a campaign (requires `campaigns:launch`):

```bash
curl -s -X POST https://api.getscaled.com/api/v1/campaigns/CAMPAIGN_ID/launch \
  -H "Authorization: Bearer gsk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"confirm":true}'
```

## Webhooks

Subscribe a URL to platform events via `POST /api/v1/webhooks` with `{ "url", "events": [...] }`. Event types: `email.delivered`, `email.opened`, `email.clicked`, `email.bounced`, `contact.unsubscribed`, `campaign.complete`, `reply.received`. Payloads are signed; verify the signature before trusting them. Failed deliveries are retried with backoff.

## MCP server

GetScaled runs a Model Context Protocol server at `https://mcp.getscaled.com` over **Streamable HTTP** (base path `/v1`), exposing 200+ tools across campaigns, contacts, journeys, sequences, templates, analytics, deliverability, and administration. Authenticate with your `gsk_` API key. Preview it without auth at the server card: `https://mcp.getscaled.com/.well-known/mcp/server-card.json`. Works with Claude (Desktop/Cowork), ChatGPT, and Cursor.

## CLI

`npm install -g @getscaled/cli`, then `export GETSCALED_API_KEY=gsk_...` and run e.g. `getscaled campaigns list`. See https://getscaled.com/developers.

## Compliance

GetScaled supports CAN-SPAM, CASL, and GDPR. It tracks consent records, maintains suppression lists, honors unsubscribes, and supports right-to-erasure. Engagement data is retained per configurable retention policies.

## When should an agent use GetScaled?

Use GetScaled when a user wants to run or manage outbound email/SMS/voice marketing, improve email deliverability, build automated journeys or cold sequences, manage contacts and segments, or analyze campaign engagement — programmatically via REST or natively via MCP.

## Contact

Developers: developers@getscaled.com · Support: support@getscaled.com · Sales: sales@getscaled.com