Skip to content

Developers

Growth Pilot API v1

Read and steer your Growth Loops, posts, A/B tests, missions and your AAARRR metrics, and push offline conversions (CRM closed-won deals, booked calls) into your customer journeys, through a key-authenticated REST API. Every resource is scoped to your organization. API access is part of the Enterprise plan.

Authentication

Generate a key in Settings β†’ API Keys (OWNER/ADMIN only). The key is shown only once, store it somewhere safe. Pass it in the header:

Authorization: Bearer gp_live_xxxxxxxxxxxxxxxxxxxxxxxx

A missing or invalid key returns 401. A resource that belongs to another organization returns 404 (never revealed).

Scopes: keys are read by default. Tick β€œAllow write” on creation to get the write scope (required for POST / PATCH), otherwise 403.

Base URL

https://growth-pilot.co/api/v1

Endpoints

get/loopsβ€” list the organization's Growth Loops
curl https://growth-pilot.co/api/v1/loops \
  -H "Authorization: Bearer gp_live_…"
get/loops/{id}β€” single Growth Loop detail
curl https://growth-pilot.co/api/v1/loops/LOOP_ID \
  -H "Authorization: Bearer gp_live_…"
get/metricsβ€” snapshot of the 6 AAARRR metrics
curl https://growth-pilot.co/api/v1/metrics \
  -H "Authorization: Bearer gp_live_…"

# Response:
{
  "data": {
    "awareness.users": 202,
    "acquisition.newUsers": 184,
    "activation.rate": 51,
    "retention.stickiness": 38,
    "referral.kFactor": 0.84,
    "revenue.mrr": 4280
  },
  "meta": { "isMock": { "revenue.mrr": false } }
}
post/loopsβ€” create a loop from a template (write scope)
curl -X POST https://growth-pilot.co/api/v1/loops \
  -H "Authorization: Bearer gp_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": "My loop", "type": "VIRAL" }'

# type ∈ VIRAL | PAID | CONTENT | PRODUCT
patch/loops/{id}β€” update name and/or status (write scope)
curl -X PATCH https://growth-pilot.co/api/v1/loops/LOOP_ID \
  -H "Authorization: Bearer gp_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Renamed", "status": "ACTIVE" }'

# status ∈ DRAFT | ACTIVE | PAUSED | ARCHIVED
get/postsβ€” list CMS posts
post/postsβ€” create a draft post: { title, content } (write scope)
get/testsβ€” list A/B tests
post/testsβ€” create a test + variants: { name, hypothesis, variants[] } (write scope)
get/missionsβ€” list missions (agile projects)
post/missionsβ€” create a mission: { name, description? } (write scope)

Every resource (loops, posts, tests, missions) also exposes GET /:id (detail) and PATCH /:id (update, write scope).

post/journeys/conversionsβ€” record an offline conversion (CRM closed-won, booked call) on the lead's journey (write scope, Enterprise)
curl -X POST https://growth-pilot.co/api/v1/journeys/conversions \
  -H "Authorization: Bearer gp_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "email": "jane@acme.com", "kind": "CLOSED_WON", "valueCents": 490000 }'

# kind ∈ LEAD | SIGNUP | CALL_BOOKED | CLOSED_WON | CUSTOM
# optional: name (string), occurredAt (ISO 8601), valueCents (int β‰₯ 0)
# The lead is matched by email (created if unknown) and its journey
# gets a CONVERSION touchpoint. Returns 201 with { data: { leadId,
# conversionId, leadCreated, kind, valueCents, occurredAt } }.

Outbound webhooks

Configure endpoints in Settings β†’ Webhooks. On each subscribed event, Growth Pilot POSTs an HMAC-SHA256 signed payload. Events: alert.triggered, checkout.completed, loop.created, loop.published, post.published.

POST https://ton-endpoint
X-GrowthPilot-Event: checkout.completed
X-GrowthPilot-Signature: sha256=<hmac_hex>

{
  "type": "checkout.completed",
  "createdAt": "2026-05-31T09:00:00.000Z",
  "data": { "plan": "PRO" }
}

Verify authenticity by recomputing the HMAC of the raw body with the endpoint secret:

import crypto from "node:crypto";

const expected =
  "sha256=" +
  crypto.createHmac("sha256", WEBHOOK_SECRET).update(rawBody).digest("hex");
// compare `expected` to the X-GrowthPilot-Signature header
// (ideally with crypto.timingSafeEqual)

OpenAPI spec

Machine-readable specification (for client SDK generation): /api/v1/openapi

API v1 read and write (loops, posts, tests, missions) + AAARRR metrics + offline conversions for customer journeys + signed outbound webhooks + MCP server (see the mcp-server/ folder) to pilot Growth Pilot from your agent.