API Quick Start

1. Create an account

Sign up for a Shipchart account if you don't have one. You'll need a verified account to generate API tokens.

2. Generate an API token

Go to Settings → API Tokens and click Create Token.

Choose a name (e.g. "Claude Code") and select the permissions you need:

• readQuery projects, revenue, ideas, check-ins, and integrations
• writeCreate and update projects, revenue entries, check-ins, and ideas
• deleteArchive projects, delete revenue entries and ideas
• syncTrigger manual syncs for connected integrations (e.g. Stripe)

3. Test it

Make a quick request to the health check endpoint to verify your token works:

curl -H "Authorization: Bearer YOUR_TOKEN_HERE" \
     -H "Accept: application/json" \
     https://shipchart.app/api/v1/ping

You should get back:

{
  "status": "ok",
  "user": "Your Name"
}

4. Keep your token safe

Treat API tokens like passwords:

• Don't commit tokens to git
• Use environment variables to store them
• Revoke tokens you're no longer using
• Use the minimum permissions needed