Sign in, open Settings › API Access and choose Create key. Name it after the integration, pick the apps it may reach, and copy the secret — it is shown once. Keys start from your workspace's access policy and never widen beyond it.
Back to homepage1. Get a key 2. Make a first call 3. Try it with a test key email
Build on Plenlea
Every screen in Plenlea runs on the same API you get a key for. Create a key in your workspace, make one call, then try the same call with a test key against your sandbox — nothing you do there touches live data.
Quickstart
Three steps to your first call.
Send the key as a bearer token. The developer workspace read answers with the workspace the key belongs to:
curl -H "Authorization: Bearer bz_live_YOUR_KEY" http://api:8000/v1/developer/workspaceCreate a second key with Key type Test (sandbox). Its secret starts with bz_test_ and reaches only your sandbox workspace — same endpoints, same scopes, data that starts empty, nothing charged, no emails sent, no payments. Switch to a live key when the integration is ready.
curl -H "Authorization: Bearer bz_test_YOUR_TEST_KEY" http://api:8000/v1/developer/workspaceGood to know
How the API treats you.
- Every call is scoped to one workspace — the one the key was created in (or its sandbox for a test key). A key never reaches another workspace.
- Scopes are per app: app:read or app:write, chosen when the key is created and capped by the workspace's access policy.
- Actions that cost credits are charged to the workspace exactly as if a person did them in the app; a sandbox is never charged.
- Destructive operations (delete, send outside the workspace, payouts, bulk changes) need the X-Plenlea-Confirmed: true header.
- The contract is OpenAPI 0.1.0; the reference below is generated from it, so what you read is what the API serves.
Endpoint reference
655 operations, grouped by app.
Each row is method and path, then what it does and how it authenticates. "API key" operations take a developer key; "Sign-in" operations are reached by the app itself (or by an API key under the matching app scope); "None (public)" needs no credential.
agent
Delegated agent access and controls.
GET /v1/agent/approvals- List agent approvals · Sign-in (OIDC) or Sign-in (session)
POST /v1/agent/approvals/{receipt_id}/approve- Approve agent operation · Sign-in (OIDC) or Sign-in (session)
GET /v1/agent/delegations- List agent delegations · Sign-in (OIDC) or Sign-in (session)
POST /v1/agent/delegations- Issue agent delegation · Sign-in (OIDC) or Sign-in (session)
POST /v1/agent/delegations/{delegation_id}/revoke- Revoke agent delegation · Sign-in (OIDC) or Sign-in (session)
GET /v1/agent/emergency-stop- Get agent emergency stop · Sign-in (OIDC) or Sign-in (session)
PUT /v1/agent/emergency-stop- Set agent emergency stop · Sign-in (OIDC) or Sign-in (session)
GET /v1/agent/feedback- List agent feedback · PlenleaPlatformAgentCredential
GET /v1/agent/feedback/{report_id}- Get agent feedback · PlenleaPlatformAgentCredential
GET /v1/agent/platform-problems- List platform problems · PlenleaPlatformAgentCredential
GET /v1/agent/platform-problems/{problem_id}- Get platform problem · PlenleaPlatformAgentCredential
GET /v1/agent/platform-problems/{problem_id}/occurrences- List platform problem occurrences · PlenleaPlatformAgentCredential
GET /v1/agent/queue- List agent queue · PlenleaPlatformAgentCredential
POST /v1/agent/queue/{item_type}/{item_id}/claim- Claim agent queue item · PlenleaPlatformAgentCredential
POST /v1/agent/queue/{item_type}/{item_id}/close- Close agent queue item · PlenleaPlatformAgentCredential
POST /v1/agent/queue/{item_type}/{item_id}/fix-link- Set agent queue fix link · PlenleaPlatformAgentCredential
POST /v1/agent/queue/{item_type}/{item_id}/notes- Add agent queue note · PlenleaPlatformAgentCredential
POST /v1/agent/queue/{item_type}/{item_id}/progress- Set agent queue progress · PlenleaPlatformAgentCredential
POST /v1/agent/queue/{item_type}/{item_id}/release- Release agent queue item · PlenleaPlatformAgentCredential
POST /v1/agent/queue/report/{item_id}/score- Score agent queue suggestion · PlenleaPlatformAgentCredential
GET /v1/agent/workspace- Get agent workspace · Agent credential
PATCH /v1/agent/workspace- Rename agent workspace · Agent credential
assisted-sites
Assisted-site drafting, review, publication, and recovery.
DELETE /v1/assisted-sites/{site_id}- Delete assisted site · Sign-in (OIDC) or Sign-in (session)
POST /v1/assisted-sites/{site_id}/publish- Publish assisted site · Sign-in (OIDC) or Sign-in (session)
POST /v1/assisted-sites/{site_id}/review- Review assisted site · Sign-in (OIDC) or Sign-in (session)
POST /v1/assisted-sites/{site_id}/rollback- Rollback assisted site · Sign-in (OIDC) or Sign-in (session)
POST /v1/assisted-sites/{site_id}/unpublish- Unpublish assisted site · Sign-in (OIDC) or Sign-in (session)
GET /v1/assisted-sites/{site_id}/versions- List assisted site versions · Sign-in (OIDC) or Sign-in (session)
auth
Anonymous pre-auth session boundary.
GET /v1/auth/context- Get auth request context · None (public)
POST /v1/auth/magic-link/complete- Complete magic link · None (public)
POST /v1/auth/magic-link/request- Request magic link · None (public)
POST /v1/auth/magic-link/resend- Resend magic link · None (public)
POST /v1/auth/oauth/{provider}/start- Start idp intent · None (public)
POST /v1/auth/oauth/callback- Complete idp callback · None (public)
GET /v1/auth/second-factor- Get second factor status · Sign-in (OIDC) or Sign-in (session)
POST /v1/auth/second-factor/authenticator-app- Start authenticator app enrollment · Sign-in (OIDC) or Sign-in (session)
POST /v1/auth/second-factor/authenticator-app/check- Check authenticator app code · Sign-in (OIDC) or Sign-in (session)
POST /v1/auth/second-factor/authenticator-app/verify- Verify authenticator app enrollment · Sign-in (OIDC) or Sign-in (session)
POST /v1/auth/second-factor/passkey- Start passkey enrollment · Sign-in (OIDC) or Sign-in (session)
POST /v1/auth/second-factor/passkey/{passkey_id}/verify- Verify passkey enrollment · Sign-in (OIDC) or Sign-in (session)
POST /v1/auth/second-factor/passkey/challenge- Start passkey check · Sign-in (OIDC) or Sign-in (session)
POST /v1/auth/second-factor/passkey/check- Check passkey · Sign-in (OIDC) or Sign-in (session)
POST /v1/auth/session- Open session · Sign-in (OIDC)
DELETE /v1/auth/session- Close session · None (public)
POST /v1/auth/session/renew- Get session renewal · None (public)
GET /v1/auth/sessions- List auth sessions · Sign-in (OIDC) or Sign-in (session)
POST /v1/auth/sessions/{handle}/end- End auth session · Sign-in (OIDC) or Sign-in (session)
POST /v1/auth/sessions/end-others- End other auth sessions · Sign-in (OIDC) or Sign-in (session)
POST /v1/auth/step-up/challenge- Request step up challenge · Sign-in (OIDC) or Sign-in (session)
GET /v1/auth/step-up/status- Get step up status · Sign-in (OIDC) or Sign-in (session)
POST /v1/auth/step-up/verify- Verify step up challenge · Sign-in (OIDC) or Sign-in (session)
billing
Workspace plans and entitlements.
GET /v1/billing- Get billing account · Sign-in (OIDC) or Sign-in (session)
GET /v1/billing/payment-methods- List payment methods · Sign-in (OIDC) or Sign-in (session)
POST /v1/billing/payment-methods/default- Set default payment method · Sign-in (OIDC) or Sign-in (session)
POST /v1/billing/payment-methods/setup-intent- Create payment method setup intent · Sign-in (OIDC) or Sign-in (session)
POST /v1/billing/plan- Change billing plan · Sign-in (OIDC) or Sign-in (session)
GET /v1/billing/plan-quote- Get billing plan quote · Sign-in (OIDC) or Sign-in (session)
GET /v1/billing/plans- Get billing plans · Sign-in (OIDC) or Sign-in (session)
POST /v1/billing/portal-session- Create billing portal session · Sign-in (OIDC) or Sign-in (session)
POST /v1/billing/reconcile- Reconcile billing account · Sign-in (OIDC) or Sign-in (session)
GET /v1/billing/upsell-offer- Get plan upsell offer · Sign-in (OIDC) or Sign-in (session)
POST /v1/billing/webhooks/local- Apply local billing webhook · None (public)
GET /v1/credits/ledger- List credit ledger · Sign-in (OIDC) or Sign-in (session)
GET /v1/credits/usage- Get credit usage report · Sign-in (OIDC) or Sign-in (session)
GET /v1/credits/wallet- Get credit wallet · Sign-in (OIDC) or Sign-in (session)
POST /v1/webhooks/stripe-connect- Apply stripe connect event · None (public)
business
Private business profile data.
GET /v1/business-profile- Get business profile · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/business-profile- Update business profile · Sign-in (OIDC) or Sign-in (session)
GET /v1/business-profile/document-branding- Get document branding · Sign-in (OIDC) or Sign-in (session)
PUT /v1/business-profile/document-header- Update document header · Sign-in (OIDC) or Sign-in (session)
GET /v1/business-profile/logo- Get business logo · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/business-profile/logo- Remove business logo · Sign-in (OIDC) or Sign-in (session)
POST /v1/business-profile/logo/{upload_id}/commit- Commit business logo · Sign-in (OIDC) or Sign-in (session)
POST /v1/business-profile/logo/presign- Presign business logo · Sign-in (OIDC) or Sign-in (session)
GET /v1/business-profile/portfolio- Get portfolio · Sign-in (OIDC) or Sign-in (session)
POST /v1/business-profile/portfolio/categories- Create portfolio category · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/business-profile/portfolio/categories/{category_id}- Rename portfolio category · Sign-in (OIDC) or Sign-in (session)
POST /v1/business-profile/portfolio/categories/{category_id}/photos/{upload_id}/commit- Commit portfolio photo · Sign-in (OIDC) or Sign-in (session)
POST /v1/business-profile/portfolio/categories/{category_id}/photos/presign- Presign portfolio photo · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/business-profile/portfolio/photos/{file_id}- Remove portfolio photo · Sign-in (OIDC) or Sign-in (session)
catalog
Workspace catalog offerings.
GET /v1/catalog- List catalog offerings · Sign-in (OIDC) or Sign-in (session)
POST /v1/catalog- Create catalog offering · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/catalog/{offering_id}- Update catalog offering · Sign-in (OIDC) or Sign-in (session)
POST /v1/catalog/{offering_id}/archive- Archive catalog offering · Sign-in (OIDC) or Sign-in (session)
POST /v1/catalog/{offering_id}/restore- Restore catalog offering · Sign-in (OIDC) or Sign-in (session)
GET /v1/catalog/archived- List archived catalog offerings · Sign-in (OIDC) or Sign-in (session)
PUT /v1/catalog/order- Reorder catalog offerings · Sign-in (OIDC) or Sign-in (session)
consent
Cookie-consent decisions: public write, per-visitor log.
POST /v1/consent- Record cookie consent · Sign-in (OIDC) or Sign-in (session)
contacts
Private contact relationships.
GET /v1/contacts- List contacts · Sign-in (OIDC) or Sign-in (session)
POST /v1/contacts- Create contact · Sign-in (OIDC) or Sign-in (session)
GET /v1/contacts/{contact_id}- Get contact · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/contacts/{contact_id}- Update contact · Sign-in (OIDC) or Sign-in (session)
POST /v1/contacts/{contact_id}/archive- Archive contact · Sign-in (OIDC) or Sign-in (session)
POST /v1/contacts/{contact_id}/duplicates/dismiss- Dismiss contact duplicate pair · Sign-in (OIDC) or Sign-in (session)
POST /v1/contacts/{contact_id}/merge- Merge contact · Sign-in (OIDC) or Sign-in (session)
POST /v1/contacts/{contact_id}/merge/undo- Undo contact merge · Sign-in (OIDC) or Sign-in (session)
GET /v1/contacts/{contact_id}/notes- List contact notes · Sign-in (OIDC) or Sign-in (session)
POST /v1/contacts/{contact_id}/notes- Add contact note · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/contacts/{contact_id}/notes/{note_id}- Update contact note · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/contacts/{contact_id}/notes/{note_id}- Delete contact note · Sign-in (OIDC) or Sign-in (session)
GET /v1/contacts/{contact_id}/relationship- Get contact relationship · Sign-in (OIDC) or Sign-in (session)
POST /v1/contacts/{contact_id}/restore- Restore contact · Sign-in (OIDC) or Sign-in (session)
GET /v1/contacts/{contact_id}/work- Get contact work · Sign-in (OIDC) or Sign-in (session)
GET /v1/contacts/archived- List archived contacts · Sign-in (OIDC) or Sign-in (session)
GET /v1/contacts/duplicates- List contact duplicates · Sign-in (OIDC) or Sign-in (session)
GET /v1/contacts/duplicates/deferred- List deferred duplicate rows · Sign-in (OIDC) or Sign-in (session)
POST /v1/contacts/duplicates/deferred/{row_id}/resolve- Resolve deferred duplicate row · Sign-in (OIDC) or Sign-in (session)
POST /v1/contacts/import/{import_id}/commit- Commit contact import · Sign-in (OIDC) or Sign-in (session)
POST /v1/contacts/import/{import_id}/preview- Preview contact import · Sign-in (OIDC) or Sign-in (session)
PUT /v1/contacts/import/{import_id}/resolutions- Save contact import resolutions · Sign-in (OIDC) or Sign-in (session)
POST /v1/contacts/import/file- Import contacts file · Sign-in (OIDC) or Sign-in (session)
GET /v1/contacts/imports- List contact imports · Sign-in (OIDC) or Sign-in (session)
POST /v1/contacts/link-or-create- Link or create contact · Sign-in (OIDC) or Sign-in (session)
POST /v1/contacts/recipients/resolve- Resolve contact recipients · Sign-in (OIDC) or Sign-in (session)
GET /v1/contacts/tags- List contact tags · Sign-in (OIDC) or Sign-in (session)
core
Aggregated core workspace overview surfaces.
POST /v1/account/deletion- Delete account · Sign-in (OIDC) or Sign-in (session)
GET /v1/account/deletion-preview- Get account deletion preview · Sign-in (OIDC) or Sign-in (session)
GET /v1/activity- List workspace activity · Sign-in (OIDC) or Sign-in (session)
GET /v1/dashboard/overview- Get dashboard overview · Sign-in (OIDC) or Sign-in (session)
GET /v1/platform/stock-images- Search stock images · Sign-in (OIDC) or Sign-in (session)
GET /v1/platform/stock-images/{image_id}/image- Get stock image · Sign-in (OIDC) or Sign-in (session)
POST /v1/public-documents- Create public document link · Sign-in (OIDC) or Sign-in (session)
POST /v1/public-documents/{link_id}/revoke- Revoke public document link · Sign-in (OIDC) or Sign-in (session)
GET /v1/search- Search workspace · Sign-in (OIDC) or Sign-in (session)
developer
Developer credentials, quotas, and webhooks.
GET /v1/developer/access- Get developer access summary · Sign-in (OIDC) or Sign-in (session)
GET /v1/developer/credentials- List developer credentials · Sign-in (OIDC) or Sign-in (session)
POST /v1/developer/credentials- Issue developer credential · Sign-in (OIDC) or Sign-in (session)
POST /v1/developer/credentials/{credential_id}/revoke- Revoke developer credential · Sign-in (OIDC) or Sign-in (session)
GET /v1/developer/policy- Get developer policy · None (public)
GET /v1/developer/sandbox/workspace- Get developer sandbox workspace · Sign-in (OIDC) or Sign-in (session)
GET /v1/developer/scope-policy- Get developer scope policy · Sign-in (OIDC) or Sign-in (session)
PUT /v1/developer/scope-policy- Set developer scope policy · Sign-in (OIDC) or Sign-in (session)
GET /v1/developer/support- Get developer support policy · None (public)
GET /v1/developer/webhooks- List developer webhooks · Sign-in (OIDC) or Sign-in (session)
POST /v1/developer/webhooks- Issue developer webhook · Sign-in (OIDC) or Sign-in (session)
GET /v1/developer/webhooks/{subscription_id}/deliveries- List developer webhook deliveries · Sign-in (OIDC) or Sign-in (session)
POST /v1/developer/webhooks/{subscription_id}/deliveries/{delivery_id}/replay- Replay developer webhook delivery · Sign-in (OIDC) or Sign-in (session)
POST /v1/developer/webhooks/{subscription_id}/revoke- Revoke developer webhook · Sign-in (OIDC) or Sign-in (session)
POST /v1/developer/webhooks/{subscription_id}/test-deliveries- Create developer webhook test delivery · Sign-in (OIDC) or Sign-in (session)
GET /v1/developer/workspace- Get developer workspace · API key
Platform email dispatch, delivery state, and provider events (P.35).
GET /v1/platform/campaigns- List campaigns · Sign-in (OIDC) or Sign-in (session)
POST /v1/platform/campaigns- Submit campaign · Sign-in (OIDC) or Sign-in (session)
GET /v1/platform/campaigns/{campaign_id}- Get campaign · Sign-in (OIDC) or Sign-in (session)
GET /v1/platform/campaigns/no-spam-acceptance- Get no spam acceptance · Sign-in (OIDC) or Sign-in (session)
PUT /v1/platform/campaigns/no-spam-acceptance- Accept no spam rule · Sign-in (OIDC) or Sign-in (session)
GET /v1/platform/campaigns/no-spam-rule- Get no spam rule · Sign-in (OIDC) or Sign-in (session)
GET /v1/platform/email- List platform email deliveries · Sign-in (OIDC) or Sign-in (session)
POST /v1/platform/email- Send platform email · Sign-in (OIDC) or Sign-in (session)
GET /v1/platform/email/{delivery_id}- Get platform email delivery · Sign-in (OIDC) or Sign-in (session)
POST /v1/webhooks/email/{profile}- Apply email provider event · None (public)
esign
E-Sign envelopes and their documents.
GET /v1/esign/envelopes- List envelopes · Sign-in (OIDC) or Sign-in (session)
POST /v1/esign/envelopes- Create envelope · Sign-in (OIDC) or Sign-in (session)
GET /v1/esign/envelopes/{envelope_id}- Get envelope · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/esign/envelopes/{envelope_id}- Update envelope · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/esign/envelopes/{envelope_id}- Delete draft envelope · Sign-in (OIDC) or Sign-in (session)
GET /v1/esign/envelopes/{envelope_id}/audit-trail- Export audit trail · Sign-in (OIDC) or Sign-in (session)
GET /v1/esign/envelopes/{envelope_id}/certificate- Get completion certificate · Sign-in (OIDC) or Sign-in (session)
GET /v1/esign/envelopes/{envelope_id}/detection- Get envelope detection · Sign-in (OIDC) or Sign-in (session)
POST /v1/esign/envelopes/{envelope_id}/documents- Add envelope document · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/esign/envelopes/{envelope_id}/documents/{document_id}- Remove envelope document · Sign-in (OIDC) or Sign-in (session)
GET /v1/esign/envelopes/{envelope_id}/documents/{document_id}/content- Get envelope document content · Sign-in (OIDC) or Sign-in (session)
PUT /v1/esign/envelopes/{envelope_id}/documents/order- Reorder envelope documents · Sign-in (OIDC) or Sign-in (session)
POST /v1/esign/envelopes/{envelope_id}/documents/upload- Reserve envelope document upload · Sign-in (OIDC) or Sign-in (session)
POST /v1/esign/envelopes/{envelope_id}/extend- Extend envelope · Sign-in (OIDC) or Sign-in (session)
PUT /v1/esign/envelopes/{envelope_id}/fields- Replace envelope fields · Sign-in (OIDC) or Sign-in (session)
POST /v1/esign/envelopes/{envelope_id}/pages/{document_id}/{page}/confirm- Confirm envelope page · Sign-in (OIDC) or Sign-in (session)
POST /v1/esign/envelopes/{envelope_id}/remind- Remind envelope signers · Sign-in (OIDC) or Sign-in (session)
GET /v1/esign/envelopes/{envelope_id}/sealed-documents/{document_id}- Get sealed document · Sign-in (OIDC) or Sign-in (session)
POST /v1/esign/envelopes/{envelope_id}/send- Send envelope · Sign-in (OIDC) or Sign-in (session)
PUT /v1/esign/envelopes/{envelope_id}/signers- Replace envelope signers · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/esign/envelopes/{envelope_id}/signers/{signer_id}- Correct envelope signer · Sign-in (OIDC) or Sign-in (session)
POST /v1/esign/envelopes/{envelope_id}/signers/{signer_id}/resend- Resend signer invitation · Sign-in (OIDC) or Sign-in (session)
GET /v1/esign/envelopes/{envelope_id}/signing- Get sender signing session · Sign-in (OIDC) or Sign-in (session)
POST /v1/esign/envelopes/{envelope_id}/signing/adopt- Adopt sender signature · Sign-in (OIDC) or Sign-in (session)
PUT /v1/esign/envelopes/{envelope_id}/signing/fields/{field_id}- Complete sender field · Sign-in (OIDC) or Sign-in (session)
POST /v1/esign/envelopes/{envelope_id}/signing/sign- Sign as sender · Sign-in (OIDC) or Sign-in (session)
GET /v1/esign/envelopes/{envelope_id}/signing/signature- Get sender signature image · Sign-in (OIDC) or Sign-in (session)
POST /v1/esign/envelopes/{envelope_id}/void- Void envelope · Sign-in (OIDC) or Sign-in (session)
POST /v1/esign/envelopes/{envelope_id}/withdraw- Withdraw envelope · Sign-in (OIDC) or Sign-in (session)
GET /v1/esign/legal/excluded-documents- List esign excluded documents · Sign-in (OIDC) or Sign-in (session)
GET /v1/esign/settings- Get esign settings · Sign-in (OIDC) or Sign-in (session)
PUT /v1/esign/settings- Update esign settings · Sign-in (OIDC) or Sign-in (session)
estimates
Estimate authoring and recipient decisions.
GET /v1/estimates- List estimates · Sign-in (OIDC) or Sign-in (session)
POST /v1/estimates- Create estimate · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/estimates/{estimate_id}- Update estimate · Sign-in (OIDC) or Sign-in (session)
POST /v1/estimates/{estimate_id}/convert- Convert estimate · Sign-in (OIDC) or Sign-in (session)
GET /v1/estimates/{estimate_id}/history- List estimate history · Sign-in (OIDC) or Sign-in (session)
POST /v1/estimates/{estimate_id}/send- Send estimate · Sign-in (OIDC) or Sign-in (session)
events
The Events app: hosted events and their lifecycle.
GET /v1/events- List events · Sign-in (OIDC) or Sign-in (session)
POST /v1/events- Create event · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/{event_id}- Get event · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/events/{event_id}- Update event · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/events/{event_id}- Delete event draft · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/{event_id}/activity- List event activity · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/archive- Archive event · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/cancel- Cancel event · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/{event_id}/checkin- Get event checkin · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/{event_id}/checkin/door-qr.svg- Get door qr · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/{event_id}/checkin/guests- List checkin guests · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/checkin/guests/{registration_id}- Check in guest · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/events/{event_id}/checkin/guests/{registration_id}- Undo check in · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/checkin/scan- Scan checkin qr · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/checkin/walk-ins- Add walk in · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/{event_id}/cohosts- List cohosts · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/cohosts- Add cohost · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/events/{event_id}/cohosts/{cohost_id}- Remove cohost · Sign-in (OIDC) or Sign-in (session)
PUT /v1/events/{event_id}/cohosts/{cohost_id}/notify- Set cohost notify · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/{event_id}/contact-addresses- List contact addresses · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/contact-addresses- Add contact address · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/events/{event_id}/contact-addresses/{address_id}- Remove contact address · Sign-in (OIDC) or Sign-in (session)
PUT /v1/events/{event_id}/cover- Commit event cover · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/events/{event_id}/cover- Remove event cover · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/cover/presign- Presign event cover · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/duplicate- Duplicate event · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/{event_id}/feedback- Get event feedback summary · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/{event_id}/invite-allowance- Get event invite allowance · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/invites- Invite event guests · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/invites/preview- Preview event invites · Sign-in (OIDC) or Sign-in (session)
PUT /v1/events/{event_id}/languages/{locale}- Add event language · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/events/{event_id}/languages/{locale}- Remove event language · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/languages/{locale}/sections/{field}- Translate event section · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/{event_id}/map.png- Get event map · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/{event_id}/messages- List event messages · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/{event_id}/orders- List ticket orders · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/orders/{order_id}/decision- Decide ticket order · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/{event_id}/orders/{order_id}/screenshot- Read order screenshot · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/orders/{order_id}/screenshot/presign- Presign order screenshot · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/{event_id}/orders/totals- Get event order totals · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/{event_id}/photos- List event photos for manager · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/photos- Add event photos as manager · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/events/{event_id}/photos/{photo_id}- Set event photo caption · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/events/{event_id}/photos/{photo_id}- Remove event photo · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/photos/{photo_id}/decision- Decide event photo · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/events/{event_id}/photos/order- Reorder event photos · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/photos/presign- Presign event photo · Sign-in (OIDC) or Sign-in (session)
PUT /v1/events/{event_id}/presenter-logo- Commit event presenter logo · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/events/{event_id}/presenter-logo- Remove event presenter logo · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/presenter-logo/presign- Presign event presenter logo · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/{event_id}/preview- Get event preview · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/{event_id}/promo-codes- List promo codes · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/promo-codes- Create promo code · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/events/{event_id}/promo-codes/{promo_id}- Change promo code · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/publish- Publish event · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/{event_id}/registrations- List event registrations · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/events/{event_id}/registrations/{registration_id}- Remove event registration · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/registrations/{registration_id}/decision- Decide registration · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/registrations/contacts- Save event guests to contacts · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/{event_id}/registrations/counts- Get event registration counts · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/{event_id}/registrations/export- Export event registrations · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/sections/{section}/regenerate- Regenerate event section · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/series/cancel- Cancel event series · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/share-email- Share event by email · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/{event_id}/ticket-types- List ticket types · Sign-in (OIDC) or Sign-in (session)
PUT /v1/events/{event_id}/ticket-types- Replace ticket types · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/{event_id}/translations- List event translations · Sign-in (OIDC) or Sign-in (session)
PUT /v1/events/{event_id}/translations/{locale}/{field}- Set event translation · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/{event_id}/updates- Get event update segments · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/{event_id}/updates- Send event update · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/draft-requests/{request_id}- Get event draft request · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/drafts- Draft event with ai · Sign-in (OIDC) or Sign-in (session)
POST /v1/events/drafts/photo/presign- Presign brief photo · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/entitlements- List event entitlements · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/limits- Get event limits · Sign-in (OIDC) or Sign-in (session)
PUT /v1/events/organization/contributor-photos- Set organization contributor photos · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/row-figures- List event row figures · Sign-in (OIDC) or Sign-in (session)
GET /v1/events/stats- Get event stats · Sign-in (OIDC) or Sign-in (session)
feedback
Suggestion & Bug intake (Feature 22).
POST /v1/feedback- Submit feedback · Sign-in (OIDC) or Sign-in (session)
POST /v1/feedback/attachments- Presign feedback attachment · Sign-in (OIDC) or Sign-in (session)
POST /v1/feedback/attachments/{upload_id}/commit- Commit feedback attachment · Sign-in (OIDC) or Sign-in (session)
findPros
Authenticated demand authoring and requester-scoped request access.
GET /v1/demand-requests- List demand requests · Sign-in (OIDC) or Sign-in (session)
POST /v1/demand-requests- Create demand request · Sign-in (OIDC) or Sign-in (session)
GET /v1/demand-requests/{request_id}- Get demand request · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/demand-requests/{request_id}- Update demand request · Sign-in (OIDC) or Sign-in (session)
POST /v1/demand-requests/{request_id}/close- Close demand request · Sign-in (OIDC) or Sign-in (session)
POST /v1/demand-requests/{request_id}/complete- Complete demand request · Sign-in (OIDC) or Sign-in (session)
POST /v1/demand-requests/{request_id}/hire- Hire demand request · Sign-in (OIDC) or Sign-in (session)
GET /v1/demand-requests/{request_id}/matched-providers- List matched providers · Sign-in (OIDC) or Sign-in (session)
POST /v1/demand-requests/{request_id}/matches/{workspace_id}/feedback- Create demand request match feedback · Sign-in (OIDC) or Sign-in (session)
POST /v1/demand-requests/{request_id}/review- Submit demand request review · Sign-in (OIDC) or Sign-in (session)
POST /v1/demand-requests/parse- Parse demand prompt · Sign-in (OIDC) or Sign-in (session)
global-admin
Platform super-admin console (allow-list gated; NOT the operator console).
GET /v1/admin/access- Admin self access · Sign-in (OIDC) or Sign-in (session)
GET /v1/admin/action-pricing- Admin list action pricing · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/admin/action-pricing/{action_key}- Admin update action rate · Sign-in (OIDC) or Sign-in (session)
GET /v1/admin/agent-credentials- List admin agent credentials · Sign-in (OIDC) or Sign-in (session)
POST /v1/admin/agent-credentials- Issue admin agent credential · Sign-in (OIDC) or Sign-in (session)
POST /v1/admin/agent-credentials/{credential_id}/revoke- Revoke admin agent credential · Sign-in (OIDC) or Sign-in (session)
GET /v1/admin/ai-models- Admin get ai models · Sign-in (OIDC) or Sign-in (session)
PUT /v1/admin/ai-models- Admin save ai models · Sign-in (OIDC) or Sign-in (session)
GET /v1/admin/app-parameters- List admin parameters · Sign-in (OIDC) or Sign-in (session)
PUT /v1/admin/app-parameters- Admin save parameters · Sign-in (OIDC) or Sign-in (session)
POST /v1/admin/content-languages- Admin create content language · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/admin/content-languages/{code}- Admin update content language · Sign-in (OIDC) or Sign-in (session)
GET /v1/admin/credits/ledger- Admin list credit ledger · Sign-in (OIDC) or Sign-in (session)
GET /v1/admin/dashboard/summary- Get admin dashboard summary · Sign-in (OIDC) or Sign-in (session)
GET /v1/admin/feature-entitlements- Admin list feature entitlements · Sign-in (OIDC) or Sign-in (session)
POST /v1/admin/feature-entitlements- Admin add feature entitlement · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/admin/feature-entitlements/{app_key}/{feature_key}- Admin update feature min tier · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/admin/feature-entitlements/{app_key}/{feature_key}- Admin delete feature entitlement · Sign-in (OIDC) or Sign-in (session)
GET /v1/admin/feedback/{item_type}/{item_id}/steps- List admin feedback steps · Sign-in (OIDC) or Sign-in (session)
GET /v1/admin/feedback/problems- List admin feedback problems · Sign-in (OIDC) or Sign-in (session)
GET /v1/admin/feedback/problems/{problem_id}/occurrences- List admin feedback problem occurrences · Sign-in (OIDC) or Sign-in (session)
GET /v1/admin/feedback/reports- List admin feedback reports · Sign-in (OIDC) or Sign-in (session)
POST /v1/admin/feedback/suggestions/{report_id}/answer- Answer admin feedback suggestion · Sign-in (OIDC) or Sign-in (session)
GET /v1/admin/interface-languages- Admin list interface languages · Sign-in (OIDC) or Sign-in (session)
POST /v1/admin/interface-languages/{code}- Admin add interface language · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/admin/interface-languages/{code}- Admin turn interface language · Sign-in (OIDC) or Sign-in (session)
GET /v1/admin/interface-texts- Admin list interface texts · Sign-in (OIDC) or Sign-in (session)
PUT /v1/admin/interface-texts/{key}/{locale}- Admin edit interface text · Sign-in (OIDC) or Sign-in (session)
POST /v1/admin/interface-texts/{key}/{locale}/redraft- Admin redraft interface text · Sign-in (OIDC) or Sign-in (session)
GET /v1/admin/jobs- Admin list scheduled jobs · Sign-in (OIDC) or Sign-in (session)
GET /v1/admin/jobs/{job}/runs- Admin list scheduled job runs · Sign-in (OIDC) or Sign-in (session)
GET /v1/admin/leads/unrecognised-demand- Admin list unrecognised demand · Sign-in (OIDC) or Sign-in (session)
POST /v1/admin/leads/unrecognised-demand/{request_id}/resolve- Admin resolve unrecognised demand · Sign-in (OIDC) or Sign-in (session)
POST /v1/admin/legal-pages/{slug}/versions- Admin publish legal page version · Sign-in (OIDC) or Sign-in (session)
GET /v1/admin/lookup- Admin resolve identifier · Sign-in (OIDC) or Sign-in (session)
GET /v1/admin/overhead-rates- Get overhead rates · Sign-in (OIDC) or Sign-in (session)
PUT /v1/admin/overhead-rates- Update overhead rates · Sign-in (OIDC) or Sign-in (session)
GET /v1/admin/plans-config- Admin get plans config · Sign-in (OIDC) or Sign-in (session)
PUT /v1/admin/plans-config- Admin save plans config · Sign-in (OIDC) or Sign-in (session)
GET /v1/admin/platform-problems- List admin platform problems · Sign-in (OIDC) or Sign-in (session)
POST /v1/admin/platform-problems/{problem_id}/status- Set admin platform problem status · Sign-in (OIDC) or Sign-in (session)
GET /v1/admin/users- List admin users · Sign-in (OIDC) or Sign-in (session)
POST /v1/admin/users/{subject}/account-override- Admin apply account override · Sign-in (OIDC) or Sign-in (session)
POST /v1/admin/users/{user_id}/second-factor/reset- Reset user second factor · Sign-in (OIDC) or Sign-in (session)
identity
Client identity configuration.
GET /v1/identity/config- Get identity client config · None (public)
GET /v1/viewer- Get viewer · Sign-in (OIDC) or Sign-in (session)
PUT /v1/viewer/intros/{app_id}- Record viewer app intro seen · Sign-in (OIDC) or Sign-in (session)
PUT /v1/viewer/locale- Set viewer locale · Sign-in (OIDC) or Sign-in (session)
GET /v1/viewer/photo- Get viewer photo · Sign-in (OIDC) or Sign-in (session)
invoices
Issued invoice lifecycle.
GET /v1/invoices- List invoices · Sign-in (OIDC) or Sign-in (session)
POST /v1/invoices- Create invoice · Sign-in (OIDC) or Sign-in (session)
GET /v1/invoices/{invoice_id}- Get invoice · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/invoices/{invoice_id}- Update invoice · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/invoices/{invoice_id}- Delete invoice · Sign-in (OIDC) or Sign-in (session)
GET /v1/invoices/{invoice_id}/attachments- List invoice attachments · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/invoices/{invoice_id}/attachments/{file_id}- Remove invoice attachment · Sign-in (OIDC) or Sign-in (session)
POST /v1/invoices/{invoice_id}/attachments/{file_id}/read- Read invoice attachment · Sign-in (OIDC) or Sign-in (session)
POST /v1/invoices/{invoice_id}/attachments/{upload_id}/commit- Commit invoice attachment · Sign-in (OIDC) or Sign-in (session)
POST /v1/invoices/{invoice_id}/attachments/presign- Presign invoice attachment · Sign-in (OIDC) or Sign-in (session)
GET /v1/invoices/{invoice_id}/history- List invoice history · Sign-in (OIDC) or Sign-in (session)
POST /v1/invoices/{invoice_id}/issue- Issue invoice · Sign-in (OIDC) or Sign-in (session)
POST /v1/invoices/{invoice_id}/offline-payments- Record offline payment · Sign-in (OIDC) or Sign-in (session)
GET /v1/invoices/{invoice_id}/payments- List invoice payment attempts · Sign-in (OIDC) or Sign-in (session)
POST /v1/invoices/{invoice_id}/payments- Create payment · Sign-in (OIDC) or Sign-in (session)
GET /v1/invoices/{invoice_id}/pdf- Get invoice pdf · Sign-in (OIDC) or Sign-in (session)
POST /v1/invoices/{invoice_id}/reminders- Send invoice reminder · Sign-in (OIDC) or Sign-in (session)
POST /v1/invoices/{invoice_id}/restore- Restore invoice · Sign-in (OIDC) or Sign-in (session)
POST /v1/invoices/{invoice_id}/undelete- Undelete invoice · Sign-in (OIDC) or Sign-in (session)
POST /v1/invoices/{invoice_id}/void- Void invoice · Sign-in (OIDC) or Sign-in (session)
GET /v1/invoices/by-short-id/{short_id}- Get invoice by short id · Sign-in (OIDC) or Sign-in (session)
POST /v1/invoices/by-short-id/{short_id}/publication- Prepare invoice publication · Sign-in (OIDC) or Sign-in (session)
GET /v1/invoices/received- List received invoices · Sign-in (OIDC) or Sign-in (session)
POST /v1/invoices/received/{invoice_id}/views- Record received invoice view · Sign-in (OIDC) or Sign-in (session)
GET /v1/invoices/received/summary- Get received invoice summary · Sign-in (OIDC) or Sign-in (session)
GET /v1/invoices/settings- Get invoice numbering settings · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/invoices/settings- Update invoice numbering settings · Sign-in (OIDC) or Sign-in (session)
GET /v1/invoices/status-counts- Get invoice status counts · Sign-in (OIDC) or Sign-in (session)
marketplace
Demand, opportunity, and lead workflows.
GET /v1/leads- List leads · Sign-in (OIDC) or Sign-in (session)
POST /v1/leads- Create lead · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/leads/{lead_id}- Update lead · Sign-in (OIDC) or Sign-in (session)
POST /v1/leads/{lead_id}/close- Close lead · Sign-in (OIDC) or Sign-in (session)
POST /v1/leads/{lead_id}/dismiss- Dismiss lead · Sign-in (OIDC) or Sign-in (session)
GET /v1/leads/{lead_id}/events- List lead events · Sign-in (OIDC) or Sign-in (session)
POST /v1/leads/{lead_id}/response- Respond to lead · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/leads/dismissals- Clear lead dismissals · Sign-in (OIDC) or Sign-in (session)
GET /v1/leads/interest-profile- Get interest profile · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/leads/interest-profile/examples/{example_id}- Withdraw interest example · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/leads/interest-profile/exclusions/{exclusion_id}- Remove interest exclusion · Sign-in (OIDC) or Sign-in (session)
POST /v1/leads/interest-profile/offers/{anchor_example_id}/accept- Accept exclusion offer · Sign-in (OIDC) or Sign-in (session)
POST /v1/leads/interest-profile/offers/{anchor_example_id}/decline- Decline exclusion offer · Sign-in (OIDC) or Sign-in (session)
GET /v1/leads/overview- Get leads overview · Sign-in (OIDC) or Sign-in (session)
GET /v1/leads/withheld-summary- Get leads withheld summary · Sign-in (OIDC) or Sign-in (session)
GET /v1/marketplace/matches- List marketplace matches · Sign-in (OIDC) or Sign-in (session)
GET /v1/marketplace/opportunities- List marketplace opportunities · Sign-in (OIDC) or Sign-in (session)
GET /v1/opportunity-preferences- Get opportunity preferences · Sign-in (OIDC) or Sign-in (session)
PUT /v1/opportunity-preferences- Update opportunity preferences · Sign-in (OIDC) or Sign-in (session)
notifications
Notification preferences and delivery state.
GET /v1/notification-preferences- Get notification preferences · Sign-in (OIDC) or Sign-in (session)
PUT /v1/notification-preferences- Update notification preferences · Sign-in (OIDC) or Sign-in (session)
GET /v1/notification-preferences/quiet-hours- Get quiet hours · Sign-in (OIDC) or Sign-in (session)
PUT /v1/notification-preferences/quiet-hours- Update quiet hours · Sign-in (OIDC) or Sign-in (session)
GET /v1/notification-workflows- List notification workflows · Sign-in (OIDC) or Sign-in (session)
POST /v1/notification-workflows/{workflow_id}/cancel- Cancel notification workflow · Sign-in (OIDC) or Sign-in (session)
POST /v1/notification-workflows/{workflow_id}/retry- Retry notification workflow · Sign-in (OIDC) or Sign-in (session)
GET /v1/notifications- List notifications · Sign-in (OIDC) or Sign-in (session)
POST /v1/notifications/{notification_id}/archive- Archive notification · Sign-in (OIDC) or Sign-in (session)
POST /v1/notifications/{notification_id}/dismiss- Dismiss notification · Sign-in (OIDC) or Sign-in (session)
POST /v1/notifications/{notification_id}/read- Mark notification read · Sign-in (OIDC) or Sign-in (session)
POST /v1/notifications/{notification_id}/unread- Mark notification unread · Sign-in (OIDC) or Sign-in (session)
POST /v1/notifications/emit- Emit notification · Sign-in (OIDC) or Sign-in (session)
POST /v1/notifications/read-all- Mark all notifications read · Sign-in (OIDC) or Sign-in (session)
GET /v1/notifications/stream- Stream notifications · Sign-in (OIDC) or Sign-in (session)
GET /v1/notifications/unread-count- Get notification unread count · Sign-in (OIDC) or Sign-in (session)
oauth
OAuth2 authorization server: app registration, consent, tokens, connected apps.
GET /v1/oauth/apps- List o auth apps · Sign-in (OIDC) or Sign-in (session)
POST /v1/oauth/apps- Register o auth app · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/oauth/apps/{app_id}/logo- Remove o auth app logo · Sign-in (OIDC) or Sign-in (session)
POST /v1/oauth/apps/{app_id}/logo/{upload_id}/commit- Commit o auth app logo · Sign-in (OIDC) or Sign-in (session)
POST /v1/oauth/apps/{app_id}/logo/presign- Presign o auth app logo · Sign-in (OIDC) or Sign-in (session)
GET /v1/oauth/authorize- Get o auth consent · Sign-in (OIDC) or Sign-in (session)
POST /v1/oauth/authorize/decision- Decide o auth consent · Sign-in (OIDC) or Sign-in (session)
GET /v1/oauth/grants- List connected apps · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/oauth/grants/{grant_id}- Revoke connected app · Sign-in (OIDC) or Sign-in (session)
PUT /v1/oauth/grants/{grant_id}/scopes- Set connected app scopes · Sign-in (OIDC) or Sign-in (session)
POST /v1/oauth/token- Exchange o auth token · None (public)
onboarding
Authenticated first-run onboarding progression.
GET /v1/onboarding- Get onboarding state · Sign-in (OIDC) or Sign-in (session)
PUT /v1/onboarding/business-type- Set onboarding business type · Sign-in (OIDC) or Sign-in (session)
POST /v1/onboarding/complete- Complete onboarding · Sign-in (OIDC) or Sign-in (session)
PUT /v1/onboarding/display-name- Set onboarding display name · Sign-in (OIDC) or Sign-in (session)
PUT /v1/onboarding/identity-type- Set onboarding identity type · Sign-in (OIDC) or Sign-in (session)
PUT /v1/onboarding/location- Set onboarding location · Sign-in (OIDC) or Sign-in (session)
POST /v1/onboarding/nudge-offered- Record onboarding nudge offer · Sign-in (OIDC) or Sign-in (session)
operator
Governed platform-operator workflows.
POST /v1/operator/break-glass/workflow-recovery- Invoke operator workflow recovery break glass · Sign-in (OIDC) or Sign-in (session)
GET /v1/operator/changes- List operator changes · Sign-in (OIDC) or Sign-in (session)
POST /v1/operator/changes- Request operator change · Sign-in (OIDC) or Sign-in (session)
POST /v1/operator/changes/{change_id}/approve- Approve operator change · Sign-in (OIDC) or Sign-in (session)
GET /v1/operator/overview- Get operator overview · Sign-in (OIDC) or Sign-in (session)
organizations
Organizations, events, and participation.
GET /v1/organization-events- List accessible organization events · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/organization-events/{event_id}- Update organization event · Sign-in (OIDC) or Sign-in (session)
GET /v1/organization-events/{event_id}/announcements- List organization event announcements · Sign-in (OIDC) or Sign-in (session)
POST /v1/organization-events/{event_id}/announcements- Create organization event announcement · Sign-in (OIDC) or Sign-in (session)
POST /v1/organization-events/{event_id}/cancel- Cancel organization event · Sign-in (OIDC) or Sign-in (session)
POST /v1/organization-events/{event_id}/publish- Publish organization event · Sign-in (OIDC) or Sign-in (session)
GET /v1/organization-events/{event_id}/registrations- List organization event registrations · Sign-in (OIDC) or Sign-in (session)
POST /v1/organization-events/{event_id}/registrations- Create organization event registration · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/organization-events/{event_id}/registrations/{registration_id}- Cancel organization event registration · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/organization-events/{event_id}/registrations/{registration_id}/attendance- Update organization event registration attendance · Sign-in (OIDC) or Sign-in (session)
POST /v1/organization-invitations/accept- Accept organization invitation · Sign-in (OIDC) or Sign-in (session)
GET /v1/organizations- List organizations · Sign-in (OIDC) or Sign-in (session)
POST /v1/organizations- Create organization · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/organizations/{organization_id}- Update organization · Sign-in (OIDC) or Sign-in (session)
POST /v1/organizations/{organization_id}/archive- Archive organization · Sign-in (OIDC) or Sign-in (session)
GET /v1/organizations/{organization_id}/events- List organization events · Sign-in (OIDC) or Sign-in (session)
POST /v1/organizations/{organization_id}/events- Create organization event · Sign-in (OIDC) or Sign-in (session)
GET /v1/organizations/{organization_id}/invitations- List organization invitations · Sign-in (OIDC) or Sign-in (session)
POST /v1/organizations/{organization_id}/invitations- Create organization invitation · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/organizations/{organization_id}/invitations/{invitation_id}- Revoke organization invitation · Sign-in (OIDC) or Sign-in (session)
GET /v1/organizations/{organization_id}/members- List organization members · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/organizations/{organization_id}/members/{membership_id}- Update organization member · Sign-in (OIDC) or Sign-in (session)
POST /v1/organizations/{organization_id}/restore- Restore organization · Sign-in (OIDC) or Sign-in (session)
payments
Payment, refund, and reconciliation workflows.
GET /v1/payments/{attempt_id}/refunds- List payment refunds · Sign-in (OIDC) or Sign-in (session)
POST /v1/payments/{attempt_id}/refunds- Refund payment · Sign-in (OIDC) or Sign-in (session)
POST /v1/payments/{payment_id}/zelle-decision- Decide zelle payment · Sign-in (OIDC) or Sign-in (session)
GET /v1/payments/{payment_id}/zelle-screenshot- Get zelle payment screenshot · Sign-in (OIDC) or Sign-in (session)
GET /v1/payments/received- List workspace payments · Sign-in (OIDC) or Sign-in (session)
GET /v1/payments/received/summary- Get workspace payments summary · Sign-in (OIDC) or Sign-in (session)
GET /v1/payments/reconciliation- List payment reconciliation · Sign-in (OIDC) or Sign-in (session)
GET /v1/payments/settings- Get payment settings · Sign-in (OIDC) or Sign-in (session)
PUT /v1/payments/settings- Update payment settings · Sign-in (OIDC) or Sign-in (session)
GET /v1/payments/settings/zelle-qr- Get zelle qr · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/payments/settings/zelle-qr- Remove zelle qr · Sign-in (OIDC) or Sign-in (session)
POST /v1/payments/settings/zelle-qr/{upload_id}/commit- Commit zelle qr · Sign-in (OIDC) or Sign-in (session)
POST /v1/payments/settings/zelle-qr/presign- Presign zelle qr · Sign-in (OIDC) or Sign-in (session)
POST /v1/payments/webhooks/local- Apply local payment webhook · None (public)
POST /v1/payments/zelle/accounts- Add zelle account · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/payments/zelle/accounts/{account_id}- Remove zelle account · Sign-in (OIDC) or Sign-in (session)
POST /v1/payments/zelle/accounts/{account_id}/default- Make zelle account default · Sign-in (OIDC) or Sign-in (session)
GET /v1/payments/zelle/expected- List zelle expected payments · Sign-in (OIDC) or Sign-in (session)
GET /v1/payments/zelle/notices- List zelle notices · Sign-in (OIDC) or Sign-in (session)
POST /v1/payments/zelle/notices/{notice_id}/attach- Attach zelle notice · Sign-in (OIDC) or Sign-in (session)
GET /v1/payments/zelle/to-verify- List zelle payments to verify · Sign-in (OIDC) or Sign-in (session)
POST /v1/payments/zelle/verification- Start zelle verification · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/payments/zelle/verification- Stop zelle verification · Sign-in (OIDC) or Sign-in (session)
POST /v1/payments/zelle/verification/address- Replace zelle forwarding address · Sign-in (OIDC) or Sign-in (session)
POST /v1/payments/zelle/verification/test- Start zelle notice test · Sign-in (OIDC) or Sign-in (session)
GET /v1/received-payments- List received payments · Sign-in (OIDC) or Sign-in (session)
GET /v1/received-payments/summary- Get received payments summary · Sign-in (OIDC) or Sign-in (session)
POST /v1/webhooks/zelle-notices- Apply zelle notice event · None (public)
platform
Shared platform capabilities consumed across apps.
GET /v1/platform/content-languages- List content languages · Sign-in (OIDC) or Sign-in (session)
PUT /v1/platform/file-uploads/{token}- Upload platform file · None (public)
GET /v1/platform/files/{token}- Read platform file · None (public)
GET /v1/platform/files/{token}/rendition- Read platform file rendition · None (public)
GET /v1/platform/geocode- Search addresses · Sign-in (OIDC) or Sign-in (session)
GET /v1/platform/geocode/places/{place_id}- Get address details · Sign-in (OIDC) or Sign-in (session)
GET /v1/platform/nudge-policy- Get nudge policy · Sign-in (OIDC) or Sign-in (session)
POST /v1/platform/nudges/{key}/events- Record nudge event · Sign-in (OIDC) or Sign-in (session)
GET /v1/platform/nudges/decide- Decide nudges · Sign-in (OIDC) or Sign-in (session)
POST /v1/share-links- Create share link · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/share-links/{code}- Revoke share link · Sign-in (OIDC) or Sign-in (session)
GET /v1/share-links/stats- Get share link stats · Sign-in (OIDC) or Sign-in (session)
GET /v1/smart-match/candidates- List smart match candidates · Sign-in (OIDC) or Sign-in (session)
POST /v1/smart-match/candidates/{candidate_id}/decision- Decide smart match candidate · Sign-in (OIDC) or Sign-in (session)
presence
Public presence and workspace composition.
GET /v1/bio-links- List bio links · Sign-in (OIDC) or Sign-in (session)
POST /v1/bio-links- Create bio link · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/bio-links/{link_id}- Update bio link · Sign-in (OIDC) or Sign-in (session)
POST /v1/bio-links/{link_id}/archive- Archive bio link · Sign-in (OIDC) or Sign-in (session)
POST /v1/bio-links/{link_id}/restore- Restore bio link · Sign-in (OIDC) or Sign-in (session)
GET /v1/bio-links/archived- List archived bio links · Sign-in (OIDC) or Sign-in (session)
PUT /v1/bio-links/order- Reorder bio links · Sign-in (OIDC) or Sign-in (session)
GET /v1/digital-card- Get digital card · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/digital-card- Update digital card · Sign-in (OIDC) or Sign-in (session)
GET /v1/digital-card/preview- Get digital card preview · Sign-in (OIDC) or Sign-in (session)
GET /v1/public-presence- Get public presence · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/public-presence- Update public presence · Sign-in (OIDC) or Sign-in (session)
POST /v1/public-presence/publish- Publish public presence · Sign-in (OIDC) or Sign-in (session)
GET /v1/public-presence/qr.svg- Get public presence qr code · Sign-in (OIDC) or Sign-in (session)
POST /v1/public-presence/unpublish- Unpublish public presence · Sign-in (OIDC) or Sign-in (session)
GET /v1/public-profile- Get public profile content · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/public-profile- Update public profile content · Sign-in (OIDC) or Sign-in (session)
problems
Browser crashes and broken links, filed as platform problems: public write.
POST /v1/problems/browser- Report browser problem · None (public)
public
Unauthenticated public projections.
POST /v1/public/cohost-invitations/{token}/accept- Accept cohost invitation · None (public)
GET /v1/public/crawl-index- Get public crawl index · None (public)
POST /v1/public/demand-requests- Create public demand request · None (public)
GET /v1/public/demand-requests/{token}- Get public demand request · None (public)
PATCH /v1/public/demand-requests/{token}- Update public demand request · None (public)
GET /v1/public/documents/{code}- Get public document · None (public)
POST /v1/public/documents/{code}/checkout- Create public document checkout · None (public)
GET /v1/public/documents/{code}/pdf- Get public document pdf · None (public)
GET /v1/public/esign/{signing_token}- Get signing session · None (public)
POST /v1/public/esign/{signing_token}/adopt- Adopt signing signature · None (public)
POST /v1/public/esign/{signing_token}/consent- Give signing consent · None (public)
POST /v1/public/esign/{signing_token}/consent/refuse- Refuse signing consent · None (public)
POST /v1/public/esign/{signing_token}/consent/withdraw- Withdraw signing consent · None (public)
GET /v1/public/esign/{signing_token}/copies/{document_id}- Get signing link copy · None (public)
POST /v1/public/esign/{signing_token}/decline- Decline envelope · None (public)
GET /v1/public/esign/{signing_token}/documents/{document_id}- Get signing document · None (public)
PUT /v1/public/esign/{signing_token}/fields/{field_id}- Complete signing field · None (public)
POST /v1/public/esign/{signing_token}/paper-copy- Request paper copy · None (public)
GET /v1/public/esign/{signing_token}/sealed-documents/{document_id}- Get signing sealed document · None (public)
POST /v1/public/esign/{signing_token}/sign- Sign envelope · Sign-in (OIDC) or Sign-in (session)
GET /v1/public/esign/{signing_token}/signature- Get signing signature image · None (public)
GET /v1/public/esign/{signing_token}/status- Get signing link status · None (public)
GET /v1/public/estimates/{recipient_token}- Get public estimate · None (public)
POST /v1/public/estimates/{recipient_token}/accept- Accept public estimate · None (public)
POST /v1/public/estimates/{recipient_token}/reject- Reject public estimate · None (public)
POST /v1/public/event-registrations/sign-in-link- Request event registration sign in link · None (public)
GET /v1/public/events/{code}- Get public event · None (public)
GET /v1/public/events/{code}/calendar.ics- Get event calendar file · None (public)
GET /v1/public/events/{code}/door- Get door landing · None (public)
POST /v1/public/events/{code}/door/check-in- Self check in · None (public)
POST /v1/public/events/{code}/feedback/{token}- Submit event feedback · None (public)
GET /v1/public/events/{code}/map.png- Get public event map · None (public)
POST /v1/public/events/{code}/messages- Write to organizer · None (public)
GET /v1/public/events/{code}/photos- List event photos · None (public)
GET /v1/public/events/{code}/promo-codes/{promo}- Check promo code · None (public)
GET /v1/public/events/{code}/qr.svg- Get public event qr · None (public)
POST /v1/public/events/{code}/registrations- Register for event · None (public)
GET /v1/public/interface-languages- List offered interface languages · None (public)
GET /v1/public/interface-texts/{locale}- Get interface texts · None (public)
GET /v1/public/legal/{slug}- Get public legal page · None (public)
GET /v1/public/organization-events- List public organization events · None (public)
GET /v1/public/organizations- List public organizations · None (public)
GET /v1/public/organizations/{slug}/events/past- List organization past events · None (public)
GET /v1/public/organizations/{slug}/events/upcoming- List organization upcoming events · None (public)
GET /v1/public/person-photos/{photo_id}- Get public person photo · None (public)
GET /v1/public/plans- Get public plans · None (public)
GET /v1/public/preferences- Get recipient preferences · None (public)
PUT /v1/public/preferences- Update recipient preferences · None (public)
GET /v1/public/presence/{slug}- Get published presence · None (public)
GET /v1/public/presence/{slug}/profile- Get published profile content · None (public)
GET /v1/public/qrcode/{code}- Resolve qr code scan · None (public)
GET /v1/public/registrations/{token}- Get my registration · None (public)
PATCH /v1/public/registrations/{token}- Update my registration · None (public)
GET /v1/public/registrations/{token}/checkin-qr.svg- Get checkin qr · None (public)
POST /v1/public/registrations/{token}/claim- Claim waitlist place · None (public)
POST /v1/public/registrations/{token}/payment-report- Report zelle payment · None (public)
POST /v1/public/registrations/{token}/payment-report/presign- Presign zelle screenshot · None (public)
POST /v1/public/registrations/{token}/purchases- Buy more tickets · None (public)
GET /v1/public/reviews/{token}- Get public review · None (public)
POST /v1/public/reviews/{token}- Submit public review · None (public)
GET /v1/public/share-links/{code}- Get public share link · None (public)
GET /v1/public/short-ids/{code}- Get public short id · None (public)
GET /v1/public/sites/{slug}- Get published assisted site · None (public)
GET /v1/public/trust/{slug}- Get public trust · None (public)
GET /v1/public/unsubscribe- Get unsubscribe context · None (public)
POST /v1/public/unsubscribe/confirm- Confirm unsubscribe · None (public)
POST /v1/public/unsubscribe/one-click- Post list unsubscribe · None (public)
POST /v1/public/workspace-invitations/preview- Preview public workspace invitation · None (public)
POST /v1/public/workspace-invitations/sign-in-link- Request workspace invitation sign in link · None (public)
POST /v1/site/events/{code}/photos- Add event photos · None (public)
POST /v1/site/events/{code}/photos/presign- Presign event photo as contributor · None (public)
qrcode
Dynamic QR codes: minting, re-pointing, and scan analytics.
GET /v1/qrcode- List qr codes · Sign-in (OIDC) or Sign-in (session)
POST /v1/qrcode- Create qr code · Sign-in (OIDC) or Sign-in (session)
GET /v1/qrcode/{code}- Get qr code · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/qrcode/{code}- Update qr code · Sign-in (OIDC) or Sign-in (session)
GET /v1/qrcode/{code}/analytics- Get qr code analytics · Sign-in (OIDC) or Sign-in (session)
POST /v1/qrcode/{code}/archive- Archive qr code · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/qrcode/{code}/destination- Repoint qr code · Sign-in (OIDC) or Sign-in (session)
GET /v1/qrcode/{code}/history- Get qr code history · Sign-in (OIDC) or Sign-in (session)
POST /v1/qrcode/{code}/insights- Pull qr code insights · Sign-in (OIDC) or Sign-in (session)
POST /v1/qrcode/{code}/pause- Pause qr code · Sign-in (OIDC) or Sign-in (session)
GET /v1/qrcode/{code}/render- Render qr code · Sign-in (OIDC) or Sign-in (session)
POST /v1/qrcode/{code}/resume- Resume qr code · Sign-in (OIDC) or Sign-in (session)
rent
Explainable rent-intelligence evidence.
GET /v1/rent-estimates- List rent estimates · Sign-in (OIDC) or Sign-in (session)
POST /v1/rent-estimates- Create rent estimate · Sign-in (OIDC) or Sign-in (session)
reviews
Review collection and moderation.
GET /v1/review-requests- List review requests · Sign-in (OIDC) or Sign-in (session)
POST /v1/review-requests- Create review request · Sign-in (OIDC) or Sign-in (session)
GET /v1/reviews- List reviews · Sign-in (OIDC) or Sign-in (session)
POST /v1/reviews/moderation/local- Apply local review moderation · None (public)
short-ids
Platform short ids: member resolution of record codes (P.52).
GET /v1/short-ids/{code}- Get short id · Sign-in (OIDC) or Sign-in (session)
workspaces
Workspace lifecycle and membership.
GET /v1/workspace-invitations- List my workspace invitations · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspace-invitations/{invitation_id}/accept- Accept my workspace invitation · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspace-invitations/{invitation_id}/decline- Decline workspace invitation · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspace-invitations/accept- Accept workspace invitation · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspace-invitations/preview- Preview my workspace invitation · Sign-in (OIDC) or Sign-in (session)
GET /v1/workspaces- List accessible workspaces · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspaces- Create workspace · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspaces/{workspace_id}/members/me/leave- Leave workspace by id · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspaces/{workspace_id}/restore- Restore workspace · Sign-in (OIDC) or Sign-in (session)
GET /v1/workspaces/archived- List archived workspaces · Sign-in (OIDC) or Sign-in (session)
GET /v1/workspaces/create-gate- Get workspace create gate · Sign-in (OIDC) or Sign-in (session)
GET /v1/workspaces/current- Get current workspace · Sign-in (OIDC) or Sign-in (session)
PUT /v1/workspaces/current- Select current workspace · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/workspaces/current- Rename current workspace · Sign-in (OIDC) or Sign-in (session)
GET /v1/workspaces/current/app-menu-preferences- Get app menu preferences · Sign-in (OIDC) or Sign-in (session)
PUT /v1/workspaces/current/app-menu-preferences- Update app menu preferences · Sign-in (OIDC) or Sign-in (session)
GET /v1/workspaces/current/app-settings/{app}- Get app settings · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/workspaces/current/app-settings/{app}- Update app settings · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspaces/current/archive- Archive current workspace · Sign-in (OIDC) or Sign-in (session)
GET /v1/workspaces/current/assisted-site- Get current assisted site · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspaces/current/assisted-site/draft- Generate assisted site draft · Sign-in (OIDC) or Sign-in (session)
GET /v1/workspaces/current/content-languages- Get workspace content languages · Sign-in (OIDC) or Sign-in (session)
PUT /v1/workspaces/current/content-languages- Set workspace content languages · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspaces/current/content-languages/{code}- Add workspace content language · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/workspaces/current/content-languages/{code}- Remove workspace content language · Sign-in (OIDC) or Sign-in (session)
GET /v1/workspaces/current/content-languages/{code}/price- Get content language price · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspaces/current/delete- Delete current workspace · Sign-in (OIDC) or Sign-in (session)
GET /v1/workspaces/current/feature-gates/{app}/{feature}- Get feature gate · Sign-in (OIDC) or Sign-in (session)
GET /v1/workspaces/current/invitations- List workspace invitations · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspaces/current/invitations- Issue workspace invitation · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/workspaces/current/invitations/{invitation_id}- Change workspace invitation role · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/workspaces/current/invitations/{invitation_id}- Revoke workspace invitation · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspaces/current/invitations/{invitation_id}/reassign- Reassign workspace invitation · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspaces/current/invitations/{invitation_id}/resend- Resend workspace invitation · Sign-in (OIDC) or Sign-in (session)
GET /v1/workspaces/current/members- List workspace members · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/workspaces/current/members/{membership_id}- Update workspace member · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/workspaces/current/members/{membership_id}- Remove workspace member · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspaces/current/members/{membership_id}/second-factor/reset- Reset member second factor · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspaces/current/members/me/leave- Leave workspace · Sign-in (OIDC) or Sign-in (session)
GET /v1/workspaces/current/roles- List workspace roles · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspaces/current/roles- Create workspace role · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/workspaces/current/roles/{role_id}- Rename workspace role · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/workspaces/current/roles/{role_id}- Delete workspace role · Sign-in (OIDC) or Sign-in (session)
PUT /v1/workspaces/current/roles/{role_id}/access- Set workspace role access · Sign-in (OIDC) or Sign-in (session)
PUT /v1/workspaces/current/roles/{role_id}/position- Move workspace role · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspaces/current/roles/one-app- Grant one app role · Sign-in (OIDC) or Sign-in (session)
PUT /v1/workspaces/current/roles/standard/{token}/access- Set standard role access · Sign-in (OIDC) or Sign-in (session)
DELETE /v1/workspaces/current/roles/standard/{token}/access- Reset standard role · Sign-in (OIDC) or Sign-in (session)
GET /v1/workspaces/current/second-factor/administrators- List administrator second factors · Sign-in (OIDC) or Sign-in (session)
GET /v1/workspaces/current/settings- Get workspace settings · Sign-in (OIDC) or Sign-in (session)
PATCH /v1/workspaces/current/settings- Update workspace settings · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspaces/current/stripe-connect/dashboard- Get stripe connect dashboard · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspaces/current/stripe-connect/existing/complete- Complete stripe existing connect · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspaces/current/stripe-connect/existing/initiate- Initiate stripe existing connect · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspaces/current/stripe-connect/initiate- Initiate stripe connect · Sign-in (OIDC) or Sign-in (session)
GET /v1/workspaces/current/stripe-connect/status- Get stripe connect status · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspaces/current/translations- Start translation job · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspaces/current/translations/cost- Preview translation cost · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspaces/current/translations/field- Translate field · Sign-in (OIDC) or Sign-in (session)
GET /v1/workspaces/current/translations/jobs/{job_id}- Get translation job · Sign-in (OIDC) or Sign-in (session)
GET /v1/workspaces/current/translations/jobs/{job_id}/fields- List translation job fields · Sign-in (OIDC) or Sign-in (session)
PUT /v1/workspaces/current/translations/sources- Write translation sources · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspaces/current/translations/sources/delete- Delete translation sources · Sign-in (OIDC) or Sign-in (session)
GET /v1/workspaces/current/translations/stored- List stored translations · Sign-in (OIDC) or Sign-in (session)
PUT /v1/workspaces/current/translations/stored/{source_id}/{locale}- Edit stored translation · Sign-in (OIDC) or Sign-in (session)
POST /v1/workspaces/current/translations/stored/{source_id}/{locale}/redraft- Redraft stored translation · Sign-in (OIDC) or Sign-in (session)
PUT /v1/workspaces/onboarding- Onboard workspace · Sign-in (OIDC) or Sign-in (session)
Where the keys live:Settings › API Access in your workspace — create, label, scope and revoke keys there; the TEST label marks every sandbox key.