OpenAPI Reference
The machine-readable OpenAPI 3.1 spec, plus a generated index of every endpoint on the Amba API.
The entire Amba API surface is described by an OpenAPI 3.1 document that is generated directly from the live route registrations — every path, method, and auth requirement below comes from the same source of truth the API itself runs on, so this page cannot drift from reality.
Machine-readable spec
| URL | What it is |
|---|---|
https://api.amba.dev/openapi.json | Live spec, served by the API itself. Always current. |
/openapi.json | Static snapshot bundled with these docs (same document). |
Both URLs are public — no API key required — and CORS-open, so agents, SDK generators, and tooling can fetch them from anywhere:
An interactive explorer for the same spec lives at
https://api.amba.dev/docs.
Reading the auth column
| Auth value | Send |
|---|---|
| Developer Bearer | Authorization: Bearer <developer-token> (from /v1/auth/developer/login or a PAT) |
| X-Api-Key | X-Api-Key: <client-api-key> |
| X-Api-Key + Session Bearer | Both headers — the session token comes from the /v1/client/auth/* flows |
| Optional … | The endpoint works unauthenticated; auth unlocks more |
Hand-written guides with request/response examples live in the Admin, Client, Developer Auth, and Webhooks sections. The index below is the exhaustive map.
Endpoint index
593 endpoints across 98 groups, generated from the live route registrations.
Auth · Developer
| Method | Path | Auth | Summary |
|---|---|---|---|
POST | /v1/auth/developer/claim | Developer Bearer | Claim an unverified account with a real email |
GET | /v1/auth/developer/claim/confirm | Optional Developer Bearer | |
GET | /v1/auth/developer/github/callback | Optional Developer Bearer | |
GET | /v1/auth/developer/github/start | Optional Developer Bearer | |
POST | /v1/auth/developer/login | Optional Developer Bearer | Log in a developer account |
POST | /v1/auth/developer/logout | Optional Developer Bearer | Revoke a developer refresh token |
GET | /v1/auth/developer/me | Developer Bearer | Get the authenticated developer |
POST | /v1/auth/developer/pat/rotate | Developer Bearer | Rotate the developer Personal Access Token |
POST | /v1/auth/developer/refresh | Optional Developer Bearer | Rotate developer session + refresh tokens |
POST | /v1/auth/developer/signup | Optional Developer Bearer | Sign up a developer account |
GET | /v1/auth/developer/verify | Optional Developer Bearer | |
POST | /v1/auth/developer/verify | Optional Developer Bearer |
Client · Achievements
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/achievements | X-Api-Key + Session Bearer | |
GET | /v1/client/achievements/{achievementId} | X-Api-Key + Session Bearer | |
GET | /v1/client/achievements/progress | X-Api-Key + Session Bearer |
Client · AI
| Method | Path | Auth | Summary |
|---|---|---|---|
POST | /v1/client/ai/anthropic/messages | X-Api-Key + Session Bearer | |
POST | /v1/client/ai/mistral/chat/completions | X-Api-Key + Session Bearer | |
POST | /v1/client/ai/openai/chat/completions | X-Api-Key + Session Bearer | |
POST | /v1/client/ai/prompts/{name}/invoke | X-Api-Key + Session Bearer |
Client · App MCP
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/app-mcp/manifest | X-Api-Key |
Client · Auth
| Method | Path | Auth | Summary |
|---|---|---|---|
POST | /v1/client/auth/anonymous | X-Api-Key | Create an anonymous session |
POST | /v1/client/auth/email-otp/request | X-Api-Key | |
POST | /v1/client/auth/email-otp/verify | X-Api-Key | |
POST | /v1/client/auth/email/login | X-Api-Key | Log in with email + password |
POST | /v1/client/auth/email/signup | X-Api-Key | Sign up with email + password |
GET | /v1/client/auth/identifiers | X-Api-Key | |
POST | /v1/client/auth/link | X-Api-Key | Link a social identity to the current session |
POST | /v1/client/auth/logout | X-Api-Key | Revoke a refresh token |
POST | /v1/client/auth/magic-link/request | X-Api-Key | Request a magic-link sign-in email |
POST | /v1/client/auth/magic-link/verify | X-Api-Key | Exchange a magic-link token for a session |
GET | /v1/client/auth/me | X-Api-Key | Get the authenticated app user |
POST | /v1/client/auth/refresh | X-Api-Key | Rotate session + refresh tokens |
POST | /v1/client/auth/sms-otp/request | X-Api-Key | |
POST | /v1/client/auth/sms-otp/verify | X-Api-Key | |
POST | /v1/client/auth/social | X-Api-Key | Sign in with Apple or Google |
POST | /v1/client/auth/unlink | X-Api-Key |
Client · Catalog
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/catalog | X-Api-Key + Session Bearer | |
GET | /v1/client/catalog/{itemId} | X-Api-Key + Session Bearer |
Client · Challenges
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/challenges | X-Api-Key + Session Bearer | |
GET | /v1/client/challenges/{challengeId} | X-Api-Key + Session Bearer | |
POST | /v1/client/challenges/{challengeId}/claim | X-Api-Key + Session Bearer | |
POST | /v1/client/challenges/{challengeId}/join | X-Api-Key + Session Bearer | |
GET | /v1/client/challenges/{challengeId}/progress | X-Api-Key + Session Bearer | |
GET | /v1/client/challenges/active | X-Api-Key + Session Bearer | |
GET | /v1/client/challenges/mine | X-Api-Key + Session Bearer |
Client · Collections
| Method | Path | Auth | Summary |
|---|---|---|---|
DELETE | /v1/client/collections/{name} | X-Api-Key + Session Bearer | Bulk-delete rows in a collection |
GET | /v1/client/collections/{name} | X-Api-Key + Session Bearer | List rows in a collection |
PATCH | /v1/client/collections/{name} | X-Api-Key + Session Bearer | Bulk-update rows in a collection |
POST | /v1/client/collections/{name} | X-Api-Key + Session Bearer | Insert a row into a collection |
DELETE | /v1/client/collections/{name}/{id} | X-Api-Key + Session Bearer | Delete a single row |
GET | /v1/client/collections/{name}/{id} | X-Api-Key + Session Bearer | Get a single row |
PATCH | /v1/client/collections/{name}/{id} | X-Api-Key + Session Bearer | Update a single row |
POST | /v1/client/collections/{name}/{id}/restore | X-Api-Key + Session Bearer | |
POST | /v1/client/collections/{name}/aggregate | X-Api-Key + Session Bearer | |
POST | /v1/client/collections/{name}/batch | X-Api-Key + Session Bearer | |
GET | /v1/client/collections/{name}/count | X-Api-Key + Session Bearer | Count rows in a collection |
POST | /v1/client/collections/{name}/delete_many | X-Api-Key + Session Bearer | |
POST | /v1/client/collections/{name}/find | X-Api-Key + Session Bearer | Query rows in a collection |
POST | /v1/client/collections/{name}/find-nearest | X-Api-Key + Session Bearer | Vector similarity search |
POST | /v1/client/collections/{name}/nearest | X-Api-Key + Session Bearer | |
POST | /v1/client/collections/{name}/update_many | X-Api-Key + Session Bearer | |
POST | /v1/client/collections/transaction | X-Api-Key + Session Bearer | Run an atomic multi-collection transaction |
Client · Config
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/config | X-Api-Key | Get public project configuration |
Client · Content
| Method | Path | Auth | Summary |
|---|---|---|---|
DELETE | /v1/client/content/items/{itemId} | X-Api-Key + Session Bearer | |
GET | /v1/client/content/items/{itemId} | X-Api-Key + Session Bearer | |
PATCH | /v1/client/content/items/{itemId} | X-Api-Key + Session Bearer | |
GET | /v1/client/content/libraries/{libraryId} | X-Api-Key + Session Bearer | |
POST | /v1/client/content/libraries/{libraryId}/items | X-Api-Key + Session Bearer | |
GET | /v1/client/content/libraries/{libraryId}/keys/{contentKey} | X-Api-Key + Session Bearer | |
GET | /v1/client/content/today | X-Api-Key + Session Bearer | |
GET | /v1/client/content/today/{channel} | X-Api-Key + Session Bearer |
Client · Currencies
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/currencies | X-Api-Key + Session Bearer | |
GET | /v1/client/currencies/transactions | X-Api-Key + Session Bearer |
Client · Deep Links
| Method | Path | Auth | Summary |
|---|---|---|---|
POST | /v1/client/deep-links/click | X-Api-Key + Session Bearer | |
GET | /v1/client/deep-links/config | X-Api-Key + Session Bearer | |
GET | /v1/client/deep-links/resolve/{slug} | X-Api-Key + Session Bearer |
Client · Dev
| Method | Path | Auth | Summary |
|---|---|---|---|
POST | /v1/client/dev/reset-sandbox | X-Api-Key |
Client · Diagnostics
| Method | Path | Auth | Summary |
|---|---|---|---|
POST | /v1/client/diagnostics/ping | X-Api-Key |
Client · Email
| Method | Path | Auth | Summary |
|---|---|---|---|
POST | /v1/client/email/send | X-Api-Key + Session Bearer | Send a transactional email to the authenticated user |
Client · Entitlements
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/entitlements | X-Api-Key + Session Bearer | |
POST | /v1/client/entitlements/restore | X-Api-Key + Session Bearer |
Client · Events
| Method | Path | Auth | Summary |
|---|---|---|---|
POST | /v1/client/events | X-Api-Key + Session Bearer | Track an analytics event |
POST | /v1/client/events/explain | X-Api-Key |
Client · Experiments
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/experiments/{key}/assignment | X-Api-Key + Session Bearer | |
POST | /v1/client/experiments/{key}/exposure | X-Api-Key + Session Bearer |
Client · Feeds
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/feeds | X-Api-Key + Session Bearer | |
GET | /v1/client/feeds/{feedKey} | X-Api-Key + Session Bearer | |
GET | /v1/client/feeds/group/{groupId} | X-Api-Key + Session Bearer | |
GET | /v1/client/feeds/me | X-Api-Key + Session Bearer |
Client · Flags
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/flags | X-Api-Key + Session Bearer | |
GET | /v1/client/flags/{key} | X-Api-Key + Session Bearer |
Client · Friends
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/friends | X-Api-Key + Session Bearer | |
DELETE | /v1/client/friends/{friendshipId} | X-Api-Key + Session Bearer | |
POST | /v1/client/friends/{friendshipId}/accept | X-Api-Key + Session Bearer | |
POST | /v1/client/friends/{friendshipId}/block | X-Api-Key + Session Bearer | |
POST | /v1/client/friends/{friendshipId}/reject | X-Api-Key + Session Bearer | |
POST | /v1/client/friends/{friendshipId}/unblock | X-Api-Key + Session Bearer | |
POST | /v1/client/friends/block | X-Api-Key + Session Bearer | |
DELETE | /v1/client/friends/by-user/{userId} | X-Api-Key + Session Bearer | |
GET | /v1/client/friends/pending | X-Api-Key + Session Bearer | |
POST | /v1/client/friends/request | X-Api-Key + Session Bearer | |
POST | /v1/client/friends/unblock | X-Api-Key + Session Bearer |
Client · Groups
| Method | Path | Auth | Summary |
|---|---|---|---|
POST | /v1/client/groups | X-Api-Key + Session Bearer | |
DELETE | /v1/client/groups/{groupId} | X-Api-Key + Session Bearer | |
GET | /v1/client/groups/{groupId} | X-Api-Key + Session Bearer | |
PATCH | /v1/client/groups/{groupId} | X-Api-Key + Session Bearer | |
POST | /v1/client/groups/{groupId}/invite | X-Api-Key + Session Bearer | |
POST | /v1/client/groups/{groupId}/join | X-Api-Key + Session Bearer | Join a group |
POST | /v1/client/groups/{groupId}/leave | X-Api-Key + Session Bearer | Leave a group |
GET | /v1/client/groups/{groupId}/members | X-Api-Key + Session Bearer | |
GET | /v1/client/groups/mine | X-Api-Key + Session Bearer | |
GET | /v1/client/groups/search | X-Api-Key + Session Bearer |
Client · Inventory
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/inventory | X-Api-Key + Session Bearer | |
GET | /v1/client/inventory/{itemId} | X-Api-Key + Session Bearer | |
POST | /v1/client/inventory/{itemId}/consume | X-Api-Key + Session Bearer | |
POST | /v1/client/inventory/purchase | X-Api-Key + Session Bearer |
Client · Leaderboards
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/leaderboards | X-Api-Key + Session Bearer | |
GET | /v1/client/leaderboards/{leaderboardId} | X-Api-Key + Session Bearer | |
GET | /v1/client/leaderboards/{leaderboardId}/entries | X-Api-Key + Session Bearer | |
GET | /v1/client/leaderboards/{leaderboardId}/me | X-Api-Key + Session Bearer |
Client · Leagues
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/leagues/me | X-Api-Key + Session Bearer | |
GET | /v1/client/leagues/me/cohort | X-Api-Key + Session Bearer |
Client · Media
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/media | X-Api-Key + Session Bearer | |
DELETE | /v1/client/media/{assetId} | X-Api-Key + Session Bearer | |
GET | /v1/client/media/{assetId} | X-Api-Key + Session Bearer | |
GET | /v1/client/media/catalogs/{slug} | X-Api-Key | |
POST | /v1/client/media/commit | X-Api-Key + Session Bearer | |
POST | /v1/client/media/presign | X-Api-Key + Session Bearer | |
POST | /v1/client/media/upload | X-Api-Key + Session Bearer |
Client · Messaging
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/messaging/conversations | X-Api-Key + Session Bearer | |
POST | /v1/client/messaging/conversations | X-Api-Key + Session Bearer | |
GET | /v1/client/messaging/conversations/{conversationId}/messages | X-Api-Key + Session Bearer | |
POST | /v1/client/messaging/conversations/{conversationId}/messages | X-Api-Key + Session Bearer | |
DELETE | /v1/client/messaging/conversations/{conversationId}/messages/{messageId}/reactions | X-Api-Key + Session Bearer | |
GET | /v1/client/messaging/conversations/{conversationId}/messages/{messageId}/reactions | X-Api-Key + Session Bearer | |
POST | /v1/client/messaging/conversations/{conversationId}/messages/{messageId}/reactions | X-Api-Key + Session Bearer | |
GET | /v1/client/messaging/conversations/{conversationId}/messages/{messageId}/receipts | X-Api-Key + Session Bearer | |
POST | /v1/client/messaging/conversations/{conversationId}/participants | X-Api-Key + Session Bearer | |
POST | /v1/client/messaging/conversations/{conversationId}/read | X-Api-Key + Session Bearer | |
POST | /v1/client/messaging/conversations/{conversationId}/typing | X-Api-Key + Session Bearer |
Client · Moderation
| Method | Path | Auth | Summary |
|---|---|---|---|
POST | /v1/client/moderation/report | X-Api-Key + Session Bearer | |
GET | /v1/client/moderation/reports | X-Api-Key + Session Bearer | |
GET | /v1/client/moderation/reports/{reportId} | X-Api-Key + Session Bearer | |
POST | /v1/client/moderation/reports/content | X-Api-Key + Session Bearer | |
POST | /v1/client/moderation/reports/users | X-Api-Key + Session Bearer |
Client · Offerings
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/offerings | X-Api-Key + Session Bearer |
Client · Onboarding
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/onboarding | X-Api-Key + Session Bearer | |
POST | /v1/client/onboarding/{flowId}/advance | X-Api-Key + Session Bearer | |
POST | /v1/client/onboarding/{flowId}/complete | X-Api-Key + Session Bearer | |
POST | /v1/client/onboarding/{flowId}/skip | X-Api-Key + Session Bearer | |
POST | /v1/client/onboarding/{flowId}/start | X-Api-Key + Session Bearer | |
POST | /v1/client/onboarding/complete | X-Api-Key + Session Bearer | |
POST | /v1/client/onboarding/next | X-Api-Key + Session Bearer | |
POST | /v1/client/onboarding/skip | X-Api-Key + Session Bearer | |
GET | /v1/client/onboarding/status | X-Api-Key + Session Bearer |
Client · Payments
| Method | Path | Auth | Summary |
|---|---|---|---|
POST | /v1/client/payments/intents | X-Api-Key | |
GET | /v1/client/payments/intents/{id} | X-Api-Key |
Client · Push
| Method | Path | Auth | Summary |
|---|---|---|---|
POST | /v1/client/push/register | X-Api-Key + Session Bearer | Register a device push token |
POST | /v1/client/push/subscribe | X-Api-Key + Session Bearer | |
GET | /v1/client/push/tokens | X-Api-Key + Session Bearer | |
POST | /v1/client/push/unregister | X-Api-Key + Session Bearer | Unregister a device push token |
POST | /v1/client/push/unsubscribe | X-Api-Key + Session Bearer |
Client · Realtime
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/realtime/collections/{collectionId} | X-Api-Key + Session Bearer | |
GET | /v1/client/realtime/conversations/{conversationId} | X-Api-Key + Session Bearer | |
GET | /v1/client/realtime/gamification | X-Api-Key + Session Bearer |
Client · Referrals
| Method | Path | Auth | Summary |
|---|---|---|---|
POST | /v1/client/referrals | X-Api-Key + Session Bearer | |
POST | /v1/client/referrals/claim | X-Api-Key + Session Bearer | |
GET | /v1/client/referrals/my-code | X-Api-Key + Session Bearer |
Client · Reviews
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/reviews | X-Api-Key + Session Bearer | |
POST | /v1/client/reviews | X-Api-Key + Session Bearer | |
DELETE | /v1/client/reviews/{reviewId} | X-Api-Key + Session Bearer | |
PATCH | /v1/client/reviews/{reviewId} | X-Api-Key + Session Bearer | |
GET | /v1/client/reviews/item/{itemType}/{itemId} | X-Api-Key + Session Bearer | |
GET | /v1/client/reviews/mine | X-Api-Key + Session Bearer |
Client · Roles
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/roles | X-Api-Key + Session Bearer | |
GET | /v1/client/roles/check | X-Api-Key + Session Bearer | |
GET | /v1/client/roles/check/{permission} | X-Api-Key + Session Bearer | |
GET | /v1/client/roles/me | X-Api-Key + Session Bearer | |
GET | /v1/client/roles/permissions | X-Api-Key + Session Bearer |
Client · Sessions
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/sessions | X-Api-Key + Session Bearer | |
POST | /v1/client/sessions/{sessionId}/end | X-Api-Key + Session Bearer | |
GET | /v1/client/sessions/active | X-Api-Key + Session Bearer | |
POST | /v1/client/sessions/end | X-Api-Key + Session Bearer | |
POST | /v1/client/sessions/heartbeat | X-Api-Key + Session Bearer | |
POST | /v1/client/sessions/start | X-Api-Key + Session Bearer |
Client · Stores
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/stores | X-Api-Key + Session Bearer | |
GET | /v1/client/stores/{storeId} | X-Api-Key + Session Bearer | |
GET | /v1/client/stores/{storeKey}/options | X-Api-Key + Session Bearer | |
POST | /v1/client/stores/{storeKey}/purchase | X-Api-Key + Session Bearer |
Client · Streaks
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/streaks | X-Api-Key + Session Bearer | |
POST | /v1/client/streaks/{streakId}/qualify | X-Api-Key + Session Bearer | Mark a streak day as qualified |
Client · Sync
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/sync | X-Api-Key + Session Bearer | |
POST | /v1/client/sync | X-Api-Key + Session Bearer |
Client · Users
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/users/{id} | X-Api-Key + Session Bearer | |
PATCH | /v1/client/users/{id} | X-Api-Key + Session Bearer | |
GET | /v1/client/users/me | X-Api-Key + Session Bearer | Get the authenticated app user |
PATCH | /v1/client/users/me | X-Api-Key + Session Bearer | Update the authenticated app user |
DELETE | /v1/client/users/me/push-token | X-Api-Key + Session Bearer | |
POST | /v1/client/users/me/push-token | X-Api-Key + Session Bearer |
Client · XP
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/client/xp | X-Api-Key + Session Bearer | |
POST | /v1/client/xp/claim | X-Api-Key + Session Bearer | |
GET | /v1/client/xp/config | X-Api-Key + Session Bearer | |
GET | /v1/client/xp/history | X-Api-Key + Session Bearer | |
GET | /v1/client/xp/rules | X-Api-Key + Session Bearer |
Admin · Achievements
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/achievements | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/achievements | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/achievements/{achievementId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/achievements/{achievementId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/achievements/{achievementId} | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/achievements/{achievementId}/grant | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/achievements/{achievementId}/revoke | Developer Bearer |
Admin · AI
| Method | Path | Auth | Summary |
|---|---|---|---|
POST | /v1/admin/projects/{projectId}/ai/embeddings | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/ai/messages | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/ai/prompts | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/ai/prompts | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/ai/prompts/{name} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/ai/prompts/{name} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/ai/prompts/{name}/budget | Developer Bearer | |
PUT | /v1/admin/projects/{projectId}/ai/prompts/{name}/budget | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/ai/prompts/{name}/spend | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/ai/providers | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/ai/providers | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/ai/providers/{name} | Developer Bearer |
Admin · Analytics
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/analytics | Developer Bearer |
Admin · App MCP
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/app-mcp/config | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/app-mcp/config | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/app-mcp/exposure | Developer Bearer | |
PUT | /v1/admin/projects/{projectId}/app-mcp/exposure | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/app-mcp/manifest | Developer Bearer |
Admin · Audit Events
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/audit-events | Developer Bearer | List audit events |
POST | /v1/admin/projects/{projectId}/audit-events | Developer Bearer | Append an audit event |
Admin · Billing
| Method | Path | Auth | Summary |
|---|---|---|---|
PUT | /v1/admin/projects/{projectId}/billing/ceiling | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/billing/checkout | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/billing/portal | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/billing/status | Developer Bearer |
Admin · Builds
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/builds | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/builds | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/builds/{buildId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/builds/{buildId} | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/builds/{buildId}/accept | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/builds/{buildId}/iterate | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/builds/{buildId}/iterations | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/builds/{buildId}/resume | Developer Bearer |
Admin · Catalog
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/catalog | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/catalog | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/catalog/{itemId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/catalog/{itemId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/catalog/{itemId} | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/catalog/{itemId}/bundle | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/catalog/{itemId}/bundle/{contentItemId} | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/catalog/{itemId}/prices | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/catalog/{itemId}/prices/{currencyCode} | Developer Bearer |
Admin · Challenges
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/challenges | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/challenges | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/challenges/{challengeId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/challenges/{challengeId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/challenges/{challengeId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/challenges/{challengeId}/participants | Developer Bearer |
Admin · Collections
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/collections | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/collections | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/collections/{name} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/collections/{name} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/collections/{name} | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/collections/{name}/data | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/collections/{name}/migrations | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/collections/{name}/rows | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/collections/{name}/rows | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/collections/{name}/rows | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/collections/{name}/rows | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/collections/{name}/rows:batch | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/collections/{name}/rows/{id} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/collections/{name}/rows/{id} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/collections/{name}/rows/{id} | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/collections/{name}/rows/aggregate | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/collections/{name}/rows/count | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/collections/transaction | Developer Bearer |
Admin · Config
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/config | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/config | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/config/{key} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/config/{key} | Developer Bearer |
Admin · Content
| Method | Path | Auth | Summary |
|---|---|---|---|
DELETE | /v1/admin/projects/{projectId}/content/items/{itemId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/content/items/{itemId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/content/items/{itemId}/translations | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/content/items/{itemId}/translations/{language} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/content/items/{itemId}/translations/{language} | Developer Bearer | |
PUT | /v1/admin/projects/{projectId}/content/items/{itemId}/translations/{language} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/content/libraries | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/content/libraries | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/content/libraries/{libraryId} | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/content/libraries/{libraryId}/bulk | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/content/libraries/{libraryId}/items | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/content/libraries/{libraryId}/items | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/content/libraries/{libraryId}/items/{contentKey}/versions | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/content/libraries/{libraryId}/items/{contentKey}/versions | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/content/libraries/{libraryId}/items/{contentKey}/versions/{version} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/content/schedules | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/content/schedules | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/content/schedules/{scheduleId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/content/schedules/{scheduleId} | Developer Bearer |
Admin · Control-plane Webhooks
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/control-webhooks | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/control-webhooks | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/control-webhooks/{id} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/control-webhooks/{id} | Developer Bearer |
Admin · Currencies
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/currencies | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/currencies | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/currencies/{currencyId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/currencies/{currencyId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/currencies/balances/{userId} | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/currencies/grant | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/currencies/spend | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/currencies/transactions/{userId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/currency-grant-rules | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/currency-grant-rules | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/currency-grant-rules/{ruleId} | Developer Bearer |
Admin · Deep Links
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/deep-links/config | Developer Bearer | |
PUT | /v1/admin/projects/{projectId}/deep-links/config | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/deep-links/tracked | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/deep-links/tracked | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/deep-links/tracked/{linkId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/deep-links/tracked/{linkId}/stats | Developer Bearer |
Admin · Domains
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/domains | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/domains/{domain} | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/domains/check | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/domains/purchase | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/domains/search | Developer Bearer |
Admin · Email
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/email/deliveries | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/email/deliveries/{id} | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/email/send | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/email/suppressions | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/email/suppressions | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/email/suppressions/{email} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/email/templates | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/email/templates | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/email/templates/{name} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/email/templates/{name} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/email/templates/{name} | Developer Bearer |
Admin · Events
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/events | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/events | Developer Bearer | Server-side track event |
GET | /v1/admin/projects/{projectId}/events/count | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/events/explain | Developer Bearer |
Admin · Experiments
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/experiments | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/experiments | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/experiments/{key} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/experiments/{key} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/experiments/{key} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/experiments/{key}/results | Developer Bearer |
Admin · Fan-out
| Method | Path | Auth | Summary |
|---|---|---|---|
POST | /v1/admin/projects/{projectId}/fan-out/segment | Developer Bearer |
Admin · Feeds
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/feeds/items | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/feeds/items/{itemId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/feeds/rules | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/feeds/rules | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/feeds/rules/{ruleId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/feeds/rules/{ruleId} | Developer Bearer |
Admin · Friends
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/friends | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/friends/{friendshipId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/friends/stats | Developer Bearer |
Admin · Function Credentials
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/internal-credentials | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/internal-credentials/rotate | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/internal-credentials/rotations | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/internal-credentials/rotations/{rotationId}/rollback | Developer Bearer |
Admin · Function Secrets
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/secrets | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/secrets | Developer Bearer | Set a function secret |
DELETE | /v1/admin/projects/{projectId}/secrets/{name} | Developer Bearer | Delete a function secret |
GET | /v1/admin/projects/{projectId}/secrets/sync | Developer Bearer |
Admin · Functions
| Method | Path | Auth | Summary |
|---|---|---|---|
DELETE | /v1/admin/projects/{projectId}/functions/{name} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/functions/{name}/logs | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/functions/deploy | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/functions/deployments | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/functions/deployments | Developer Bearer | Record a new function deployment |
POST | /v1/admin/projects/{projectId}/functions/deployments/{id}/disable | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/functions/deployments/{id}/promote | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/functions/namespace | Developer Bearer | Get the function dispatch namespace + bucket bindings |
GET | /v1/admin/projects/{projectId}/functions/schedules | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/functions/schedules | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/functions/schedules/{functionName} | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/functions/schedules/{functionName}/pause | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/functions/schedules/{functionName}/resume | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/functions/schedules/{functionName}/trigger | Developer Bearer |
Admin · Funnels
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/funnels | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/funnels | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/funnels/{funnelId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/funnels/{funnelId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/funnels/{funnelId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/funnels/{funnelId}/query | Developer Bearer |
Admin · Groups
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/groups | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/groups | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/groups/{groupId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/groups/{groupId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/groups/{groupId}/members | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/groups/{groupId}/members/{memberId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/groups/{groupId}/members/{memberId} | Developer Bearer |
Admin · Integrations
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/integrations | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/integrations | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/integrations/{provider} | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/integrations/{provider}/test | Developer Bearer |
Admin · Inventory
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/inventory/{userId} | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/inventory/grant | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/inventory/revoke | Developer Bearer |
Admin · Invites & Members
| Method | Path | Auth | Summary |
|---|---|---|---|
POST | /v1/admin/invites/accept | Developer Bearer | |
POST | /v1/admin/invites/decline | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/invites | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/invites | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/invites/{inviteId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/members | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/members/{developerId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/members/{developerId} | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/transfer-ownership | Developer Bearer |
Admin · Leaderboards
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/leaderboards | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/leaderboards | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/leaderboards/{leaderboardId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/leaderboards/{leaderboardId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/leaderboards/{leaderboardId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/leaderboards/{leaderboardId}/entries | Developer Bearer |
Admin · Leagues
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/leagues | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/leagues | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/leagues/{leagueId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/leagues/{leagueId}/cohorts/current | Developer Bearer |
Admin · Media
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/media | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/media | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/media/{assetId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/media/catalogs | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/media/catalogs | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/media/catalogs/{catalogId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/media/catalogs/{catalogId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/media/catalogs/{catalogId} | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/media/catalogs/{catalogId}/items | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/media/catalogs/{catalogId}/items/{mediaId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/media/catalogs/{catalogId}/items/reorder | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/media/folders | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/media/folders | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/media/folders/{folderId} | Developer Bearer |
Admin · Messaging
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/messaging/conversations | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/messaging/conversations | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/messaging/conversations/{conversationId}/messages | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/messaging/conversations/{conversationId}/participants | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/messaging/conversations/{conversationId}/participants/{userId} | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/messaging/messages/{messageId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/messaging/stats | Developer Bearer |
Admin · Moderation
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/moderation/queue | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/moderation/queue/{itemId}/approve | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/moderation/queue/{itemId}/escalate | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/moderation/queue/{itemId}/reject | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/moderation/rules | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/moderation/rules | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/moderation/rules/{ruleId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/moderation/rules/{ruleId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/moderation/trust | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/moderation/trust | Developer Bearer |
Admin · Monetization
| Method | Path | Auth | Summary |
|---|---|---|---|
POST | /v1/admin/projects/{projectId}/monetization/adopt | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/monetization/apply | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/monetization/definitions | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/monetization/drift | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/monetization/export | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/monetization/plan | Developer Bearer |
Admin · Onboarding
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/onboarding/flows | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/onboarding/flows | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/onboarding/flows/{flowId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/onboarding/flows/{flowId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/onboarding/flows/{flowId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/onboarding/stats | Developer Bearer |
Admin · Operations
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/operations | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/operations/{operationId} | Developer Bearer |
Admin · Outbound Webhooks
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/webhooks/catalog | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/webhooks/deliveries | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/webhooks/deliveries/{id} | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/webhooks/deliveries/{id}/replay | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/webhooks/subscriptions | Developer Bearer | List outbound webhook subscriptions |
POST | /v1/admin/projects/{projectId}/webhooks/subscriptions | Developer Bearer | Create an outbound webhook subscription |
DELETE | /v1/admin/projects/{projectId}/webhooks/subscriptions/{id} | Developer Bearer | Delete an outbound webhook subscription |
GET | /v1/admin/projects/{projectId}/webhooks/subscriptions/{id} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/webhooks/subscriptions/{id} | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/webhooks/subscriptions/{id}/rotate-secret | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/webhooks/subscriptions/{id}/test | Developer Bearer |
Admin · Payments
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/payments/accounts | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/payments/accounts | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/payments/accounts/link | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/payments/balance | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/payments/charges | Developer Bearer | |
PUT | /v1/admin/projects/{projectId}/payments/config | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/payments/payouts | Developer Bearer |
Admin · Projects
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects | Developer Bearer | List projects |
POST | /v1/admin/projects | Developer Bearer | Create a project |
DELETE | /v1/admin/projects/{projectId} | Developer Bearer | Delete a project |
GET | /v1/admin/projects/{projectId} | Developer Bearer | Get a project |
PATCH | /v1/admin/projects/{projectId} | Developer Bearer | Update a project |
POST | /v1/admin/projects/{projectId}/api-keys | Developer Bearer | Issue a new API key for a project |
DELETE | /v1/admin/projects/{projectId}/api-keys/{keyId} | Developer Bearer | Revoke an API key |
POST | /v1/admin/projects/{projectId}/api-keys/{keyId}/panic-kill | Developer Bearer | Panic-kill an API key |
GET | /v1/admin/projects/{projectId}/provisioning-status | Developer Bearer | Get project provisioning status |
POST | /v1/admin/projects/{projectId}/reprovision | Developer Bearer | Re-run project provisioning |
POST | /v1/admin/projects/{projectId}/test-event | Developer Bearer |
Admin · Promotion
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/promotion/export | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/promotion/import | Developer Bearer |
Admin · Push
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/push/campaigns | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/push/campaigns | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/push/campaigns/{campaignId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/push/campaigns/{campaignId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/push/campaigns/{campaignId} | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/push/campaigns/{campaignId}/send | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/push/campaigns/test | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/users/{userId}/push-schedule | Developer Bearer |
Admin · Queues
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/queue/bindings | Developer Bearer | |
PUT | /v1/admin/projects/{projectId}/queue/bindings | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/queue/bindings/{queue} | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/queue/send | Developer Bearer |
Admin · Referrals
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/referrals | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/referrals | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/referrals/{codeId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/referrals/{codeId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/referrals/{codeId}/stats | Developer Bearer |
Admin · Reviews
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/reviews | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/reviews/{reviewId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/reviews/{reviewId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/reviews/export | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/reviews/items | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/reviews/stats | Developer Bearer |
Admin · Roles
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/roles | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/roles | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/roles/{roleId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/roles/{roleId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/roles/{roleId}/users | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/roles/assign | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/roles/revoke | Developer Bearer |
Admin · Segments
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/segments | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/segments | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/segments/{segmentId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/segments/{segmentId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/segments/{segmentId} | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/segments/{segmentId}/evaluate | Developer Bearer |
Admin · Sessions
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/sessions | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/sessions/list | Developer Bearer |
Admin · Sites
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/sites | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/sites | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/sites/{name} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/sites/{name} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/sites/{name} | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/sites/{name}/deployments | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/sites/{name}/domains | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/sites/{name}/domains | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/sites/{name}/domains/{hostname} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/sites/{name}/domains/{hostname} | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/sites/{name}/domains/{hostname}/refresh-cert | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/sites/{name}/rollback | Developer Bearer |
Admin · Storage
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/storage/buckets | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/storage/buckets | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/storage/buckets/{name} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/storage/buckets/{name} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/storage/buckets/{name} | Developer Bearer |
Admin · Stores
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/stores | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/stores | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/stores/{storeId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/stores/{storeId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/stores/{storeId}/listings | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/stores/{storeId}/listings | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/stores/{storeId}/listings/{listingId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/stores/{storeId}/listings/{listingId} | Developer Bearer |
Admin · Streaks
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/streaks | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/streaks | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/streaks/{streakId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/streaks/{streakId} | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/streaks/{streakId}/reset | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/users/{userId}/streaks/{streakDefinitionId}/grant-shield | Developer Bearer |
Admin · Subscriptions
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/subscriptions/entitlements | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/subscriptions/entitlements | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/subscriptions/offerings | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/subscriptions/offerings | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/subscriptions/products | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/subscriptions/products | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/subscriptions/products/{productId}/entitlements | Developer Bearer |
Admin · Users
| Method | Path | Auth | Summary |
|---|---|---|---|
DELETE | /v1/admin/projects/{projectId}/users | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/users | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/users | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/users/{userId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/users/{userId} | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/users/{userId}/entitlements | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/users/{userId}/events | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/users/{userId}/events/export | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/users/{userId}/export | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/users/{userId}/reset | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/users/bulk-update | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/users/cohort | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/users/export | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/users/reset-sandbox | Developer Bearer |
Admin · XP
| Method | Path | Auth | Summary |
|---|---|---|---|
GET | /v1/admin/projects/{projectId}/xp | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/xp | Developer Bearer | |
DELETE | /v1/admin/projects/{projectId}/xp/{ruleId} | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/xp/{ruleId} | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/xp/config | Developer Bearer | |
PATCH | /v1/admin/projects/{projectId}/xp/config | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/xp/deduct | Developer Bearer | |
POST | /v1/admin/projects/{projectId}/xp/grant | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/xp/users | Developer Bearer | |
GET | /v1/admin/projects/{projectId}/xp/users/{userId} | Developer Bearer |