Getting Started

Get up and running with the Share.cy API in 5 minutes.

1. Create an API Key

Go to Settings → API Keys and click "Create Key". Choose your scopes:

  • Read — View posts, analytics, accounts
  • Write — Create/edit posts, manage library
  • Publish — Publish and schedule posts

Save your key immediately — it won't be shown again.

2. Make Your First Request

Fetch your posts:

curl -H "Authorization: Bearer shcy_live_YOUR_KEY" \
  https://share.cy/api/v1/posts

3. Create a Post

Create and schedule a new post:

curl -X POST https://share.cy/api/v1/posts \
  -H "Authorization: Bearer shcy_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"content": "Hello from the API!", "platforms": ["twitter", "linkedin"], "status": "draft"}'

4. Error Handling

All errors return a consistent JSON format:

{
  "error": "Missing required scope: publish"
}

// HTTP Status Codes:
// 200 — Success
// 201 — Created
// 400 — Bad Request (invalid input)
// 401 — Unauthorized (invalid/missing API key)
// 403 — Forbidden (missing scope or plan limit)
// 404 — Not Found
// 429 — Rate Limited
// 500 — Server Error

5. Key Rotation

You can rotate API keys in Settings. When rotated, the old key remains valid for 1 hour (grace period) to allow you to update your integrations.