Quickstart

1. Choose the API surface

Partner workspaces use /api/v1. Creator workspaces use /api/creators/v1. A key belongs to one account type and cannot be moved between them.

2. Authenticate

Pass the key as a Bearer token:

Partner

curl "https://workspace.passionfroot.me/api/v1/placements?limit=10" \
  -H "Authorization: Bearer $PASSIONFROOT_API_KEY"

Creator

curl "https://workspace.passionfroot.me/api/creators/v1/placements?limit=10" \
  -H "Authorization: Bearer $PASSIONFROOT_API_KEY"

Successful list responses contain data and pagination. Keep following pagination.nextCursor until pagination.hasMore is false.

3. Handle errors and limits

Every API error has the same JSON body: error.code is a stable reason to branch on, error.message says what to do next, and error.details appears only when there is something structured to act on, such as the invalid fields of a request.

{
  "error": {
    "code": "INVALID_QUERY_PARAMETER",
    "message": "Invalid query parameters",
    "details": [{ "field": "limit", "message": "Number must be less than or equal to 250" }]
  }
}

A path that does not exist answers 404 with NOT_FOUND. Treat 401 as an invalid or expired key, 429 as backpressure, and retry server failures only when the operation is safe. See rate limits and idempotency.

Start with a read endpoint and a small limit. Add write access only after your integration safely stores secrets and handles retries.

Overview

Core concepts

1. Choose the API surface

2. Authenticate

3. Handle errors and limits

​1. Choose the API surface

​2. Authenticate

​3. Handle errors and limits

1. Choose the API surface

2. Authenticate

3. Handle errors and limits