REST API

Base URL: https://api.alync.co/v1 — JSON in, JSON out. The full machine-readable spec is at /v1/openapi.yaml.

Authentication

Create a key in Settings → API Keys (Scale plan and above). Keys are shown once, are workspace-scoped, and carry a role (admin or member). Send the key either way:

X-API-Key: alync_live_...
# or
Authorization: Bearer alync_live_...

Rate limits

300 requests/minute per key by default. Exceeding it returns 429 with a Retry-After header (seconds). Every response carries an X-Request-Id — include it when contacting support.

Core flow

Create a campaign from a plain-language description of what you sell.
Generate a strategy — the AI derives your ICP, intent signals, and per-platform searches.
Run batches — sourcing executes in the background and promotes qualified leads.
Enrich promoted leads with emails, socials, websites, phones (Growth plan and above).

# 1. Create a campaign
curl -X POST https://api.alync.co/v1/campaigns \
  -H "X-API-Key: $ALYNC_KEY" -H "Content-Type: application/json" \
  -d '{"name":"Clinics Q3","offering":"I sell AI customer support systems for dental clinics"}'

# 2. Generate the sourcing strategy (one-time per campaign)
curl -X POST https://api.alync.co/v1/campaigns/$CAMPAIGN_ID/generate-strategy \
  -H "X-API-Key: $ALYNC_KEY"

# 3. Run a sourcing batch (answers 202 — async)
curl -X POST https://api.alync.co/v1/campaigns/$CAMPAIGN_ID/run-batch \
  -H "X-API-Key: $ALYNC_KEY" -H "Content-Type: application/json" -d '{"batch_size":6}'

# 4. Read promoted leads
curl https://api.alync.co/v1/campaigns/$CAMPAIGN_ID/leads -H "X-API-Key: $ALYNC_KEY"

# 5. Enrich contacts (Growth+, answers 202 — async)
curl -X POST https://api.alync.co/v1/campaigns/$CAMPAIGN_ID/enrich \
  -H "X-API-Key: $ALYNC_KEY" -H "Content-Type: application/json" -d '{"limit":10}'

Endpoints

Method	Path	What it does
`GET`	`/v1/campaigns`	List campaigns
`POST`	`/v1/campaigns`	Create a campaign
`GET`	`/v1/campaigns/:id`	Campaign detail + background activity
`POST`	`/v1/campaigns/:id/generate-strategy`	AI strategy from the offering
`POST`	`/v1/campaigns/:id/run-batch`	Run the next sourcing batch (async, 202)
`POST`	`/v1/campaigns/:id/enrich`	Enrich promoted leads (async, 202)
`GET`	`/v1/campaigns/:id/leads`	Promoted, deduped leads
`GET`	`/v1/campaigns/:id/signals`	Raw scored signals (`?status=promoted\|rejected\|…`)
`GET`	`/v1/campaigns/:id/runs`	Provider execution history
`GET/POST`	`/v1/org/api-keys`	Manage API keys
`GET/POST`	`/v1/notifications/channels`	Manage webhook/email/Slack channels
`GET`	`/v1/usage`	Usage against plan quotas
`GET`	`/v1/org/export`	Full workspace data export (GDPR)

Errors

Errors are JSON: {"error":"...","code":"plan_api_not_allowed"}. 4xx means fix the request (the code field is machine-readable — plan gates use plan_* codes); 429 means back off; 5xx means retry with exponential backoff and contact us with the X-Request-Id if it persists.

Prefer events over polling? Set up webhooks. Building with an AI assistant? Use the MCP server.

Last updated July 10, 2026 · Alync (alync.co)