Guides

Compatible with Growi's API

What matches Growi's published API, what is ours, and the few places the answers differ.

Switching

Change the base URL and the key. Code, scripts and mirrors written for Growi's public API run against Growth Dept Creator unchanged.

- https://api.growi.io/api/public/v1
+ https://creator.growthdept.ai/api/public/v1

To bring your existing campaigns, creators and history across, use the import from Growi.

What matches

  • Paths and operations: every operation in Growi's two published OpenAPI documents, 128 in all (86 in the main document and 42 for TikTok Shop).
  • Parameters, field names, enums and envelopes, taken from those documents.
  • Pagination (page, per_page, meta), money in integer cents, dates as each endpoint documents them, and the older endpoints' MM/DD/YYYY.
  • Limits: 40 requests an hour per key, 2 seconds apart, with the same headers and 429 body.
  • Webhook event names and payloads, including idempotency_key and attribution.
  • Klaviyo profile properties (growi_ambassador and the rest) and the Stripe metadata key growi_affiliate_code.
  • MCP tool names, so prompts written for Growi's MCP server keep working.

What is ours

  • A signature on every webhook: X-GD-Signature, an HMAC-SHA256 with the destination's secret (checking signatures).
  • The import endpoints, GET and POST /api/v1/organizations/{brand}/growi_import.
  • The dashboard API (/api/v1, /api/v2, /api/v3) is open to API keys, not only to the web app (list).
  • A brand can ask for a higher hourly limit.

Where answers differ

  • POST /affiliate_sales answers 201 for a new sale and 200 when the order_id already exists for that platform, with the same body.
  • /stats/transactions sends created as Unix seconds, as the document types it, and adds created_formatted ("Nov 11, 2026").
  • affiliate_age, affiliate_gender, affiliate_location and discord_id are null when the creator never gave them.
  • campaign_affiliates rows add revenue_generated_raw (cents), affiliate_amount_paid, unique_link_clicks, link_clicks, user_content_count, total_views and campaign_type.
  • Reads that Growi makes live against TikTok on every call (settlement statements, shop health, catalog, analytics and others) answer from the TikTok Shop connection's last answer for that request.
  • Endpoints whose data comes from a connection the brand has not switched on answer empty results in the documented shape.