Developer platform

GroWrk exposes a public developer surface so you can automate the same work you do in the dashboard (placing orders, managing employees, searching inventory) from your own code, your terminal, or an AI assistant.

Everything lives at https://ai.growrk.com and is backed by one shared tool core. A single operation (for example, list orders or create employee) is defined once and reachable three ways:

  • v4 REST API: plain HTTPS with an X-API-KEY header. Best for backend integrations and scripts.
  • CLI (@growrk/cli): the growrk command, a thin HTTP client over the same v4 API. Best for people working in a terminal.
  • MCP server: a Model Context Protocol endpoint for AI tools (Claude, Cursor, ChatGPT, and other MCP clients). Best for AI-assisted workflows.

Because all three sit on top of the same core, they grow at the same rate: the CLI, a raw curl, and an AI agent reach the identical operations, with the identical permission checks.

                                ┌────────────────────────┐
  REST   curl / your backend ──▶│                        │
  CLI    growrk <resource>   ──▶│   one shared tool core │──▶ GroWrk
  MCP    Claude / Cursor / … ──▶│   (per-user scope)     │
                                └────────────────────────┘

When to use which

You want to…Use
Call GroWrk from a backend service, a webhook handler, or a cron jobREST API
Script one-off tasks or wire GroWrk into shell pipelines and CICLI
Let an AI assistant read and act on your GroWrk data conversationallyMCP

You don't have to pick just one. The same credentials and the same operations work everywhere, so you can prototype in the CLI and ship with REST, or expose MCP to your team while your services call REST directly.

One identity across every surface

Access is tied to your GroWrk user. Whichever surface you use, you act with your own role and permissions, across every company you administer. Two things set that up:

  • An API key (prefix grk_sk_) authenticates the REST API and the CLI, and can also authenticate MCP.
  • OAuth 2.1 is the interactive way to connect an MCP client (the "Sign in with GroWrk" flow).

See Authentication & API keys for how to mint a key and choose its capabilities.

Already using the v2 API?

The previous generation of the API, company-bound GW. keys against https://api.growrk.com/v2, is deprecated and shuts down on 1 Jan 2027. Existing keys keep working until then, but no new v2 keys can be created after that date.

There is no in-place upgrade: moving to v4 means minting a new user-bound grk_sk_ key. Start with Migrating from v2 to v4, which maps every api.* scope to its v4 capability and lists the contract changes. The most important is that v4 list endpoints page and cap at 50 records, where v2 returned everything.

Next steps

  • Authentication & API keys: mint a key, pick capabilities, understand org reach.
  • v4 REST API: the endpoint map, request/response format, and curl examples.
  • CLI: install @growrk/cli, log in, and run resource commands.
  • MCP: connect an AI tool over Streamable HTTP with OAuth 2.1 or an API key. For per-client setup steps covering Claude, ChatGPT, Cursor and custom agents, see connect.growrk.com.
  • Legacy v2 API: reference for the deprecated surface, until it shuts down.
  • Migrating from v2 to v4: scope mapping, contract changes, and the reissue checklist.