# AppEngine API Documentation > Comprehensive API documentation for the AppEngine platform Version 1.0 · 3153 endpoints · 173 sections. The OpenAPI document is at https://appengine.appmint.io/documentation-json. The browsable version is at https://appengine.appmint.io/documentation. ## Authentication Every request is scoped to a tenant by the `orgid` header — there is no path prefix for it. | Header | Carries | | --- | --- | | `orgid` | The organization id. Required on essentially every route. | | `Authorization: Bearer ` | The staff user, from `POST /user/signin`. | | `x-client-authorization: Bearer ` | The customer, from `POST /customer/signin`. A separate identity — some routes want both at once. | ## Sections - [Affiliate](https://appengine.appmint.io/documentation/tag/affiliate.md) — 33 endpoints - [Affiliate · My account](https://appengine.appmint.io/documentation/tag/affiliate-my-account.md) — 7 endpoints - [Affiliate · Public](https://appengine.appmint.io/documentation/tag/affiliate-public.md) — 3 endpoints - [AI](https://appengine.appmint.io/documentation/tag/ai.md) — 11 endpoints - [AI Agent](https://appengine.appmint.io/documentation/tag/ai-agent.md) — 2 endpoints - [AI Employees](https://appengine.appmint.io/documentation/tag/ai-employees.md) — 45 endpoints - [Analytics](https://appengine.appmint.io/documentation/tag/analytics.md) — 28 endpoints - [API reference](https://appengine.appmint.io/documentation/tag/api-reference.md) — 14 endpoints - [App](https://appengine.appmint.io/documentation/tag/app.md) — 6 endpoints - [Approval](https://appengine.appmint.io/documentation/tag/approval.md) — 9 endpoints - [Automation](https://appengine.appmint.io/documentation/tag/automation.md) — 23 endpoints - [Broadcast](https://appengine.appmint.io/documentation/tag/broadcast.md) — 27 endpoints - [Broadcast Client](https://appengine.appmint.io/documentation/tag/broadcast-client.md) — 1 endpoints - [Business Made - Journeys](https://appengine.appmint.io/documentation/tag/business-made-journeys.md) — 29 endpoints - [Business Made · Bank feeds](https://appengine.appmint.io/documentation/tag/business-made-bank-feeds.md) — 12 endpoints - [Business Made · Bank reconciliation](https://appengine.appmint.io/documentation/tag/business-made-bank-reconciliation.md) — 7 endpoints - [Business Made · Benefits](https://appengine.appmint.io/documentation/tag/business-made-benefits.md) — 27 endpoints - [Business Made · Bills](https://appengine.appmint.io/documentation/tag/business-made-bills.md) — 16 endpoints - [Business Made · Books](https://appengine.appmint.io/documentation/tag/business-made-books.md) — 31 endpoints - [Business Made · Compensation](https://appengine.appmint.io/documentation/tag/business-made-compensation.md) — 40 endpoints - [Business Made · Documents](https://appengine.appmint.io/documentation/tag/business-made-documents.md) — 34 endpoints - [Business Made · Filings](https://appengine.appmint.io/documentation/tag/business-made-filings.md) — 13 endpoints - [Business Made · Government e-filing](https://appengine.appmint.io/documentation/tag/business-made-government-e-filing.md) — 13 endpoints - [Business Made · Government forms](https://appengine.appmint.io/documentation/tag/business-made-government-forms.md) — 18 endpoints - [Business Made · Insights](https://appengine.appmint.io/documentation/tag/business-made-insights.md) — 2 endpoints - [Business Made · Learning](https://appengine.appmint.io/documentation/tag/business-made-learning.md) — 32 endpoints - [Business Made · Leave](https://appengine.appmint.io/documentation/tag/business-made-leave.md) — 56 endpoints - [Business Made · Offboarding](https://appengine.appmint.io/documentation/tag/business-made-offboarding.md) — 24 endpoints - [Business Made · Organization](https://appengine.appmint.io/documentation/tag/business-made-organization.md) — 39 endpoints - [Business Made · Payroll](https://appengine.appmint.io/documentation/tag/business-made-payroll.md) — 34 endpoints - [Business Made · Payroll config](https://appengine.appmint.io/documentation/tag/business-made-payroll-config.md) — 28 endpoints - [Business Made · People](https://appengine.appmint.io/documentation/tag/business-made-people.md) — 35 endpoints - [Business Made · Performance](https://appengine.appmint.io/documentation/tag/business-made-performance.md) — 32 endpoints - [Business Made · Period close](https://appengine.appmint.io/documentation/tag/business-made-period-close.md) — 11 endpoints - [Business Made · Readiness](https://appengine.appmint.io/documentation/tag/business-made-readiness.md) — 25 endpoints - [Business Made · Readiness AI](https://appengine.appmint.io/documentation/tag/business-made-readiness-ai.md) — 8 endpoints - [Business Made · Readiness gates](https://appengine.appmint.io/documentation/tag/business-made-readiness-gates.md) — 4 endpoints - [Business Made · Recruitment](https://appengine.appmint.io/documentation/tag/business-made-recruitment.md) — 39 endpoints - [Business Made · Schedules](https://appengine.appmint.io/documentation/tag/business-made-schedules.md) — 36 endpoints - [Business Made · Setup](https://appengine.appmint.io/documentation/tag/business-made-setup.md) — 13 endpoints - [Business Made · Tax](https://appengine.appmint.io/documentation/tag/business-made-tax.md) — 13 endpoints - [Business Made · Timesheets](https://appengine.appmint.io/documentation/tag/business-made-timesheets.md) — 26 endpoints - [Business Made · Training](https://appengine.appmint.io/documentation/tag/business-made-training.md) — 14 endpoints - [Business Made · Work orders](https://appengine.appmint.io/documentation/tag/business-made-work-orders.md) — 13 endpoints - [Chat](https://appengine.appmint.io/documentation/tag/chat.md) — 24 endpoints. Chat and messaging endpoints - [Check-in](https://appengine.appmint.io/documentation/tag/check-in.md) — 16 endpoints - [Client Account](https://appengine.appmint.io/documentation/tag/client-account.md) — 60 endpoints - [Client Account · Payment links](https://appengine.appmint.io/documentation/tag/client-account-payment-links.md) — 3 endpoints - [Comments](https://appengine.appmint.io/documentation/tag/comments.md) — 10 endpoints - [Community](https://appengine.appmint.io/documentation/tag/community.md) — 54 endpoints - [Community · Client](https://appengine.appmint.io/documentation/tag/community-client.md) — 56 endpoints - [Community · Topics](https://appengine.appmint.io/documentation/tag/community-topics.md) — 8 endpoints - [Connect](https://appengine.appmint.io/documentation/tag/connect.md) — 5 endpoints. Integration and connection endpoints - [Content Studio · Participant](https://appengine.appmint.io/documentation/tag/content-studio-participant.md) — 6 endpoints - [Content Studio · Staff](https://appengine.appmint.io/documentation/tag/content-studio-staff.md) — 8 endpoints - [Content Studio Client](https://appengine.appmint.io/documentation/tag/content-studio-client.md) — 1 endpoints - [Courses](https://appengine.appmint.io/documentation/tag/courses.md) — 1 endpoints - [Creative Studio](https://appengine.appmint.io/documentation/tag/creative-studio.md) — 7 endpoints - [CRM](https://appengine.appmint.io/documentation/tag/crm.md) — 2 endpoints. Customer Relationship Management endpoints - [CRM · Activity](https://appengine.appmint.io/documentation/tag/crm-activity.md) — 6 endpoints - [CRM · Ads](https://appengine.appmint.io/documentation/tag/crm-ads.md) — 35 endpoints - [CRM · AI](https://appengine.appmint.io/documentation/tag/crm-ai.md) — 15 endpoints - [CRM · Alerts](https://appengine.appmint.io/documentation/tag/crm-alerts.md) — 2 endpoints - [CRM · Audiences](https://appengine.appmint.io/documentation/tag/crm-audiences.md) — 14 endpoints - [CRM · Auto-campaign](https://appengine.appmint.io/documentation/tag/crm-auto-campaign.md) — 11 endpoints - [CRM · Benefits](https://appengine.appmint.io/documentation/tag/crm-benefits.md) — 5 endpoints - [CRM · Chat](https://appengine.appmint.io/documentation/tag/crm-chat.md) — 4 endpoints - [CRM · Communications](https://appengine.appmint.io/documentation/tag/crm-communications.md) — 14 endpoints - [CRM · Customers](https://appengine.appmint.io/documentation/tag/crm-customers.md) — 2 endpoints - [CRM · Documents](https://appengine.appmint.io/documentation/tag/crm-documents.md) — 13 endpoints - [CRM · Events](https://appengine.appmint.io/documentation/tag/crm-events.md) — 4 endpoints - [CRM · Forms](https://appengine.appmint.io/documentation/tag/crm-forms.md) — 10 endpoints - [CRM · Inbox](https://appengine.appmint.io/documentation/tag/crm-inbox.md) — 10 endpoints - [CRM · Leads](https://appengine.appmint.io/documentation/tag/crm-leads.md) — 26 endpoints - [CRM · Marketing](https://appengine.appmint.io/documentation/tag/crm-marketing.md) — 38 endpoints - [CRM · Merchant accounts](https://appengine.appmint.io/documentation/tag/crm-merchant-accounts.md) — 34 endpoints - [CRM · Pipelines](https://appengine.appmint.io/documentation/tag/crm-pipelines.md) — 10 endpoints - [CRM · Promotions](https://appengine.appmint.io/documentation/tag/crm-promotions.md) — 11 endpoints - [CRM · Reservations](https://appengine.appmint.io/documentation/tag/crm-reservations.md) — 21 endpoints - [CRM · Shared accounts](https://appengine.appmint.io/documentation/tag/crm-shared-accounts.md) — 8 endpoints - [CRM · Social](https://appengine.appmint.io/documentation/tag/crm-social.md) — 24 endpoints - [CRM · Templates](https://appengine.appmint.io/documentation/tag/crm-templates.md) — 3 endpoints - [CRM · Tickets](https://appengine.appmint.io/documentation/tag/crm-tickets.md) — 23 endpoints - [Customer 360](https://appengine.appmint.io/documentation/tag/customer-360.md) — 1 endpoints - [Data enrichment](https://appengine.appmint.io/documentation/tag/data-enrichment.md) — 9 endpoints - [Device integrations](https://appengine.appmint.io/documentation/tag/device-integrations.md) — 11 endpoints - [Events](https://appengine.appmint.io/documentation/tag/events.md) — 55 endpoints - [Events · Attendee](https://appengine.appmint.io/documentation/tag/events-attendee.md) — 24 endpoints - [Finance · ACH batches](https://appengine.appmint.io/documentation/tag/finance-ach-batches.md) — 7 endpoints - [Finance · My account](https://appengine.appmint.io/documentation/tag/finance-my-account.md) — 10 endpoints - [Finance · Payments](https://appengine.appmint.io/documentation/tag/finance-payments.md) — 13 endpoints - [Finance · Payouts](https://appengine.appmint.io/documentation/tag/finance-payouts.md) — 15 endpoints - [Finance · Wallets](https://appengine.appmint.io/documentation/tag/finance-wallets.md) — 14 endpoints - [Forms Client](https://appengine.appmint.io/documentation/tag/forms-client.md) — 3 endpoints - [Handling](https://appengine.appmint.io/documentation/tag/handling.md) — 5 endpoints - [Kubernetes](https://appengine.appmint.io/documentation/tag/kubernetes.md) — 10 endpoints - [Logistics](https://appengine.appmint.io/documentation/tag/logistics.md) — 52 endpoints - [Logistics · Customer](https://appengine.appmint.io/documentation/tag/logistics-customer.md) — 18 endpoints - [Logistics · Driver](https://appengine.appmint.io/documentation/tag/logistics-driver.md) — 36 endpoints - [Monitoring](https://appengine.appmint.io/documentation/tag/monitoring.md) — 13 endpoints - [Notes](https://appengine.appmint.io/documentation/tag/notes.md) — 2 endpoints - [Notices](https://appengine.appmint.io/documentation/tag/notices.md) — 10 endpoints - [Organization](https://appengine.appmint.io/documentation/tag/organization.md) — 71 endpoints - [Phone](https://appengine.appmint.io/documentation/tag/phone.md) — 36 endpoints - [Platform](https://appengine.appmint.io/documentation/tag/platform.md) — 5 endpoints - [Print](https://appengine.appmint.io/documentation/tag/print.md) — 4 endpoints - [Repository](https://appengine.appmint.io/documentation/tag/repository.md) — 36 endpoints. Data repository and file management endpoints - [Repository · Assets](https://appengine.appmint.io/documentation/tag/repository-assets.md) — 4 endpoints - [Repository · Files](https://appengine.appmint.io/documentation/tag/repository-files.md) — 27 endpoints - [Repository · History](https://appengine.appmint.io/documentation/tag/repository-history.md) — 2 endpoints - [Repository · Media](https://appengine.appmint.io/documentation/tag/repository-media.md) — 4 endpoints - [Repository · Migration](https://appengine.appmint.io/documentation/tag/repository-migration.md) — 4 endpoints - [Repository · Organizations](https://appengine.appmint.io/documentation/tag/repository-organizations.md) — 9 endpoints - [Repository · Settings](https://appengine.appmint.io/documentation/tag/repository-settings.md) — 3 endpoints - [Repository · Workflow](https://appengine.appmint.io/documentation/tag/repository-workflow.md) — 5 endpoints - [Sales channels](https://appengine.appmint.io/documentation/tag/sales-channels.md) — 68 endpoints - [Shipping](https://appengine.appmint.io/documentation/tag/shipping.md) — 28 endpoints - [Shipping · Admin](https://appengine.appmint.io/documentation/tag/shipping-admin.md) — 13 endpoints - [Site](https://appengine.appmint.io/documentation/tag/site.md) — 30 endpoints - [Site · Dev environments](https://appengine.appmint.io/documentation/tag/site-dev-environments.md) — 15 endpoints - [Staff directory](https://appengine.appmint.io/documentation/tag/staff-directory.md) — 2 endpoints - [Staff portal](https://appengine.appmint.io/documentation/tag/staff-portal.md) — 43 endpoints - [Staff Portal · Forms](https://appengine.appmint.io/documentation/tag/staff-portal-forms.md) — 3 endpoints - [Staff Portal · Training](https://appengine.appmint.io/documentation/tag/staff-portal-training.md) — 15 endpoints - [Stats](https://appengine.appmint.io/documentation/tag/stats.md) — 12 endpoints - [Storefront](https://appengine.appmint.io/documentation/tag/storefront.md) — 10 endpoints. E-commerce and storefront management endpoints - [Storefront · Cart](https://appengine.appmint.io/documentation/tag/storefront-cart.md) — 3 endpoints - [Storefront · Checkout](https://appengine.appmint.io/documentation/tag/storefront-checkout.md) — 4 endpoints - [Storefront · Discounts](https://appengine.appmint.io/documentation/tag/storefront-discounts.md) — 15 endpoints - [Storefront · Gift cards](https://appengine.appmint.io/documentation/tag/storefront-gift-cards.md) — 44 endpoints - [Storefront · Inventory](https://appengine.appmint.io/documentation/tag/storefront-inventory.md) — 19 endpoints - [Storefront · Invoices](https://appengine.appmint.io/documentation/tag/storefront-invoices.md) — 21 endpoints - [Storefront · Orders](https://appengine.appmint.io/documentation/tag/storefront-orders.md) — 15 endpoints - [Storefront · Payments](https://appengine.appmint.io/documentation/tag/storefront-payments.md) — 13 endpoints - [Storefront · POS](https://appengine.appmint.io/documentation/tag/storefront-pos.md) — 23 endpoints - [Storefront · Pricing](https://appengine.appmint.io/documentation/tag/storefront-pricing.md) — 10 endpoints - [Storefront · Rentals](https://appengine.appmint.io/documentation/tag/storefront-rentals.md) — 28 endpoints - [Storefront · Returns](https://appengine.appmint.io/documentation/tag/storefront-returns.md) — 15 endpoints - [Storefront · Social](https://appengine.appmint.io/documentation/tag/storefront-social.md) — 3 endpoints - [Storefront · Subscriptions](https://appengine.appmint.io/documentation/tag/storefront-subscriptions.md) — 3 endpoints - [Storefront · Sync](https://appengine.appmint.io/documentation/tag/storefront-sync.md) — 8 endpoints - [Storefront · Tax](https://appengine.appmint.io/documentation/tag/storefront-tax.md) — 7 endpoints - [Storefront · Workflows](https://appengine.appmint.io/documentation/tag/storefront-workflows.md) — 2 endpoints - [Stowbo · Browse](https://appengine.appmint.io/documentation/tag/stowbo-browse.md) — 12 endpoints - [Stowbo · Calendar](https://appengine.appmint.io/documentation/tag/stowbo-calendar.md) — 7 endpoints - [Stowbo · Custody](https://appengine.appmint.io/documentation/tag/stowbo-custody.md) — 8 endpoints - [Stowbo · Discounts](https://appengine.appmint.io/documentation/tag/stowbo-discounts.md) — 5 endpoints - [Stowbo · Fees](https://appengine.appmint.io/documentation/tag/stowbo-fees.md) — 2 endpoints - [Stowbo · Guest](https://appengine.appmint.io/documentation/tag/stowbo-guest.md) — 34 endpoints - [Stowbo · Host](https://appengine.appmint.io/documentation/tag/stowbo-host.md) — 74 endpoints - [Stowbo · Ledger](https://appengine.appmint.io/documentation/tag/stowbo-ledger.md) — 5 endpoints - [Stowbo · Money](https://appengine.appmint.io/documentation/tag/stowbo-money.md) — 11 endpoints - [Stowbo · Oversight](https://appengine.appmint.io/documentation/tag/stowbo-oversight.md) — 12 endpoints - [Stowbo · Pickups](https://appengine.appmint.io/documentation/tag/stowbo-pickups.md) — 5 endpoints - [Stowbo · Setup](https://appengine.appmint.io/documentation/tag/stowbo-setup.md) — 5 endpoints - [Stowbo · Stay](https://appengine.appmint.io/documentation/tag/stowbo-stay.md) — 8 endpoints - [Sync](https://appengine.appmint.io/documentation/tag/sync.md) — 11 endpoints. Data synchronization endpoints - [Sync · Queues](https://appengine.appmint.io/documentation/tag/sync-queues.md) — 17 endpoints - [Tools](https://appengine.appmint.io/documentation/tag/tools.md) — 38 endpoints - [Upstream](https://appengine.appmint.io/documentation/tag/upstream.md) — 13 endpoints. Upstream data flow endpoints - [Usage](https://appengine.appmint.io/documentation/tag/usage.md) — 13 endpoints - [Usage · Platform admin](https://appengine.appmint.io/documentation/tag/usage-platform-admin.md) — 4 endpoints - [Usage · Service pricing](https://appengine.appmint.io/documentation/tag/usage-service-pricing.md) — 10 endpoints - [Users](https://appengine.appmint.io/documentation/tag/users.md) — 2 endpoints. User management and authentication endpoints - [Users · Administration](https://appengine.appmint.io/documentation/tag/users-administration.md) — 56 endpoints - [Users · API keys](https://appengine.appmint.io/documentation/tag/users-api-keys.md) — 13 endpoints - [Users · Authentication](https://appengine.appmint.io/documentation/tag/users-authentication.md) — 114 endpoints - [Users · Customers](https://appengine.appmint.io/documentation/tag/users-customers.md) — 38 endpoints - [Users · Profiles](https://appengine.appmint.io/documentation/tag/users-profiles.md) — 18 endpoints - [Users · Security](https://appengine.appmint.io/documentation/tag/users-security.md) — 20 endpoints - [Voice](https://appengine.appmint.io/documentation/tag/voice.md) — 2 endpoints - [Workflow](https://appengine.appmint.io/documentation/tag/workflow.md) — 29 endpoints - [Workspace](https://appengine.appmint.io/documentation/tag/workspace.md) — 40 endpoints ## Every endpoint ### Affiliate - `GET /affiliate/affiliates` — List affiliates - `POST /affiliate/affiliates` — Create an affiliate - `GET /affiliate/affiliates/{id}` — Get an affiliate - `POST /affiliate/affiliates/{id}/approve` — Approve an affiliate - `POST /affiliate/affiliates/{id}/codes` — Add a referral code to an affiliate - `PUT /affiliate/affiliates/{id}/codes/primary` — Choose the main code - `POST /affiliate/affiliates/{id}/codes/reset` — Issue a new code - `POST /affiliate/affiliates/{id}/codes/send` — Send an affiliate their code - `PUT /affiliate/affiliates/{id}/codes/status` — Retire, disable or reactivate a code - `PUT /affiliate/affiliates/{id}/commission-override` — Override an affiliate's commission - `POST /affiliate/affiliates/{id}/reactivate` — Reactivate an affiliate - `POST /affiliate/affiliates/{id}/reject` — Decline an affiliate application - `POST /affiliate/affiliates/{id}/suspend` — Suspend an affiliate - `GET /affiliate/codes/check` — Check a referral code - `POST /affiliate/commissions/process-held` — Process held commissions - `POST /affiliate/links/generate` — Generate an affiliate link - `GET /affiliate/programs` — List affiliate programs - `POST /affiliate/programs` — Create an affiliate program - `GET /affiliate/programs/{name}` — Get an affiliate program - `PUT /affiliate/programs/{name}` — Update an affiliate program - `GET /affiliate/referrals` — List referrals - `GET /affiliate/referrals/{id}` — Get a referral - `POST /affiliate/referrals/{id}/approve` — Approve a referral (legacy) - `POST /affiliate/referrals/{id}/reject` — Reject a referral (legacy) - `POST /affiliate/referrals/{id}/transition` — Transition a referral - `GET /affiliate/referrals/audit/report` — Run a referral data-quality audit - `POST /affiliate/referrals/bulk-transition` — Transition referrals in bulk - `POST /affiliate/referrals/expire-stale` — Expire stale referrals - `GET /affiliate/stats` — Get affiliate statistics - `GET /affiliate/stats/affiliate/{affiliateId}` — Get affiliate statistics - `GET /affiliate/stats/program/{programName}` — Get program statistics - `GET /affiliate/stats/top-affiliates` — Get top affiliates - `POST /affiliate/test/attribute-order` — Test order attribution ### Affiliate · My account - `POST /client/affiliate/join` — Join an affiliate program - `GET /client/affiliate/me` — Get my affiliate account - `GET /client/affiliate/me/earnings` — Get my earnings - `GET /client/affiliate/me/link` — Get my affiliate link - `POST /client/affiliate/me/link` — Create my affiliate link - `GET /client/affiliate/me/referrals` — Get my referrals - `GET /client/affiliate/programs` — List joinable programs ### Affiliate · Public - `POST /affiliate/public/apply-code` — Apply a referral code at checkout - `GET /affiliate/public/resolve/{code}` — Resolve a referral code - `POST /affiliate/public/track` — Track a referral click ### AI - `POST /ai/agent/chat` — Chat with an AI agent - `POST /ai/agent/stream` — Start a streaming chat - `POST /ai/chat` — Chat with AI - `POST /ai/generate/image` — Generate an image - `POST /ai/generate/image/edit` — Edit an image (deprecated) **(deprecated)** - `POST /ai/generate/image/variations` — Generate image variations (deprecated) **(deprecated)** - `POST /ai/generate/video` — Generate a video - `POST /ai/mcp/execute` — Execute an MCP tool - `GET /ai/mcp/tools` — List MCP tools - `GET /ai/stream/{streamId}` — Read a stream - `POST /ai/ui/ack` — Confirm a UI action landed ### AI Agent - `GET /ai/agent/setup` — The AI Agent's setup - `POST /ai/agent/setup/enable` — Turn on voice for the AI Agent ### AI Employees - `GET /ai-employees` — List AI employees - `POST /ai-employees` — Hire an AI employee - `DELETE /ai-employees/{name}` — Remove an AI employee - `GET /ai-employees/{name}` — Get an AI employee - `PUT /ai-employees/{name}` — Change an AI employee - `GET /ai-employees/{name}/access` — Get its access - `PUT /ai-employees/{name}/access` — Set its access - `POST /ai-employees/{name}/budget` — Adjust today's budget - `POST /ai-employees/{name}/handover/sign-in` — Issue a sign-in for the system that runs it - `GET /ai-employees/{name}/instructions` — Everything an employee is told - `GET /ai-employees/{name}/memory` — Get its working memory - `POST /ai-employees/{name}/memory/forget-sessions` — Drop the conversations it would resume - `POST /ai-employees/{name}/memory/notes/remove` — Remove notes from its memory - `POST /ai-employees/{name}/pause` — Pause it - `POST /ai-employees/{name}/phones` — Assign a phone number, or release it - `GET /ai-employees/{name}/provider-status` — Ask its provider whether the agent is running - `POST /ai-employees/{name}/provision` — Create the agent on its provider - `POST /ai-employees/{name}/restart` — Restart it - `POST /ai-employees/{name}/shut-down` — Shut it down - `POST /ai-employees/{name}/switch-on` — Switch it on - `POST /ai-employees/{name}/work` — Give an employee work - `GET /ai-employees/config` — Get the org's AI employee settings - `PUT /ai-employees/config` — Save the org's AI employee settings - `GET /ai-employees/instructions` — Get the org's instructions to its AI employees - `PUT /ai-employees/instructions` — Replace the org's instructions - `GET /ai-employees/me/briefing` — Get its briefing - `POST /ai-employees/me/hello` — Say hello from its runtime - `GET /ai-employees/team` — Get the AI team workspace - `PUT /ai-employees/team` — Set the AI team workspace - `GET /ai-employees/templates` — List templates to hire from - `PUT /ai-employees/templates` — Save one of the org's templates - `DELETE /ai-employees/templates/{name}` — Delete one of the org's templates - `GET /ai-employees/templates/{name}` — Get one template - `GET /ai-employees/work` — List work items - `GET /ai-employees/work/{id}` — Get a work item - `POST /ai-employees/work/{id}/cancel` — Cancel a work item - `POST /ai-employees/work/{id}/decide` — Approve or reject a request - `POST /ai-employees/work/{id}/retry` — Put failed or cancelled work back in the queue - `GET /ai-employees/work/approvals` — List what waits for an approval - `POST /ai-employees/worker/{name}/lease` — Lease the next job - `GET /ai-employees/worker/{name}/summary` — What an employee did over a period - `POST /ai-employees/worker/work/{id}/approval` — Ask for approval before an action - `POST /ai-employees/worker/work/{id}/complete` — Finish a job - `POST /ai-employees/worker/work/{id}/fail` — Report a failed attempt - `POST /ai-employees/worker/work/{id}/step` — Report a step on a job ### Analytics - `GET /analytics` — Get analytics data - `GET /analytics/attribution` — Get revenue attribution - `GET /analytics/automation` — Get automation analytics - `GET /analytics/blog` — Get blog analytics - `GET /analytics/dashboard/{dashboardType}/refresh` — Refresh a dashboard - `GET /analytics/dashboard/all` — Get all dashboard data - `GET /analytics/dashboard/automation` — Get automation analytics - `GET /analytics/dashboard/blog` — Get blog analytics - `GET /analytics/dashboard/leads` — Get leads analytics - `GET /analytics/dashboard/social` — Get social media analytics - `GET /analytics/dashboard/storefront` — Get storefront analytics - `GET /analytics/dashboard/tickets` — Get ticket analytics - `GET /analytics/dashboard/users` — Get user account analytics - `GET /analytics/dashboard/website` — Get website analytics - `GET /analytics/dashboard/workflow` — Get workflow analytics - `GET /analytics/email` — Get email analytics - `POST /analytics/export` — Export analytics data - `GET /analytics/filter-options` — Get filter options - `GET /analytics/leads` — Get leads analytics - `GET /analytics/live-view` — Get Live View - `GET /analytics/live-view/{deviceId}/journey` — Get a visitor journey - `GET /analytics/storefront` — Get storefront analytics - `POST /analytics/storefront/orders` — Get the order dashboard - `GET /analytics/tickets` — Get ticket analytics - `GET /analytics/users` — Get user account analytics - `GET /analytics/website` — Get website analytics - `GET /analytics/workflow` — Get workflow analytics - `GET /studio-overview/{section}` — Get a Studio section overview ### API reference - `GET /api-docs` — Redirect /api-docs to the reference - `GET /docs` — Redirect /docs to the reference - `GET /documentation` — The API reference page - `GET /documentation-json` — The OpenAPI document - `GET /documentation.md` — Every endpoint, one line each - `GET /documentation/endpoint` — One endpoint in full - `GET /documentation/index.json` — The reference's navigation index - `GET /documentation/search` — Find endpoints by phrase - `GET /documentation/tag/{slug}.json` — One section as an OpenAPI document - `GET /documentation/tag/{slug}.md` — One section in full, as markdown - `GET /llms.txt` — What this API is, for agents - `GET /openapi.json` — The OpenAPI document - `GET /robots.txt` — Crawler rules - `GET /swagger` — Redirect /swagger to the reference ### App - `DELETE /` - `HEAD /` - `OPTIONS /` - `PATCH /` - `POST /` - `PUT /` ### Approval - `POST /approval/ask` — Ask for access, or for a guarded operation - `GET /approval/history` — Get my decided approvals - `POST /approval/notices/{id}/read` — Mark one notice read - `POST /approval/notices/read` — Mark all my notices read - `POST /approval/request/{id}/cancel` — Withdraw my access request - `POST /approval/setup` — Set up access requests - `POST /approval/task/{taskId}/approve` — Approve - `POST /approval/task/{taskId}/reject` — Reject - `GET /approval/tray` — Get my approval tray ### Automation - `GET /automation` — List automations - `POST /automation` — Create an automation - `DELETE /automation/{automationId}` — Delete an automation - `GET /automation/{automationId}` — Get an automation - `PUT /automation/{automationId}` — Update an automation - `GET /automation/{automationId}/check` — Check an automation before running it - `POST /automation/{automationId}/execute` — Execute an automation now - `GET /automation/{automationId}/monitor` — Monitor an automation - `GET /automation/{automationId}/runs` — Run log - `GET /automation/{automationId}/steps/{stepId}/outcomes` — One step across runs - `POST /automation/ai/generate` — Generate an automation from a description - `POST /automation/ai/improve` — Suggest automation improvements - `POST /automation/ai/templates` — Get automation templates - `POST /automation/ai/validate` — Validate an automation - `GET /automation/dashboard/stats` — Get automation statistics - `GET /automation/execution/history` — Get execution history - `GET /automation/executions/{executionId}` — Get a run - `POST /automation/executions/{executionId}/cancel` — Stop a run - `POST /automation/executions/{executionId}/retry` — Run it again - `GET /automation/health` — Get automation health - `POST /automation/start/{automationId}` — Start an automation - `GET /automation/status/{automationId}` — Get an automation's status - `POST /automation/stop/{automationId}` — Stop an automation ### Broadcast - `POST /broadcast/{id}/cancel` — Cancel a broadcast - `POST /broadcast/{id}/duplicate` — Duplicate a broadcast - `GET /broadcast/{id}/report` — Get a broadcast report - `POST /broadcast/{id}/send` — Send a broadcast - `GET /broadcast/{id}/stats` — Get broadcast statistics - `POST /broadcast/accounts/{id}/test` — Test a sending account - `GET /broadcast/activity` — Get email activity - `GET /broadcast/activity/{messageId}` — Get one message's activity - `POST /broadcast/audience/count` — Audience size per list - `GET /broadcast/channel-stats` — Per-channel stats - `POST /broadcast/domains/auto-configure` — Auto-configure sending DNS - `GET /broadcast/domains/email-status/{email}` — Check an address's verification - `POST /broadcast/domains/register` — Register a sending domain - `POST /broadcast/domains/register-email` — Register a sending address - `DELETE /broadcast/domains/register/{domain}` — Unregister a domain - `GET /broadcast/domains/status/{domain}` — Check a domain's status - `GET /broadcast/health` — Get sending health - `POST /broadcast/health/{accountId}/check` — Run a health check on an account - `GET /broadcast/sent` — List sent messages - `GET /broadcast/sent/{messageId}` — Get a sent message - `GET /broadcast/stats` — Get email statistics - `GET /broadcast/stats/summary` — Get a statistics summary - `GET /broadcast/suppression` — Suppression list - `POST /broadcast/suppression/remove` — Remove an address from suppression - `GET /broadcast/unsubscribe` — Unsubscribe from a bulk email link - `GET /broadcast/validate/domain/{domain}` — Validate a domain - `GET /broadcast/validate/email/{email}` — Validate an email address ### Broadcast Client - `POST /client/broadcast/unsubscribe` — Unsubscribe an address (unsubscribe page) ### Business Made - Journeys - `GET /business-made/journeys` — The journeys board - `POST /business-made/journeys` — Start a journey - `GET /business-made/journeys/{id}` — A journey with its stages and tasks - `PUT /business-made/journeys/{id}/buddy` — Set a journey's buddy - `POST /business-made/journeys/{id}/cancel` — Cancel a journey - `POST /business-made/journeys/{id}/replan` — Re-plan a journey - `POST /business-made/journeys/{id}/unlock-preboarding` — Open pre-boarding by hand - `PUT /business-made/journeys/{id}/welcome` — Set a journey's welcome page - `GET /business-made/journeys/accounts/{employeeId}` — A person's accounts in other apps - `GET /business-made/journeys/cohorts` — List cohorts - `POST /business-made/journeys/cohorts` — Start a cohort - `GET /business-made/journeys/cohorts/{cohortId}` — One cohort with its journeys - `POST /business-made/journeys/cohorts/{cohortId}/cancel` — Cancel a cohort - `POST /business-made/journeys/cohorts/{cohortId}/reschedule` — Move a cohort's start date - `GET /business-made/journeys/employee/{employeeId}/history` — A person's employment history - `POST /business-made/journeys/migrate-checklists` — Move old onboarding checklists onto journeys - `GET /business-made/journeys/my-tasks` — My journey tasks - `POST /business-made/journeys/rehire` — Rehire a former employee - `GET /business-made/journeys/reports` — Onboarding reports - `POST /business-made/journeys/tasks/{taskId}/complete` — Complete a task - `POST /business-made/journeys/tasks/{taskId}/skip` — Skip a task - `GET /business-made/journeys/team` — My team - `GET /business-made/journeys/templates` — List journey templates - `POST /business-made/journeys/templates` — Create a template - `DELETE /business-made/journeys/templates/{id}` — Delete a template - `GET /business-made/journeys/templates/{id}` — Get a template - `PUT /business-made/journeys/templates/{id}` — Update a template - `POST /business-made/journeys/templates/{id}/preview` — Preview a template for a person - `POST /business-made/journeys/transfer` — Transfer or change a role ### Business Made · Bank feeds - `POST /business-made/bank/accounts/map` — Give every bank account a ledger account - `GET /business-made/bank/balances` — Get balances across banks - `GET /business-made/bank/connections` — List bank connections - `DELETE /business-made/bank/connections/{id}` — Disconnect a bank - `POST /business-made/bank/connections/{id}/sync` — Sync a connection’s transactions - `POST /business-made/bank/connections/reseal` — Seal stored access tokens - `POST /business-made/bank/exchange` — Link a bank - `POST /business-made/bank/link-token` — Create a Plaid Link token - `GET /business-made/bank/mfa` — Get the caller’s second-factor state - `POST /business-made/bank/refresh-balances` — Refresh live balances - `POST /business-made/bank/sandbox/connect` — Link a sandbox bank - `GET /business-made/bank/status` — Get bank feed availability ### Business Made · Bank reconciliation - `POST /business-made/bank/reconcile/auto-match` — Auto-match feed lines to the books - `GET /business-made/bank/reconcile/summary` — Get the reconciliation summary - `GET /business-made/bank/transactions` — List bank transactions - `POST /business-made/bank/transactions/{id}/confirm` — Confirm a match - `POST /business-made/bank/transactions/{id}/create-entry` — Book a feed line - `POST /business-made/bank/transactions/{id}/ignore` — Ignore a feed line - `POST /business-made/bank/transactions/{id}/unmatch` — Undo a match ### Business Made · Benefits - `GET /business-made/benefits/enrollments` — List benefit enrolments - `POST /business-made/benefits/enrollments` — Create a benefit enrolment - `DELETE /business-made/benefits/enrollments/{id}` — Delete a benefit enrolment - `GET /business-made/benefits/enrollments/{id}` — Get a benefit enrolment - `POST /business-made/benefits/enrollments/{id}/activate` — Activate an enrolment - `POST /business-made/benefits/enrollments/{id}/beneficiaries` — Add a beneficiary - `DELETE /business-made/benefits/enrollments/{id}/beneficiaries/{beneficiaryId}` — Remove a beneficiary - `POST /business-made/benefits/enrollments/{id}/dependents` — Add a dependant - `DELETE /business-made/benefits/enrollments/{id}/dependents/{dependentId}` — Remove a dependant - `POST /business-made/benefits/enrollments/{id}/terminate` — Terminate an enrolment - `POST /business-made/benefits/enrollments/{id}/waive` — Waive coverage - `GET /business-made/benefits/enrollments/employee/{employeeId}` — Get an employee's enrolments - `POST /business-made/benefits/enrollments/update` — Update a benefit enrolment - `GET /business-made/benefits/metrics` — Get benefits metrics - `GET /business-made/benefits/plans` — List benefit plans - `POST /business-made/benefits/plans` — Create a benefit plan - `DELETE /business-made/benefits/plans/{id}` — Delete a benefit plan - `GET /business-made/benefits/plans/{id}` — Get a benefit plan - `POST /business-made/benefits/plans/{id}/activate` — Activate a benefit plan - `POST /business-made/benefits/plans/{id}/deactivate` — Deactivate a benefit plan - `POST /business-made/benefits/plans/{id}/open-enrollment` — Open enrolment for a plan - `GET /business-made/benefits/plans/active` — List active benefit plans - `POST /business-made/benefits/plans/update` — Update a benefit plan - `GET /business-made/benefits/view/enrollments` — Benefit enrollments for the HR screen - `GET /business-made/benefits/view/enrollments/{id}` — One benefit enrollment for the HR screen - `GET /business-made/benefits/view/plans` — Benefit plans for the HR screen - `GET /business-made/benefits/view/plans/{id}` — One benefit plan for the HR screen ### Business Made · Bills - `GET /business-made/bills` — List bills - `POST /business-made/bills` — Create a bill - `GET /business-made/bills/../vendors` — List vendors (broken route) - `DELETE /business-made/bills/{id}` — Delete a bill - `GET /business-made/bills/{id}` — Get a bill - `POST /business-made/bills/{id}/approve` — Approve a bill - `POST /business-made/bills/{id}/pay` — Pay a bill - `POST /business-made/bills/{id}/void` — Void a bill - `GET /business-made/bills/aging` — Get bill aging - `GET /business-made/bills/payments` — List bill payments - `POST /business-made/bills/update` — Update a bill - `GET /business-made/vendors` — List vendors - `POST /business-made/vendors` — Create a vendor - `DELETE /business-made/vendors/{id}` — Delete a vendor - `GET /business-made/vendors/{id}` — Get a vendor - `POST /business-made/vendors/update` — Update a vendor ### Business Made · Books - `GET /business-made/books/account-map` — Get the account map - `POST /business-made/books/account-map` — Update the account map - `GET /business-made/books/accounts` — List accounts - `POST /business-made/books/accounts` — Create an account - `GET /business-made/books/accounts/{id}` — Get an account - `POST /business-made/books/accounts/update` — Update an account - `GET /business-made/books/ar` — Get accounts receivable - `POST /business-made/books/backfill` — Backfill ledger postings - `POST /business-made/books/backfill-cogs` — Backfill cost of goods sold - `GET /business-made/books/balance-drift` — Check for balance drift - `POST /business-made/books/balance-drift/repair` — Repair balance drift - `GET /business-made/books/journals` — List journals - `POST /business-made/books/journals` — Create a journal - `GET /business-made/books/journals/{id}` — Get a journal - `POST /business-made/books/journals/{id}/post` — Post a journal - `GET /business-made/books/ledger/{accountCode}` — Get an account ledger - `GET /business-made/books/overview` — Get a books overview - `POST /business-made/books/post/invoice` — Post an invoice - `POST /business-made/books/post/payment` — Post a payment - `POST /business-made/books/post/refund` — Post a refund - `POST /business-made/books/post/sale` — Post a sale - `GET /business-made/books/reports/balance-sheet` — Get the balance sheet - `GET /business-made/books/reports/balance-sheet/pdf` — Download the balance sheet as PDF - `GET /business-made/books/reports/by-location` — Get financials by location - `GET /business-made/books/reports/cash-flow` — Get the cash flow report - `GET /business-made/books/reports/close-check` — Run month-end close checks - `GET /business-made/books/reports/pl` — Get the profit and loss report - `GET /business-made/books/reports/pl/pdf` — Download the P&L as PDF - `GET /business-made/books/reports/trial-balance` — Get the trial balance - `POST /business-made/books/resume-postings` — Resume postings - `GET /business-made/books/trial-balance` — Get the posting trial balance ### Business Made · Compensation - `GET /business-made/compensation/bonuses` — List bonuses - `POST /business-made/compensation/bonuses` — Create a bonus - `DELETE /business-made/compensation/bonuses/{id}` — Delete a bonus - `GET /business-made/compensation/bonuses/{id}` — Get a bonus - `POST /business-made/compensation/bonuses/{id}/approve` — Approve a bonus - `POST /business-made/compensation/bonuses/{id}/cancel` — Cancel a bonus - `POST /business-made/compensation/bonuses/{id}/paid` — Mark a bonus paid - `POST /business-made/compensation/bonuses/{id}/reject` — Decline a bonus - `POST /business-made/compensation/bonuses/{id}/schedule` — Schedule a bonus - `POST /business-made/compensation/bonuses/{id}/submit` — Submit a bonus - `GET /business-made/compensation/bonuses/employee/{employeeId}` — Get an employee's bonuses - `POST /business-made/compensation/bonuses/update` — Edit a draft bonus - `GET /business-made/compensation/changes` — List compensation changes - `POST /business-made/compensation/changes` — Create a compensation change - `DELETE /business-made/compensation/changes/{id}` — Delete a compensation change - `GET /business-made/compensation/changes/{id}` — Get a compensation change - `POST /business-made/compensation/changes/{id}/approve` — Approve a compensation change - `POST /business-made/compensation/changes/{id}/cancel` — Cancel a compensation change - `POST /business-made/compensation/changes/{id}/process` — Process a compensation change - `POST /business-made/compensation/changes/{id}/reject` — Decline a compensation change - `POST /business-made/compensation/changes/{id}/submit` — Submit a compensation change - `GET /business-made/compensation/changes/employee/{employeeId}` — Get an employee's compensation history - `POST /business-made/compensation/changes/update` — Edit a draft compensation change - `GET /business-made/compensation/grades` — List salary grades - `POST /business-made/compensation/grades` — Create a salary grade - `DELETE /business-made/compensation/grades/{id}` — Delete a salary grade - `GET /business-made/compensation/grades/{id}` — Get a salary grade - `POST /business-made/compensation/grades/{id}/activate` — Activate a salary grade - `POST /business-made/compensation/grades/{id}/archive` — Archive a salary grade - `POST /business-made/compensation/grades/{id}/deactivate` — Deactivate a salary grade - `GET /business-made/compensation/grades/code/{code}` — Get a salary grade by code - `POST /business-made/compensation/grades/update` — Update a salary grade - `GET /business-made/compensation/metrics` — Get compensation metrics - `GET /business-made/compensation/view/bonuses` — Bonuses for the HR screen - `GET /business-made/compensation/view/bonuses/{id}` — One bonus for the HR screen - `GET /business-made/compensation/view/changes` — Compensation changes for the HR screen - `GET /business-made/compensation/view/changes/{id}` — One compensation change for the HR screen - `GET /business-made/compensation/view/grades` — Salary grades for the HR screen - `GET /business-made/compensation/view/grades/{id}` — One salary grade for the HR screen - `GET /business-made/compensation/view/pay/{employeeId}` — What a person is paid today ### Business Made · Documents - `GET /business-made/documents/acknowledgements` — List policy acknowledgements - `POST /business-made/documents/acknowledgements` — Create an acknowledgement - `GET /business-made/documents/acknowledgements/{id}` — Get an acknowledgement - `POST /business-made/documents/acknowledgements/{id}/acknowledge` — Acknowledge a policy - `POST /business-made/documents/acknowledgements/{id}/decline` — Decline a policy - `POST /business-made/documents/acknowledgements/{id}/remind` — Send an acknowledgement reminder - `POST /business-made/documents/acknowledgements/{id}/waive` — Waive an acknowledgement - `GET /business-made/documents/acknowledgements/employee/{employeeId}` — Get an employee's acknowledgements - `GET /business-made/documents/employee-documents` — List employee documents - `POST /business-made/documents/employee-documents` — Upload an employee document - `DELETE /business-made/documents/employee-documents/{id}` — Delete an employee document - `GET /business-made/documents/employee-documents/{id}` — Get an employee document - `POST /business-made/documents/employee-documents/{id}/archive` — Archive a document - `GET /business-made/documents/employee-documents/{id}/file` — Open a document's file - `POST /business-made/documents/employee-documents/{id}/reject` — Reject a document - `POST /business-made/documents/employee-documents/{id}/restore` — Restore an archived document - `POST /business-made/documents/employee-documents/{id}/sign` — Sign a document - `POST /business-made/documents/employee-documents/{id}/verify` — Verify a document - `GET /business-made/documents/employee-documents/employee/{employeeId}` — Get an employee's documents - `GET /business-made/documents/employee-documents/employee/{employeeId}/category/{category}` — Get an employee's documents by category - `GET /business-made/documents/employee-documents/expiring` — List expiring documents - `POST /business-made/documents/employee-documents/update` — Update an employee document - `GET /business-made/documents/metrics` — Get documents metrics - `GET /business-made/documents/policies` — List policies - `POST /business-made/documents/policies` — Create a policy - `DELETE /business-made/documents/policies/{id}` — Delete a policy - `GET /business-made/documents/policies/{id}` — Get a policy - `POST /business-made/documents/policies/{id}/archive` — Archive a policy - `POST /business-made/documents/policies/{id}/assign` — Assign a policy for acknowledgement - `POST /business-made/documents/policies/{id}/publish` — Publish a policy - `POST /business-made/documents/policies/{id}/version` — Create a new policy version - `GET /business-made/documents/policies/category/{category}` — List policies by category - `GET /business-made/documents/policies/status/active` — List active policies - `POST /business-made/documents/policies/update` — Update a policy ### Business Made · Filings - `GET /business-made/payroll/filings/{formId}/download` — Download a filing - `POST /business-made/payroll/filings/1096/{taxYear}` — Generate Form 1096 - `POST /business-made/payroll/filings/940/{taxYear}` — Generate Form 940 - `POST /business-made/payroll/filings/941/{taxYear}/{quarter}` — Generate Form 941 - `POST /business-made/payroll/filings/efw2/{taxYear}` — Build the SSA EFW2 W-2 file - `GET /business-made/payroll/filings/efw2/{taxYear}/download` — Download the SSA EFW2 W-2 file - `POST /business-made/payroll/filings/state-quarterly/{taxYear}/{quarter}/{state}` — Generate a state quarterly wage report - `POST /business-made/payroll/filings/w3/{taxYear}` — Generate Form W-3 - `GET /business-made/payroll/tax-forms` — List tax forms - `GET /business-made/payroll/tax-forms/{formId}/download` — Download a tax form - `POST /business-made/payroll/tax-forms/1099-nec/{contractorId}/{taxYear}` — Generate a 1099-NEC - `POST /business-made/payroll/tax-forms/w2/{employeeId}/{taxYear}` — Generate a W-2 - `POST /business-made/payroll/tax-forms/year-end/{taxYear}` — Generate all year-end forms ### Business Made · Government e-filing - `GET /business-made/efile/connections/{program}` — IRS API connection - `PUT /business-made/efile/connections/{program}` — Save an IRS API connection - `POST /business-made/efile/connections/{program}/test` — Test an IRS API connection - `POST /business-made/efile/iris/{taxYear}/prepare` — Prepare an IRIS 1099 transmission (build and validate only) - `GET /business-made/efile/iris/submissions/{id}/ack` — The IRS acknowledgement of an IRIS transmission - `POST /business-made/efile/iris/submissions/{id}/refresh` — Ask the IRS for the acknowledgement now - `POST /business-made/efile/iris/submissions/{id}/transmit` — Send an IRIS transmission to the IRS test system - `GET /business-made/efile/submissions` — E-file submissions - `GET /business-made/efile/submissions/{id}` — An e-file submission - `GET /business-made/efile/submissions/{id}/files/{kind}` — Download a submission’s payload or acknowledgement - `POST /business-made/efile/tinm/bulk` — Bulk TIN Matching (up to 100,000 payees) - `POST /business-made/efile/tinm/check` — Interactive TIN Matching (up to 25 payees) - `GET /business-made/efile/tinm/submissions/{id}/results` — Results of a bulk TIN Matching request ### Business Made · Government forms - `GET /business-made/everify/{employeeId}` — E-Verify cases for an employee - `POST /business-made/everify/{employeeId}/case` — Create an E-Verify case - `POST /business-made/everify/{employeeId}/case/{caseId}/close` — Close an E-Verify case - `POST /business-made/everify/{employeeId}/case/{caseId}/photo-match` — Answer photo matching - `POST /business-made/everify/{employeeId}/case/{caseId}/refresh` — Refresh a case from E-Verify - `POST /business-made/everify/{employeeId}/case/{caseId}/status` — Record an E-Verify result by hand - `POST /business-made/everify/{employeeId}/case/{caseId}/submit` — Submit a queued case to E-Verify now - `POST /business-made/everify/{employeeId}/case/{caseId}/tnc` — Tentative Nonconfirmation: acknowledge or refer - `GET /business-made/gov-forms/{employeeId}/{formKey}` — An employee’s form (HR view) - `POST /business-made/gov-forms/{employeeId}/{formKey}/countersign` — Countersign a contractor agreement - `POST /business-made/gov-forms/expire-due` — Expire forms past their date now - `GET /business-made/gov-forms/renewal-settings` — Form renewal periods (org setting) - `PUT /business-made/gov-forms/renewal-settings` — Set form renewal periods - `POST /business-made/i9/{employeeId}/reverification` — Reverify (Supplement B) - `GET /business-made/i9/{employeeId}/section2` — I-9 Section 2 - `PUT /business-made/i9/{employeeId}/section2` — Save or sign I-9 Section 2 - `GET /business-made/i9/due` — I-9s needing attention - `GET /business-made/payroll/readiness-exceptions` — Pre-payroll exceptions ### Business Made · Insights - `GET /business-made/insights` — Business snapshot - `GET /business-made/insights/{category}` — One insights dashboard ### Business Made · Learning - `GET /business-made/learning/certifications` — List certifications - `POST /business-made/learning/certifications` — Create a certification - `DELETE /business-made/learning/certifications/{id}` — Delete a certification - `GET /business-made/learning/certifications/{id}` — Get a certification - `POST /business-made/learning/certifications/update` — Update a certification - `GET /business-made/learning/courses` — List courses - `POST /business-made/learning/courses` — Create a course - `DELETE /business-made/learning/courses/{id}` — Delete a course - `GET /business-made/learning/courses/{id}` — Get a course - `POST /business-made/learning/courses/{id}/archive` — Archive a course - `POST /business-made/learning/courses/{id}/assign` — Assign a course - `POST /business-made/learning/courses/{id}/publish` — Publish a course - `GET /business-made/learning/courses/status/active` — List active courses - `POST /business-made/learning/courses/update` — Update a course - `GET /business-made/learning/enrollments` — List enrolments - `POST /business-made/learning/enrollments` — Create an enrolment - `GET /business-made/learning/enrollments/{id}` — Get an enrolment - `POST /business-made/learning/enrollments/{id}/assessment` — Record an assessment result - `POST /business-made/learning/enrollments/{id}/complete` — Complete an enrolment - `POST /business-made/learning/enrollments/{id}/progress` — Record enrolment progress - `POST /business-made/learning/enrollments/{id}/start` — Start an enrolment - `POST /business-made/learning/enrollments/{id}/withdraw` — Withdraw from an enrolment - `GET /business-made/learning/enrollments/employee/{employeeId}` — Get an employee's enrolments - `GET /business-made/learning/enrollments/employee/{employeeId}/certifications` — Get an employee's certifications - `POST /business-made/learning/enrollments/update` — Update an enrolment - `GET /business-made/learning/metrics` — Get learning metrics - `GET /business-made/learning/paths` — List learning paths - `POST /business-made/learning/paths` — Create a learning path - `DELETE /business-made/learning/paths/{id}` — Delete a learning path - `GET /business-made/learning/paths/{id}` — Get a learning path - `POST /business-made/learning/paths/{id}/publish` — Publish a learning path - `POST /business-made/learning/paths/update` — Update a learning path ### Business Made · Leave - `POST /business-made/leave/accrual/rollover` — Year-end rollover - `POST /business-made/leave/accrual/run` — Run accrual now - `GET /business-made/leave/accrual/status` — Accrual status - `GET /business-made/leave/balances` — List leave balances - `POST /business-made/leave/balances` — Create a leave balance - `GET /business-made/leave/balances-grid` — Balances grid - `GET /business-made/leave/balances/{id}` — Get a leave balance - `POST /business-made/leave/balances/{id}/accrue` — Accrue leave on one balance - `POST /business-made/leave/balances/{id}/adjust` — Adjust a leave balance - `GET /business-made/leave/balances/employee/{employeeId}` — Get an employee's leave balances - `GET /business-made/leave/calendar` — List calendar days - `POST /business-made/leave/calendar` — Create or update a calendar day - `DELETE /business-made/leave/calendar/{id}` — Delete a calendar day - `POST /business-made/leave/calendar/accept` — Keep suggested holidays - `GET /business-made/leave/calendar/suggest` — Suggest public holidays - `POST /business-made/leave/digest/run` — Send the approvers' digest now - `GET /business-made/leave/engine/status` — Leave scheduled jobs - `GET /business-made/leave/insights` — Leave liability and usage - `GET /business-made/leave/metrics` — Get leave metrics - `GET /business-made/leave/policies` — List leave policies - `POST /business-made/leave/policies` — Create a leave policy - `DELETE /business-made/leave/policies/{id}` — Delete a leave policy - `GET /business-made/leave/policies/{id}` — Get a leave policy - `POST /business-made/leave/policies/update` — Update a leave policy - `GET /business-made/leave/reports/{kind}` — Leave report rows - `GET /business-made/leave/requests` — List leave requests - `POST /business-made/leave/requests` — Create a leave request - `DELETE /business-made/leave/requests/{id}` — Delete a leave request - `GET /business-made/leave/requests/{id}` — Get a leave request - `POST /business-made/leave/requests/{id}/approve` — Approve a leave request - `POST /business-made/leave/requests/{id}/cancel` — Cancel a leave request - `POST /business-made/leave/requests/{id}/edit` — Edit a request before sending it (again) - `POST /business-made/leave/requests/{id}/reject` — Reject a leave request - `POST /business-made/leave/requests/{id}/resubmit` — Send a request again - `POST /business-made/leave/requests/{id}/submit` — Submit a leave request - `GET /business-made/leave/requests/employee/{employeeId}` — Get an employee's leave requests - `GET /business-made/leave/requests/pending-approvals` — List requests awaiting approval - `POST /business-made/leave/requests/update` — Update a leave request - `GET /business-made/leave/setup` — Everything the setup page shows - `POST /business-made/leave/setup/enable` — Switch Leave on or off - `GET /business-made/leave/setup/opening-balances` — Preview opening balances - `POST /business-made/leave/setup/opening-balances` — Commit opening balances - `GET /business-made/leave/setup/readiness` — Is the Leave module ready - `POST /business-made/leave/setup/recompute` — Re-stamp levels and policies on everyone - `GET /business-made/leave/setup/settings` — Get leave settings - `POST /business-made/leave/setup/settings` — Save leave settings - `POST /business-made/leave/setup/starter` — Create the starter types and default policy - `POST /business-made/leave/setup/supervisor` — Set a person's supervisor - `POST /business-made/leave/taken/run` — Mark past approved leave as taken - `GET /business-made/leave/team` — Who is off when - `GET /business-made/leave/types` — List leave types - `POST /business-made/leave/types` — Create a leave type - `DELETE /business-made/leave/types/{id}` — Delete a leave type - `GET /business-made/leave/types/{id}` — Get a leave type - `GET /business-made/leave/types/active` — List active leave types - `POST /business-made/leave/types/update` — Update a leave type ### Business Made · Offboarding - `GET /business-made/offboarding` — List offboarding records - `POST /business-made/offboarding` — Create an offboarding record - `DELETE /business-made/offboarding/{id}` — Delete an offboarding record - `GET /business-made/offboarding/{id}` — Get an offboarding record - `POST /business-made/offboarding/{id}/cancel` — Cancel offboarding - `POST /business-made/offboarding/{id}/complete` — Complete offboarding - `POST /business-made/offboarding/{id}/equipment` — Record equipment return - `POST /business-made/offboarding/{id}/final-pay` — Record final pay - `POST /business-made/offboarding/{id}/revoke-access` — Revoke system access - `POST /business-made/offboarding/{id}/start` — Start offboarding - `POST /business-made/offboarding/{id}/tasks/{taskId}/complete` — Complete an offboarding task - `POST /business-made/offboarding/{id}/tasks/{taskId}/not-applicable` — Mark an offboarding task not applicable - `POST /business-made/offboarding/{offboardingId}/exit-interview` — Schedule an exit interview - `GET /business-made/offboarding/cases` — Offboarding records with progress - `GET /business-made/offboarding/cases/{id}` — One offboarding with its checklist - `POST /business-made/offboarding/cases/{id}/action` — Take an offboarding step - `GET /business-made/offboarding/exit-interviews` — List exit interviews - `GET /business-made/offboarding/exit-interviews/{id}` — Get an exit interview - `POST /business-made/offboarding/exit-interviews/{id}/action-items` — Add exit interview action items - `POST /business-made/offboarding/exit-interviews/{id}/conduct` — Record an exit interview - `POST /business-made/offboarding/exit-interviews/{id}/decline` — Record a declined exit interview - `GET /business-made/offboarding/metrics` — Get offboarding metrics - `GET /business-made/offboarding/status/active` — List active offboarding - `POST /business-made/offboarding/update` — Update an offboarding record ### Business Made · Organization - `GET /business-made/organization/chart` — Org chart - `POST /business-made/organization/chart/departments` — Create or edit a department - `POST /business-made/organization/chart/departments/{id}/parent` — Nest a department - `POST /business-made/organization/chart/departments/adopt` — Adopt a department name people already carry - `POST /business-made/organization/chart/people/{id}/department` — Put a person in a department - `POST /business-made/organization/chart/people/{id}/manager` — Set who a person reports to - `POST /business-made/organization/chart/positions` — Create or edit a position - `GET /business-made/organization/charts` — List org charts - `POST /business-made/organization/charts` — Create an org chart - `DELETE /business-made/organization/charts/{id}` — Delete an org chart - `GET /business-made/organization/charts/{id}` — Get an org chart - `POST /business-made/organization/charts/{id}/archive` — Archive an org chart - `POST /business-made/organization/charts/{id}/publish` — Publish an org chart - `POST /business-made/organization/charts/{id}/set-default` — Set the default org chart - `GET /business-made/organization/charts/default` — Get the default org chart - `POST /business-made/organization/charts/update` — Update an org chart - `GET /business-made/organization/departments` — List departments - `POST /business-made/organization/departments` — Create a department - `DELETE /business-made/organization/departments/{id}` — Delete a department - `GET /business-made/organization/departments/{id}` — Get a department - `GET /business-made/organization/departments/{id}/children` — Get child departments - `POST /business-made/organization/departments/{id}/head` — Set a department head - `POST /business-made/organization/departments/{id}/headcount` — Set a department headcount - `GET /business-made/organization/departments/code/{code}` — Get a department by code - `GET /business-made/organization/departments/hierarchy` — Get the department hierarchy - `GET /business-made/organization/departments/status/active` — List active departments - `POST /business-made/organization/departments/update` — Update a department - `GET /business-made/organization/metrics` — Get organization metrics - `GET /business-made/organization/positions` — List positions - `POST /business-made/organization/positions` — Create a position - `DELETE /business-made/organization/positions/{id}` — Delete a position - `GET /business-made/organization/positions/{id}` — Get a position - `POST /business-made/organization/positions/{id}/fill` — Fill a position - `POST /business-made/organization/positions/{id}/vacate` — Vacate a position - `GET /business-made/organization/positions/code/{code}` — Get a position by code - `GET /business-made/organization/positions/department/{departmentId}` — List positions in a department - `GET /business-made/organization/positions/status/active` — List active positions - `GET /business-made/organization/positions/status/open` — List open positions - `POST /business-made/organization/positions/update` — Update a position ### Business Made · Payroll - `GET /business-made/payroll/employer-setup` — Get employer tax setup - `POST /business-made/payroll/employer-setup` — Update employer tax setup - `GET /business-made/payroll/employer-setup/readiness` — Check filing readiness - `GET /business-made/payroll/profiles` — List payroll profiles - `POST /business-made/payroll/profiles` — Create a payroll profile - `DELETE /business-made/payroll/profiles/{id}` — Delete a payroll profile - `GET /business-made/payroll/profiles/{id}` — Get a payroll profile - `GET /business-made/payroll/profiles/employee/{employeeId}` — Get an employee's payroll profile - `POST /business-made/payroll/profiles/employee/{employeeId}/bank-accounts` — Add a bank account - `DELETE /business-made/payroll/profiles/employee/{employeeId}/bank-accounts/{accountId}` — Remove a bank account - `POST /business-made/payroll/profiles/employee/{employeeId}/bank-accounts/{accountId}/verify` — Verify a bank account - `POST /business-made/payroll/profiles/employee/{employeeId}/deductions` — Add a deduction - `DELETE /business-made/payroll/profiles/employee/{employeeId}/deductions/{deductionId}` — Remove a deduction - `POST /business-made/payroll/profiles/employee/{employeeId}/deductions/{deductionId}` — Update a deduction - `POST /business-made/payroll/profiles/migrate-tax-elections` — Migrate legacy tax elections - `POST /business-made/payroll/profiles/update` — Update a payroll profile - `GET /business-made/payroll/reports/blockers` — Get pre-run blockers - `GET /business-made/payroll/reports/summary/{year}` — Get an annual payroll summary - `GET /business-made/payroll/reports/upcoming-run` — Get the upcoming payroll run - `GET /business-made/payroll/reports/w2/{employeeId}/{year}` — Get W-2 data for an employee - `GET /business-made/payroll/runs` — List payroll runs - `POST /business-made/payroll/runs` — Create a payroll run - `DELETE /business-made/payroll/runs/{id}` — Delete a payroll run - `GET /business-made/payroll/runs/{id}` — Get a payroll run - `POST /business-made/payroll/runs/{id}/approve` — Approve a payroll run - `POST /business-made/payroll/runs/{id}/calculate` — Calculate a payroll run - `POST /business-made/payroll/runs/{id}/cancel` — Cancel a payroll run - `POST /business-made/payroll/runs/{id}/parallel-check` — Compare a run against an incumbent provider - `POST /business-made/payroll/runs/{id}/process` — Process a payroll run - `POST /business-made/payroll/runs/update` — Update a payroll run - `GET /business-made/payroll/stubs` — List pay stubs - `GET /business-made/payroll/stubs/{id}` — Get a pay stub - `GET /business-made/payroll/stubs/employee/{employeeId}` — Get an employee's pay stubs - `GET /business-made/payroll/stubs/run/{payrollRunId}` — Get pay stubs for a run ### Business Made · Payroll config - `GET /business-made/payroll/deduction-types` — List deduction types - `POST /business-made/payroll/deduction-types` — Create a deduction type - `DELETE /business-made/payroll/deduction-types/{id}` — Delete a deduction type - `GET /business-made/payroll/deduction-types/{id}` — Get a deduction type - `PATCH /business-made/payroll/deduction-types/{id}` — Update a deduction type - `POST /business-made/payroll/deduction-types/seed` — Seed standard deduction types - `GET /business-made/payroll/earning-types` — List earning types - `POST /business-made/payroll/earning-types` — Create an earning type - `DELETE /business-made/payroll/earning-types/{id}` — Delete an earning type - `GET /business-made/payroll/earning-types/{id}` — Get an earning type - `PATCH /business-made/payroll/earning-types/{id}` — Update an earning type - `POST /business-made/payroll/earning-types/seed` — Seed standard earning types - `GET /business-made/payroll/employee-deductions` — List employee deductions - `POST /business-made/payroll/employee-deductions` — Assign a deduction to an employee - `DELETE /business-made/payroll/employee-deductions/{id}` — Delete an employee deduction - `GET /business-made/payroll/employee-deductions/{id}` — Get an employee deduction - `PATCH /business-made/payroll/employee-deductions/{id}` — Update an employee deduction - `POST /business-made/payroll/employee-deductions/{id}/cancel` — Cancel a deduction - `POST /business-made/payroll/employee-deductions/{id}/pause` — Pause a deduction - `POST /business-made/payroll/employee-deductions/{id}/resume` — Resume a deduction - `POST /business-made/payroll/employees/bulk-import` — Bulk import employees with payroll profiles - `POST /business-made/payroll/run/execute` — Execute a payroll run - `POST /business-made/payroll/run/preview` — Preview a payroll run - `GET /business-made/payroll/runs/{runId}/ach/download` — Download the ACH file - `POST /business-made/payroll/runs/{runId}/ach/generate` — Generate the ACH file for a run - `POST /business-made/payroll/runs/{runId}/stubs/pdf/generate` — Generate all pay stub PDFs for a run - `GET /business-made/payroll/stubs/{stubId}/pdf` — Download a pay stub PDF - `POST /business-made/payroll/stubs/{stubId}/pdf/generate` — Generate a pay stub PDF ### Business Made · People - `GET /business-made/employees` — List employees - `POST /business-made/employees` — Create an employee - `DELETE /business-made/employees/{id}` — Delete an employee - `GET /business-made/employees/{id}` — Get an employee - `POST /business-made/employees/{id}/onboarding/{taskId}/complete` — Complete an onboarding task - `POST /business-made/employees/{id}/onboarding/start` — Start onboarding for an employee - `GET /business-made/employees/{id}/reviews` — Get an employee's reviews - `POST /business-made/employees/{id}/reviews` — Add a performance review - `POST /business-made/employees/{id}/skills` — Add a skill - `POST /business-made/employees/{id}/status` — Change an employee status - `POST /business-made/employees/{id}/terminate` — Terminate an employee - `GET /business-made/employees/{id}/time-off` — Get an employee's time off - `POST /business-made/employees/{id}/time-off/{requestId}/approve` — Approve a time-off request - `POST /business-made/employees/{id}/time-off/{requestId}/reject` — Reject a time-off request - `POST /business-made/employees/{id}/time-off/request` — Request time off - `POST /business-made/employees/{id}/training` — Assign training - `POST /business-made/employees/{id}/training/{trainingId}/complete` — Complete training - `GET /business-made/employees/department/{department}` — List employees by department - `GET /business-made/employees/location/{location}` — List employees by location - `GET /business-made/employees/overview` — HR overview - `GET /business-made/employees/reports/anniversaries` — Get work anniversaries - `GET /business-made/employees/reports/birthdays` — Get upcoming birthdays - `GET /business-made/employees/reports/headcount` — Get the headcount report - `GET /business-made/employees/skill/{skillName}` — Find employees by skill - `GET /business-made/employees/status/active` — List active employees - `GET /business-made/employees/supervisor/{supervisorId}` — List an employee's direct reports - `GET /business-made/employees/training/expired` — List expired training - `POST /business-made/employees/update` — Update an employee - `GET /business-made/onboarding` — List onboarding records - `GET /business-made/onboarding/{employeeId}` — Get an employee's onboarding - `POST /business-made/onboarding/{employeeId}` — Start onboarding - `POST /business-made/onboarding/{employeeId}/cancel` — Cancel onboarding - `POST /business-made/onboarding/{employeeId}/complete` — Complete onboarding - `POST /business-made/onboarding/{employeeId}/items/{itemKey}/complete` — Complete an onboarding item - `POST /business-made/onboarding/{employeeId}/items/{itemKey}/skip` — Skip an onboarding item ### Business Made · Performance - `GET /business-made/performance/goals` — List goals - `POST /business-made/performance/goals` — Create a goal - `DELETE /business-made/performance/goals/{id}` — Delete a goal - `GET /business-made/performance/goals/{id}` — Get a goal - `POST /business-made/performance/goals/{id}/activate` — Activate a goal - `POST /business-made/performance/goals/{id}/cancel` — Cancel a goal - `POST /business-made/performance/goals/{id}/complete` — Complete a goal - `POST /business-made/performance/goals/{id}/progress` — Record goal progress - `GET /business-made/performance/goals/employee/{employeeId}` — Get an employee's goals - `POST /business-made/performance/goals/update` — Update a goal - `GET /business-made/performance/metrics` — Get performance metrics - `GET /business-made/performance/pips` — List performance improvement plans - `POST /business-made/performance/pips` — Create a PIP - `DELETE /business-made/performance/pips/{id}` — Delete a PIP - `GET /business-made/performance/pips/{id}` — Get a PIP - `POST /business-made/performance/pips/{id}/activate` — Activate a PIP - `POST /business-made/performance/pips/{id}/cancel` — Cancel a PIP - `POST /business-made/performance/pips/{id}/check-in` — Record a PIP check-in - `POST /business-made/performance/pips/{id}/complete` — Complete a PIP - `POST /business-made/performance/pips/{id}/extend` — Extend a PIP - `POST /business-made/performance/pips/update` — Update a PIP - `GET /business-made/performance/reviews` — List performance reviews - `POST /business-made/performance/reviews` — Create a performance review - `DELETE /business-made/performance/reviews/{id}` — Delete a performance review - `GET /business-made/performance/reviews/{id}` — Get a performance review - `POST /business-made/performance/reviews/{id}/acknowledge` — Acknowledge a review - `POST /business-made/performance/reviews/{id}/complete` — Complete a review - `POST /business-made/performance/reviews/{id}/manager-review` — Submit a manager review - `POST /business-made/performance/reviews/{id}/self-assessment` — Submit a self-assessment - `POST /business-made/performance/reviews/{id}/start-self-review` — Start the self-review - `GET /business-made/performance/reviews/employee/{employeeId}` — Get an employee's reviews - `POST /business-made/performance/reviews/update` — Update a performance review ### Business Made · Period close - `GET /business-made/budgets` — List budgets - `POST /business-made/budgets` — Create a budget - `GET /business-made/budgets/{id}` — Get a budget - `GET /business-made/budgets/{id}/variance` — Get budget variance - `POST /business-made/budgets/update` — Update a budget - `GET /business-made/period-close` — List period closes - `GET /business-made/period-close/{id}` — Get a period close - `POST /business-made/period-close/{id}/checklist/{itemId}` — Complete a checklist item - `POST /business-made/period-close/{id}/lock` — Lock a period - `POST /business-made/period-close/{id}/reopen` — Reopen a period - `POST /business-made/period-close/start` — Start a period close ### Business Made · Readiness - `GET /business-made/readiness/check/{employeeId}` — Gate check - `GET /business-made/readiness/employee/{employeeId}` — One person: requirements, gates, overrides and history - `POST /business-made/readiness/evidence` — Record proof - `GET /business-made/readiness/export.csv` — Inspector export (CSV) - `GET /business-made/readiness/job` — Daily run status - `GET /business-made/readiness/jobs` — Background jobs - `POST /business-made/readiness/jobs/{job}/run` — Run a job now - `GET /business-made/readiness/matrix` — People × requirements matrix - `GET /business-made/readiness/overrides` — List overrides and waivers - `POST /business-made/readiness/overrides` — Record an override - `GET /business-made/readiness/overview` — Readiness overview - `GET /business-made/readiness/packs` — Jurisdiction packs - `POST /business-made/readiness/packs/{packId}/apply` — Apply a jurisdiction pack - `GET /business-made/readiness/point-in-time` — Who worked, and were they compliant - `GET /business-made/readiness/rules` — List requirement rules - `POST /business-made/readiness/rules` — Create a requirement rule - `DELETE /business-made/readiness/rules/{id}` — Delete (or retire) a requirement rule - `GET /business-made/readiness/rules/{id}` — Get a requirement rule - `PUT /business-made/readiness/rules/{id}` — Update a requirement rule - `POST /business-made/readiness/rules/{id}/preview` — Who a rule applies to - `GET /business-made/readiness/settings` — Background jobs: settings and status - `PUT /business-made/readiness/settings` — Save background job settings - `POST /business-made/readiness/sync` — Re-evaluate and write the ledger - `POST /business-made/readiness/waivers` — Waive a requirement for a person - `POST /business-made/readiness/waivers/{id}/revoke` — End a waiver ### Business Made · Readiness AI - `POST /business-made/training/ai/check-sources` — Regenerate courses whose sources changed - `POST /business-made/training/ai/course-from-sop` — Draft a course from SOPs and policies - `GET /business-made/training/ai/courses` — List generated courses by lineage - `POST /business-made/training/ai/courses/{id}/publish` — Publish a generated course version - `POST /business-made/training/ai/courses/{id}/regenerate` — Regenerate a course from its sources - `GET /business-made/training/ai/courses/{id}/sources` — Sources of a course and whether they changed - `POST /business-made/training/ai/courses/{id}/translate` — Translate a course - `GET /business-made/training/ai/new-hire` — A new hire’s onboarding and training state ### Business Made · Readiness gates - `POST /business-made/schedules/{scheduleId}/shifts/{shiftId}/claim` — Claim an open shift - `GET /business-made/schedules/assignable` — Who can work a slot - `GET /business-made/schedules/week` — The week rota - `POST /business-made/schedules/week/publish` — Publish a period ### Business Made · Recruitment - `GET /business-made/recruitment/applicants` — List applicants - `POST /business-made/recruitment/applicants` — Create an applicant - `GET /business-made/recruitment/applicants/{id}` — Get an applicant - `POST /business-made/recruitment/applicants/{id}/notes` — Add a note to an applicant - `POST /business-made/recruitment/applicants/{id}/reject` — Reject an applicant - `POST /business-made/recruitment/applicants/{id}/stage` — Move an applicant to a stage - `POST /business-made/recruitment/applicants/update` — Update an applicant - `GET /business-made/recruitment/board` — Hiring board - `POST /business-made/recruitment/board/applicants` — Add an applicant - `GET /business-made/recruitment/board/applicants/{id}` — One applicant - `POST /business-made/recruitment/board/applicants/{id}/action` — Move an applicant along - `POST /business-made/recruitment/board/applicants/{id}/hired` — Record a hire - `POST /business-made/recruitment/board/jobs` — Create or edit a job - `GET /business-made/recruitment/board/jobs/{id}` — One job with its applicants - `POST /business-made/recruitment/board/jobs/{id}/status` — Move a job to another status - `GET /business-made/recruitment/interviews` — List interviews - `POST /business-made/recruitment/interviews` — Schedule an interview - `GET /business-made/recruitment/interviews/{id}` — Get an interview - `POST /business-made/recruitment/interviews/{id}/cancel` — Cancel an interview - `POST /business-made/recruitment/interviews/{id}/complete` — Complete an interview - `POST /business-made/recruitment/interviews/{id}/reschedule` — Reschedule an interview - `POST /business-made/recruitment/interviews/update` — Update an interview - `GET /business-made/recruitment/jobs` — List job postings - `POST /business-made/recruitment/jobs` — Create a job posting - `DELETE /business-made/recruitment/jobs/{id}` — Delete a job posting - `GET /business-made/recruitment/jobs/{id}` — Get a job posting - `POST /business-made/recruitment/jobs/{id}/close` — Close a job posting - `POST /business-made/recruitment/jobs/{id}/publish` — Publish a job posting - `POST /business-made/recruitment/jobs/update` — Update a job posting - `GET /business-made/recruitment/metrics` — Get recruitment metrics - `GET /business-made/recruitment/metrics/applicants-by-stage` — Get applicants by stage - `GET /business-made/recruitment/offers` — List offers - `POST /business-made/recruitment/offers` — Create an offer - `GET /business-made/recruitment/offers/{id}` — Get an offer - `POST /business-made/recruitment/offers/{id}/accept` — Record an accepted offer - `POST /business-made/recruitment/offers/{id}/decline` — Record a declined offer - `POST /business-made/recruitment/offers/{id}/send` — Send an offer - `POST /business-made/recruitment/offers/{id}/withdraw` — Withdraw an offer - `POST /business-made/recruitment/offers/update` — Update an offer ### Business Made · Schedules - `GET /business-made/schedules` — List schedules - `POST /business-made/schedules` — Create a schedule - `DELETE /business-made/schedules/{id}` — Delete a schedule - `GET /business-made/schedules/{id}` — Get a schedule - `POST /business-made/schedules/{id}/archive` — Archive a schedule - `POST /business-made/schedules/{id}/duplicate` — Duplicate a schedule - `POST /business-made/schedules/{id}/publish` — Publish a schedule - `POST /business-made/schedules/{id}/shifts` — Add a shift - `DELETE /business-made/schedules/{id}/shifts/{shiftId}` — Remove a shift - `POST /business-made/schedules/{id}/shifts/{shiftId}` — Update a shift - `POST /business-made/schedules/{id}/shifts/{shiftId}/break/{breakId}/end` — End a break - `POST /business-made/schedules/{id}/shifts/{shiftId}/break/start` — Start a break - `POST /business-made/schedules/{id}/shifts/{shiftId}/clock-in` — Clock in to a shift - `POST /business-made/schedules/{id}/shifts/{shiftId}/clock-out` — Clock out of a shift - `POST /business-made/schedules/{id}/shifts/{shiftId}/swap/approve` — Approve a shift swap - `POST /business-made/schedules/{id}/shifts/{shiftId}/swap/reject` — Reject a shift swap - `POST /business-made/schedules/{id}/shifts/{shiftId}/swap/request` — Request a shift swap - `POST /business-made/schedules/{scheduleId}/shifts/{shiftId}/no-show` — Mark a no-show - `POST /business-made/schedules/{scheduleId}/shifts/{shiftId}/offer` — Offer a shift to its person - `POST /business-made/schedules/{scheduleId}/shifts/{shiftId}/respond` — Answer a shift offer - `GET /business-made/schedules/availability/{employeeId}` — Get a person's availability - `PUT /business-made/schedules/availability/{employeeId}` — Set a person's availability - `POST /business-made/schedules/copy` — Copy one period onto another - `POST /business-made/schedules/generate` — Build a period from the shift definitions - `GET /business-made/schedules/month` — A month of coverage - `POST /business-made/schedules/person/clear` — Take one person off a period - `GET /business-made/schedules/reports/labor-summary` — Get the labour summary - `GET /business-made/schedules/running` — The day as it is going - `GET /business-made/schedules/settings` — Get scheduling settings - `POST /business-made/schedules/settings` — Save scheduling settings - `POST /business-made/schedules/shift/clear` — Clear everyone off a shift - `POST /business-made/schedules/shift/cover` — Ask for cover on open shifts - `GET /business-made/schedules/shifts/employee/{employeeId}` — Get an employee's shifts - `GET /business-made/schedules/shifts/employee/{employeeId}/upcoming` — Get an employee's upcoming shifts - `GET /business-made/schedules/shifts/today` — Get today's shifts - `POST /business-made/schedules/update` — Update a schedule ### Business Made · Setup - `GET /business-made/setup` — Health check - `POST /business-made/setup/all` — Seed everything - `POST /business-made/setup/chart-of-accounts` — Seed the chart of accounts - `POST /business-made/setup/demo-hr-payroll` — Seed demo HR and payroll data - `POST /business-made/setup/locations` — Seed demo locations - `POST /business-made/setup/module/apply` — Apply one setup module - `POST /business-made/setup/product-attributes` — Seed product attributes - `POST /business-made/setup/profile/save` — Save the business profile - `POST /business-made/setup/scenario/apply` — Apply a setup scenario - `GET /business-made/setup/status` — Get setup status - `POST /business-made/setup/vendors` — Seed vendors - `POST /business-made/setup/workflows` — Seed the canonical workflows - `POST /business-made/setup/workflows/{name}` — Seed one canonical workflow ### Business Made · Tax - `GET /business-made/payroll/tax-rules` — List tax rules - `POST /business-made/payroll/tax-rules` — Create a tax rule - `DELETE /business-made/payroll/tax-rules/{id}` — Delete a tax rule - `GET /business-made/payroll/tax-rules/{id}` — Get a tax rule - `PATCH /business-made/payroll/tax-rules/{id}` — Update a tax rule - `POST /business-made/payroll/tax-rules/{id}/use-official` — Use the official table instead of an org rule - `GET /business-made/payroll/tax-rules/compare/{fromYear}/{toYear}` — Compare two tax years - `GET /business-made/payroll/tax-rules/coverage` — Get state tax coverage - `POST /business-made/payroll/tax-rules/import` — Import tax rules in bulk - `POST /business-made/payroll/tax-rules/seed-us` — Seed US federal tax rules - `GET /business-made/payroll/tax-rules/shadowed` — List org rules that replace an official table - `GET /business-made/payroll/tax-rules/tables/status` — Get tax table load status - `GET /business-made/payroll/tax-rules/verify/{year}` — Verify tax tables for a year ### Business Made · Timesheets - `GET /business-made/timesheets` — List timesheets - `POST /business-made/timesheets` — Create a timesheet - `DELETE /business-made/timesheets/{id}` — Delete a timesheet - `GET /business-made/timesheets/{id}` — Get a timesheet - `POST /business-made/timesheets/{id}/approve` — Approve a timesheet - `POST /business-made/timesheets/{id}/entries` — Add a time entry - `DELETE /business-made/timesheets/{id}/entries/{entryId}` — Delete a time entry - `POST /business-made/timesheets/{id}/entries/{entryId}` — Update a time entry - `POST /business-made/timesheets/{id}/reject` — Reject a timesheet - `POST /business-made/timesheets/{id}/reopen` — Reopen a timesheet - `POST /business-made/timesheets/{id}/submit` — Submit a timesheet - `POST /business-made/timesheets/clock-events/{clockEventId}/review` — Accept a flagged clock-in - `GET /business-made/timesheets/clock-events/needs-review` — Clock-ins waiting for review - `GET /business-made/timesheets/clock-events/timesheet/{timesheetId}` — Clock events behind a timesheet - `POST /business-made/timesheets/clock-in/{employeeId}` — Clock in - `GET /business-made/timesheets/clock-in/{employeeId}/active` — Get an active clock-in - `POST /business-made/timesheets/clock-ins/close-stale` — Close stale clock-ins - `POST /business-made/timesheets/clock-out/{employeeId}` — Clock out - `GET /business-made/timesheets/employee/{employeeId}` — Get an employee's timesheets - `GET /business-made/timesheets/reports/missing` — List missing timesheets - `GET /business-made/timesheets/reports/on-the-clock` — List who is on the clock - `GET /business-made/timesheets/reports/summary/{employeeId}` — Get an employee time summary - `GET /business-made/timesheets/reports/team-status` — Get team time status - `GET /business-made/timesheets/status/{status}` — List timesheets by status - `GET /business-made/timesheets/status/pending` — List pending timesheets - `POST /business-made/timesheets/update` — Update a timesheet ### Business Made · Training - `GET /business-made/signoffs` — List sign-offs - `POST /business-made/signoffs` — Record a floor sign-off - `GET /business-made/signoffs/checklist` — Sign-off checklist - `GET /business-made/training/courses` — Courses with roster counts - `POST /business-made/training/courses/{id}/assign` — Assign people directly - `POST /business-made/training/courses/{id}/complete` — Mark completed (one or many) - `POST /business-made/training/courses/{id}/not-completed` — Mark not completed (undo) - `GET /business-made/training/courses/{id}/roster` — Course roster - `POST /business-made/training/courses/link` — Add a link course - `PUT /business-made/training/courses/link/{id}` — Change a link course - `POST /business-made/training/marketplace/attach` — Attach a marketplace course - `POST /business-made/training/marketplace/completion` — Course completion from the course app - `GET /business-made/training/marketplace/courses` — Search the course app - `GET /business-made/training/marketplace/status` — Course app connection ### Business Made · Work orders - `GET /business-made/work-orders` — List work orders - `POST /business-made/work-orders` — Create a work order - `DELETE /business-made/work-orders/{id}` — Delete a work order - `GET /business-made/work-orders/{id}` — Get a work order - `POST /business-made/work-orders/{id}/assign` — Assign a work order - `POST /business-made/work-orders/{id}/items` — Add a work order item - `POST /business-made/work-orders/{id}/items/{itemId}` — Update a work order item - `POST /business-made/work-orders/{id}/materials` — Add materials - `POST /business-made/work-orders/{id}/status` — Change a work order status - `POST /business-made/work-orders/{id}/time-entries` — Add a time entry - `GET /business-made/work-orders/active` — List active work orders - `GET /business-made/work-orders/customer/{customerId}` — Get a customer's work orders - `POST /business-made/work-orders/update` — Update a work order ### Chat - `GET /chat/agents/{email}/presence` — Get an agent's presence - `POST /chat/agents/{email}/status` — Set an agent's status - `GET /chat/agents/online` — List online agents - `GET /chat/ai-active` — Check whether AI chat is active - `GET /chat/config/{chatId}` — Get chat configuration - `GET /chat/customers/{email}/journey` — Get a customer's interaction journey - `GET /chat/customers/online` — List online customers - `POST /chat/engage` — Engage a website visitor - `GET /chat/get-profile/{userId}` — Get a chat user profile - `GET /chat/history/{chatId}` — Get chat history - `GET /chat/ice-servers` — Get ICE servers - `POST /chat/live/{chatId}/{userId}` — Send a live chat message - `GET /chat/messages/{email}/{createdAfter}` — Get a user's messages - `GET /chat/presence/stats` — Get presence statistics - `GET /chat/queue` — Get the chat queue - `POST /chat/queue` — Enqueue a chat - `DELETE /chat/queue/{chatId}` — Remove a chat from the queue - `GET /chat/queue/position/{chatId}` — Get a chat's queue position - `GET /chat/queue/stats` — Get queue statistics - `POST /chat/save/{chatId}` — Save a chat message - `GET /chat/sessions` — Get active chat sessions - `POST /chat/transcript/send` — Send a chat transcript - `PUT /chat/update/{chatId}` — Update a chat message - `POST /chat/upload/{chatId}/{userId}` — Upload files to a chat ### Check-in - `POST /checkin/{taskId}/assign` — Assign a service point - `POST /checkin/{taskId}/leave` — Guest left the queue - `POST /checkin/{taskId}/no-show` — Mark a guest as a no-show - `POST /checkin/{taskId}/notify` — Re-send the ready notification - `POST /checkin/from-reservation/{reservationId}` — Check in a reserved guest - `GET /checkin/queue` — Get the live queue - `GET /checkin/queue/{taskId}` — Get one queue entry - `GET /checkin/queue/history` — Get queue history - `GET /checkin/queue/position/{taskId}` — Get queue position and ETA - `GET /checkin/queue/summary` — Get a queue summary - `GET /checkin/reservations/today` — List today's reservations - `GET /checkin/service-point` — List all service points - `POST /checkin/service-point/{spId}/clear` — Clear a service point - `GET /checkin/service-point/available` — List available service points - `GET /checkin/upcoming` — List upcoming reservations - `POST /checkin/walk-in` — Check in a walk-in guest ### Client Account - `GET /client-data/addresses` — Get my addresses - `POST /client-data/addresses` — Add an address - `DELETE /client-data/addresses/{addressId}` — Remove an address - `POST /client-data/addresses/autocomplete` — Autocomplete an address - `GET /client-data/addresses/place/{placeId}` — Get address details for a place - `GET /client-data/all` — Get everything about my account - `GET /client-data/analytics` — Get my account analytics - `GET /client-data/benefits` — Get available benefits - `POST /client-data/benefits/enroll` — Enrol in a benefit - `GET /client-data/benefits/enrollments` — Get my benefit enrolments - `GET /client-data/conversations` — Get my conversations - `GET /client-data/dashboard` — Get my dashboard - `POST /client-data/expert/hire` — Hire an expert - `GET /client-data/expert/messages` — Get my expert messages - `POST /client-data/expert/messages` — Message an expert - `GET /client-data/files` — Get my files - `DELETE /client-data/files/{path}` — Delete a file - `POST /client-data/files/upload` — Upload a file - `GET /client-data/forms` — Get my forms - `GET /client-data/messages` — Get my messages - `POST /client-data/messages` — Send a message - `PUT /client-data/messages/{messageId}/status/{status}` — Set a message status - `GET /client-data/notifications` — Get my notifications - `POST /client-data/notifications/push-token` — Register a push token - `GET /client-data/orders` — Get my orders - `GET /client-data/orders/{orderId}` — Get one of my orders - `GET /client-data/payment-methods` — Get my payment methods - `POST /client-data/payment-methods` — Add a payment method - `DELETE /client-data/payment-methods/{paymentMethodId}` — Remove a payment method - `PUT /client-data/payment-methods/{paymentMethodId}/default` — Set the default payment method - `GET /client-data/profile` — Get my profile - `PUT /client-data/profile` — Update my profile - `GET /client-data/reservations` — Get my reservations - `POST /client-data/reservations` — Make a reservation - `PUT /client-data/reservations` — Update my reservation - `DELETE /client-data/reservations/{reservationId}` — Cancel my reservation - `GET /client-data/reservations/{reservationId}` — Get one of my reservations - `POST /client-data/reservations/available-slots` — Find available slots - `POST /client-data/shared-accounts/{accountId}/invites` — Invite someone to a shared account - `GET /client-data/shared-accounts/{accountId}/members` — List shared account members - `PUT /client-data/shared-accounts/{accountId}/members/{associationId}` — Change a shared account member - `GET /client-data/shared-accounts/{accountId}/orders` — List shared account orders - `POST /client-data/shared-accounts/invites/accept/{invitationToken}` — Accept a shared account invitation - `GET /client-data/shared-accounts/invites/validate/{invitationToken}` — Check a shared account invitation - `GET /client-data/tickets` — Get my support tickets - `POST /client-data/tickets` — Raise a support ticket - `PUT /client-data/tickets` — Update my ticket - `GET /client-data/tickets/{ticketNumber}` — Get one of my tickets - `POST /client-data/tickets/with-attachments` — Raise a ticket with attachments - `GET /client-data/transactions` — Get my transactions - `POST /client-data/verification/email/send` — Send an email verification code - `POST /client-data/verification/email/verify` — Verify an email code - `POST /client-data/verification/phone/send` — Send a phone verification code - `POST /client-data/verification/phone/verify` — Verify a phone code - `GET /client-data/verification/status` — Get my verification status - `GET /client-data/wishlist` — Get my wishlist - `POST /client-data/wishlist` — Create a wishlist - `DELETE /client-data/wishlist-list/{wishlistId}` — Delete a wishlist - `DELETE /client-data/wishlist/{productId}` — Remove a product from my wishlist - `POST /client-data/wishlist/{productId}` — Add a product to my wishlist ### Client Account · Payment links - `GET /client-data/pay/{id}` — What a payment link is for, and what is owed - `POST /client-data/pay/{id}` — Record a payment taken against a payment link - `POST /client-data/pay/{id}/intent` — Start a card payment for a payment link ### Comments - `DELETE /comments/{commentId}` — Delete a comment - `PUT /comments/{commentId}` — Edit a comment - `POST /comments/{commentId}/pin` — Pin a comment - `GET /comments/{commentId}/replies` — List replies to a comment - `POST /comments/{commentId}/report` — Report a comment - `POST /comments/{commentId}/status` — Set a comment's status - `GET /comments/{datatype}/{id}` — List comments on a record - `POST /comments/{datatype}/{id}` — Add a comment - `GET /comments/by-author/{author}` — List an author's comments - `GET /comments/single/{commentId}` — Get one comment ### Community - `GET /client/community/blocks` — List blocked members - `POST /client/community/blocks` — Block a member - `DELETE /client/community/blocks/{userId}` — Unblock a member - `GET /client/community/connections` — List connections - `DELETE /client/community/connections/{id}` — Remove a connection - `PUT /client/community/connections/{id}/respond` — Respond to a connection request - `POST /client/community/connections/accept-all` — Accept all pending requests - `GET /client/community/connections/pending` — List pending requests received - `POST /client/community/connections/request` — Send a connection request - `GET /client/community/connections/sent` — List pending requests sent - `GET /client/community/connections/stats` — Get connection statistics - `GET /client/community/meetings` — List meetings - `POST /client/community/meetings` — Create a meeting - `DELETE /client/community/meetings/{id}` — Cancel a meeting - `GET /client/community/meetings/{id}` — Get a meeting - `PUT /client/community/meetings/{id}` — Update a meeting - `PUT /client/community/meetings/{id}/respond` — Respond to a meeting invitation - `GET /client/community/meetings/upcoming` — List upcoming meetings - `POST /client/community/messages` — Send a direct message - `DELETE /client/community/messages/{id}` — Delete a message - `POST /client/community/messages/read` — Mark messages read - `GET /client/community/messages/thread/{userId}` — Get a conversation - `POST /client/community/messages/thread/{userId}/read` — Mark a conversation read - `GET /client/community/messages/threads` — List conversation threads - `GET /client/community/messages/unread-count` — Get the unread message count - `POST /client/community/reports` — Report a member - `GET /community/blocks` — List blocked members - `POST /community/blocks` — Block a member - `DELETE /community/blocks/{userId}` — Unblock a member - `GET /community/connections` — List connections - `DELETE /community/connections/{id}` — Remove a connection - `PUT /community/connections/{id}/respond` — Respond to a connection request - `POST /community/connections/accept-all` — Accept all pending requests - `GET /community/connections/pending` — List pending requests received - `POST /community/connections/request` — Send a connection request - `GET /community/connections/sent` — List pending requests sent - `GET /community/connections/stats` — Get connection statistics - `GET /community/meetings` — List meetings - `POST /community/meetings` — Create a meeting - `DELETE /community/meetings/{id}` — Cancel a meeting - `GET /community/meetings/{id}` — Get a meeting - `PUT /community/meetings/{id}` — Update a meeting - `PUT /community/meetings/{id}/respond` — Respond to a meeting invitation - `GET /community/meetings/upcoming` — List upcoming meetings - `POST /community/messages` — Send a direct message - `DELETE /community/messages/{id}` — Delete a message - `POST /community/messages/read` — Mark messages read - `GET /community/messages/thread/{userId}` — Get a conversation - `POST /community/messages/thread/{userId}/read` — Mark a conversation read - `GET /community/messages/threads` — List conversation threads - `GET /community/messages/unread-count` — Get the unread message count - `GET /community/reports` — Reports waiting for review - `POST /community/reports` — Report a member - `POST /community/reports/{id}/review` — Review a report: action_taken or dismissed ### Community · Client - `GET /client/community/announcements/{announcementId}` — Get an announcement - `GET /client/community/badges` — List badges - `GET /client/community/badges/mine` — Get my badges - `GET /client/community/bookmarks` — Get my bookmarks - `POST /client/community/bookmarks` — Bookmark an item - `DELETE /client/community/bookmarks/{target}` — Remove a bookmark - `DELETE /client/community/comments/{commentId}` — Delete a comment - `GET /client/community/feed` — Get the community feed - `POST /client/community/follow` — Follow someone or something - `DELETE /client/community/follow/{followingId}` — Unfollow - `GET /client/community/followers` — List my followers - `GET /client/community/following` — List what I follow - `GET /client/community/groups` — List my group chats - `POST /client/community/groups` — Create a group chat - `GET /client/community/groups/{groupId}` — Get a group chat - `POST /client/community/groups/{groupId}/members` — Add a group member - `DELETE /client/community/groups/{groupId}/members/{email}` — Remove a group member or leave - `GET /client/community/groups/{groupId}/messages` — Get group messages - `POST /client/community/groups/{groupId}/messages` — Send a group message - `GET /client/community/hashtags/trending` — Get trending hashtags - `DELETE /client/community/media/{path}` — Delete media - `GET /client/community/media/mine` — List my media - `PUT /client/community/media/rename` — Rename media - `POST /client/community/media/upload` — Upload media - `GET /client/community/notifications` — Get notifications - `POST /client/community/notifications/read` — Mark notifications read - `POST /client/community/notifications/read-all` — Mark all notifications read - `GET /client/community/notifications/unread-count` — Get the unread notification count - `GET /client/community/pages` — List community pages - `POST /client/community/pages` — Create a community page - `GET /client/community/pages/{pageId}` — Get a community page - `PUT /client/community/pages/{pageId}` — Update a community page - `GET /client/community/pages/{pageId}/announcements` — Get page announcements - `POST /client/community/pages/{pageId}/announcements` — Create an announcement - `POST /client/community/pages/{pageId}/invite` — Invite someone to a page - `POST /client/community/pages/{pageId}/join` — Join a page - `POST /client/community/pages/{pageId}/leave` — Leave a page - `GET /client/community/pages/{pageId}/members` — List page members - `GET /client/community/pages/mine` — List my pages - `GET /client/community/people` — Search people - `GET /client/community/people/{email}` — Get a public profile - `GET /client/community/people/suggestions` — Get people suggestions - `POST /client/community/posts` — Create a post - `DELETE /client/community/posts/{postId}` — Delete a post - `GET /client/community/posts/{postId}` — Get a post - `PUT /client/community/posts/{postId}` — Update a post - `GET /client/community/posts/{postId}/comments` — Get post comments - `POST /client/community/posts/{postId}/comments` — Add a comment - `POST /client/community/posts/{postId}/share` — Share a post - `POST /client/community/posts/{postId}/vote` — Vote in a poll - `POST /client/community/react` — React to something - `GET /client/community/reactions` — Get reactions on a target - `GET /client/community/stories` — Get stories - `POST /client/community/stories` — Create a story - `DELETE /client/community/stories/{storyId}` — Delete a story - `POST /client/community/stories/{storyId}/view` — Mark a story viewed ### Community · Topics - `GET /social/topics` — List social topics - `POST /social/topics` — Create a social topic - `DELETE /social/topics/{id}` — Delete a social topic - `GET /social/topics/{id}` — Get a social topic - `PUT /social/topics/{id}` — Update a social topic - `POST /social/topics/{id}/backfill` — Backfill one topic - `POST /social/topics/backfill` — Backfill all topics - `POST /social/topics/test` — Test a topic against a sample ### Connect - `GET /connect/automation/{id}/{stepId}/{entity}/{activity}` — Automation webhook (GET) - `POST /connect/automation/{id}/{stepId}/{entity}/{activity}` — Automation webhook (POST) - `GET /connect/oauth2callback/{vendor}` — OAuth callback - `GET /connect/webhook/{vendor}/{serviceId}` — Partner webhook (GET) - `POST /connect/webhook/{vendor}/{serviceId}` — Partner webhook (POST) ### Content Studio · Participant - `GET /client/content-studio/{course}` — A course, its outline and my enrollment - `POST /client/content-studio/{course}/enroll` — Enroll myself - `GET /client/content-studio/{course}/items/{itemId}` — Open an item - `POST /client/content-studio/{course}/items/{itemId}/answer` — Send in an item’s answer - `POST /client/content-studio/{course}/items/{itemId}/progress` — Report an item - `GET /client/content-studio/mine` — My courses ### Content Studio · Staff - `GET /content-studio/{course}/enrollments` — Course roster - `POST /content-studio/{course}/enrollments` — Enroll people by email - `GET /content-studio/{course}/preview` — Preview a course - `GET /content-studio/{course}/review` — Waiting for review — one course - `GET /content-studio/enrollments/{id}` — One enrollment in full - `POST /content-studio/enrollments/{id}/review/{itemId}` — Decide on an item - `POST /content-studio/enrollments/{id}/withdraw` — Withdraw an enrollment - `GET /content-studio/review` — Waiting for review — all courses ### Content Studio Client - `GET /client/content-studio/{course}/preview` — The author’s preview: every page open, nothing recorded — for whoever holds a live preview key ### Courses - `POST /content-studio/{course}/preview-key` ### Creative Studio - `POST /creative-studio/assets` — Add an uploaded image to the library - `POST /creative-studio/designs/{id}/duplicate` — Duplicate a design - `POST /creative-studio/designs/{id}/rename` — Rename a design - `POST /creative-studio/designs/{id}/save` — Save a design from the editor - `POST /creative-studio/designs/{id}/thumbnail` — Store a design preview - `POST /creative-studio/designs/create` — Create a design - `POST /creative-studio/designs/list` — List the design library ### CRM - `GET /crm/flexdata/get/{id}` — Get flex data - `GET /crm/place/near-by` — Find nearby places ### CRM · Activity - `GET /crm/customer-activity/{email}/summary` — Get a customer activity summary - `GET /crm/customer-activity/{email}/timeline` — Get a customer activity timeline - `POST /crm/customer-activity/erase` — Erase customer activity - `POST /crm/customer-activity/identify` — Identify a visitor - `POST /crm/customer-activity/record` — Record customer activity - `GET /crm/customer-activity/visitor/{visitorId}/timeline` — Get an anonymous visitor timeline ### CRM · Ads - `GET /crm/ads/accounts` — List connected ad accounts - `POST /crm/ads/accounts/sync` — Sync ad accounts - `GET /crm/ads/activity` — Get advertising activity - `GET /crm/ads/analytics/comparison` — Compare platforms - `GET /crm/ads/analytics/overview` — Get an advertising overview - `GET /crm/ads/analytics/performance` — Get performance analytics - `GET /crm/ads/analytics/trends` — Get advertising trends - `GET /crm/ads/audiences` — List audiences - `POST /crm/ads/audiences` — Create an audience - `GET /crm/ads/automation/rules` — List automation rules - `POST /crm/ads/automation/rules` — Create an automation rule - `GET /crm/ads/campaigns` — List ad campaigns - `POST /crm/ads/campaigns` — Create an ad campaign - `DELETE /crm/ads/campaigns/{campaignId}` — Delete an ad campaign - `GET /crm/ads/campaigns/{campaignId}` — Get an ad campaign - `PUT /crm/ads/campaigns/{campaignId}` — Update an ad campaign - `POST /crm/ads/campaigns/bulk/launch` — Launch several campaigns - `POST /crm/ads/campaigns/bulk/pause` — Pause several campaigns - `POST /crm/ads/campaigns/cross-platform` — Create a cross-platform campaign - `POST /crm/ads/campaigns/duplicate/{campaignId}` — Duplicate a campaign - `POST /crm/ads/campaigns/from-template/{templateId}` — Create a campaign from a template - `POST /crm/ads/campaigns/launch/{campaignId}` — Launch a campaign - `GET /crm/ads/campaigns/metrics/{campaignId}` — Get campaign metrics - `POST /crm/ads/campaigns/pause/{campaignId}` — Pause a campaign - `POST /crm/ads/campaigns/resume/{campaignId}` — Resume a campaign - `POST /crm/ads/campaigns/schedule/{campaignId}` — Schedule a campaign - `GET /crm/ads/creatives` — List creatives - `POST /crm/ads/creatives` — Upload a creative - `GET /crm/ads/integrations/status` — Get platform integration status - `POST /crm/ads/integrations/test/{platform}` — Test a platform integration - `GET /crm/ads/reports` — List advertising reports - `POST /crm/ads/reports/generate` — Generate an advertising report - `GET /crm/ads/scheduled` — List scheduled campaigns - `GET /crm/ads/templates` — List campaign templates - `POST /crm/ads/templates` — Create a campaign template ### CRM · AI - `GET /crm/ai-assistant` — List AI assistants - `POST /crm/ai-assistant` — Create an AI assistant - `DELETE /crm/ai-assistant/{id}` — Delete an AI assistant - `GET /crm/ai-assistant/{id}` — Get an AI assistant - `PUT /crm/ai-assistant/{id}` — Update an AI assistant - `GET /crm/ai-assistant/{id}/activities` — Get one assistant's activity - `POST /crm/ai-assistant/{id}/execute` — Run an AI assistant - `POST /crm/ai-assistant/{id}/execute/stream` — Run an AI assistant, streaming - `POST /crm/ai-assistant/{id}/test` — Try an AI assistant - `GET /crm/ai-assistant/activities` — Get AI assistant activity - `GET /crm/ai-assistant/capabilities` — List built-in capabilities - `GET /crm/ai-assistant/tools` — List available tools - `GET /crm/ai-assistant/triggers` — List trigger events - `POST /crm/ai-assistant/voice/setup` — Set up a voice assistant - `GET /crm/ai-assistant/voice/templates` — List voice assistant templates ### CRM · Alerts - `POST /crm/alert/sms` — Create an SMS alert - `GET /crm/alert/sms/{id}` — Get SMS alerts ### CRM · Audiences - `GET /crm/marketing/audiences/custom` — List custom audiences - `POST /crm/marketing/audiences/custom` — Create a custom audience - `GET /crm/marketing/audiences/custom-types` — List custom audience types - `POST /crm/marketing/audiences/estimate-reach` — Estimate audience reach - `GET /crm/marketing/audiences/interests` — List targetable interests - `GET /crm/marketing/audiences/locations` — List targetable locations - `GET /crm/marketing/audiences/segments` — List audience segments - `POST /crm/marketing/audiences/segments` — Create an audience segment - `DELETE /crm/marketing/audiences/segments/{id}` — Delete an audience segment - `GET /crm/marketing/audiences/segments/{id}` — Get an audience segment - `PUT /crm/marketing/audiences/segments/{id}` — Update an audience segment - `GET /crm/marketing/audiences/segments/{id}/insights` — Get audience insights - `GET /crm/marketing/audiences/segments/{id1}/overlap/{id2}` — Get overlap between two audiences - `GET /crm/marketing/audiences/targeting-options` — List all targeting options ### CRM · Auto-campaign - `POST /crm/auto-campaign/ai/audience-suggestions` — Get AI audience suggestions - `POST /crm/auto-campaign/ai/generate-images` — Generate campaign images - `POST /crm/auto-campaign/approve` — Approve and launch a generated campaign - `GET /crm/auto-campaign/health` — Get auto-campaign health - `GET /crm/auto-campaign/platforms` — List auto-campaign platforms - `DELETE /crm/auto-campaign/preview/{previewId}` — Discard a campaign preview - `GET /crm/auto-campaign/preview/{previewId}` — Get a campaign preview - `GET /crm/auto-campaign/preview/{previewId}/predictions/{platform}` — Get performance predictions - `POST /crm/auto-campaign/preview/{previewId}/regenerate/{platform}` — Regenerate one platform's creative - `POST /crm/auto-campaign/preview/{previewId}/variations/{platform}` — Generate creative variations - `POST /crm/auto-campaign/sell-like-mad` — Generate a campaign automatically ### CRM · Benefits - `GET /crm/benefit-enrollments` — List benefit enrolments - `DELETE /crm/benefit-enrollments/{enrollmentId}` — Delete a benefit enrolment - `POST /crm/benefit-enrollments/{enrollmentId}/action` — Review, approve or reject an enrolment - `POST /crm/workflows/benefit-application` — Create a benefit application workflow - `GET /crm/workflows/benefit-application/{name}` — Get the benefit application workflow ### CRM · Chat - `POST /crm/chat-message/create` — Create a chat message - `DELETE /crm/chat-message/delete/{id}` — Delete a chat message - `GET /crm/chat-message/get/{id}` — Get chat messages - `POST /crm/chat-message/update` — Update a chat message ### CRM · Communications - `GET /crm/communications` — List all communications - `GET /crm/communications/calls` — List call logs - `GET /crm/communications/recordings` — List call recordings - `GET /crm/communications/recordings/{recordingSid}` — Get a call recording - `GET /crm/communications/recordings/{recordingSid}/audio` — Get recording audio - `POST /crm/communications/recordings/transcribe` — Request a transcription - `GET /crm/communications/sms` — List SMS messages - `GET /crm/communications/stats` — Get communication statistics - `GET /crm/communications/twilio-sms` — List SMS from Twilio - `GET /crm/communications/twilio/available-numbers` — List available phone numbers - `POST /crm/communications/twilio/setup` — Set up a Twilio number - `GET /crm/communications/twilio/system-phone` — Get the system phone number - `GET /crm/communications/twilio/verify` — Verify Twilio setup - `GET /crm/communications/voicemails` — List voicemails ### CRM · Customers - `GET /crm/customer-data/{customerId}` — Get complete customer data - `POST /crm/customer-data/{customerId}` — Add linked data to a customer ### CRM · Documents - `GET /crm/signed-documents` — List signed documents - `POST /crm/signed-documents` — Create a signed document - `DELETE /crm/signed-documents/{id}` — Delete a signed document - `GET /crm/signed-documents/{id}` — Get a signed document - `POST /crm/signed-documents/{id}/cancel` — Cancel a signature request - `POST /crm/signed-documents/{id}/remind` — Remind signers - `POST /crm/signed-documents/{id}/send` — Send a document for signature - `POST /crm/signed-documents/{id}/update` — Update a signed document - `POST /crm/signed-documents/{id}/void` — Void a signed document - `GET /crm/signed-documents/context/{datatype}/{id}` — Get documents for a record - `GET /crm/signed-documents/portal/{token}` — Get a document from the signing portal - `POST /crm/signed-documents/portal/{token}/decline` — Decline to sign - `POST /crm/signed-documents/portal/{token}/sign` — Sign a document ### CRM · Events - `POST /crm/events/create` — Create a CRM event - `DELETE /crm/events/delete/{id}` — Delete a CRM event - `GET /crm/events/get/{id}` — Get CRM events - `POST /crm/events/update` — Update a CRM event ### CRM · Forms - `POST /crm/collection-form/{number}/{demo}-email?` — Send a form to its participants (legacy) - `POST /crm/contact-form/json/{app}/{name}` — Submit a contact form as JSON - `POST /crm/contact-form/post/{app}/{name}` — Submit a contact form (multipart) - `DELETE /crm/form/{id}` — Delete a form - `GET /crm/form/{name}` — Open a form - `POST /crm/form/{name}/access` — Ask for a form link or code - `POST /crm/form/{name}/invite` — Invite a form's participants - `POST /crm/form/submit/{name}/{email}` — Submit a form - `GET /crm/forms/overview` — Forms overview - `GET /crm/forms/submissions` — All form submissions ### CRM · Inbox - `GET /crm/inbox/conversations` — List inbox conversations - `GET /crm/inbox/conversations/{parties}` — Get messages in a conversation - `DELETE /crm/inbox/delete/{id}` — Delete an inbox message - `GET /crm/inbox/messages` — List inbox messages - `GET /crm/inbox/messages/{id}` — Get an inbox message - `GET /crm/inbox/notifications/{id}` — Get inbox notifications - `POST /crm/inbox/save-push-token` — Save a push notification token - `DELETE /crm/inbox/thread/{parties}` — Delete a conversation - `POST /crm/inbox/update` — Update or send a message - `POST /crm/inbox/update-status/{messageId}/{status}` — Set a message status ### CRM · Leads - `GET /crm/leads/activities/{id}` — Get a lead's activities - `POST /crm/leads/activities/{id}` — Add an activity to a lead - `GET /crm/leads/analytics` — Get lead analytics - `POST /crm/leads/assign/{id}` — Assign a lead - `POST /crm/leads/bulk-import/contacts` — Bulk import contacts as leads - `POST /crm/leads/convert/{id}` — Convert a lead - `POST /crm/leads/convert/contact/{contactId}` — Convert one contact into a lead - `GET /crm/leads/detail` — List leads - `POST /crm/leads/detail` — Create a lead - `DELETE /crm/leads/detail/{id}` — Delete a lead - `GET /crm/leads/detail/{id}` — Get a lead - `PUT /crm/leads/detail/{id}` — Update a lead - `POST /crm/leads/disqualify/{id}` — Disqualify a lead - `POST /crm/leads/enrich/{id}` — Enrich a lead - `POST /crm/leads/enrich/auto` — Enrich leads automatically - `POST /crm/leads/enrich/batch` — Enrich several leads - `GET /crm/leads/enrichment/status/{id}` — Get enrichment status - `POST /crm/leads/follow-up/{id}` — Schedule a follow-up - `GET /crm/leads/forecast` — Pipeline forecast - `POST /crm/leads/import` — Import leads from spreadsheet rows - `POST /crm/leads/import/contacts` — Import leads from contacts - `POST /crm/leads/import/facebook` — Import leads from Facebook - `POST /crm/leads/qualify/{id}` — Qualify a lead - `POST /crm/leads/score/{id}` — Calculate a lead score - `POST /crm/leads/score/batch` — Score all leads - `POST /crm/leads/sla/sweep` — Run the stage-SLA sweep now ### CRM · Marketing - `GET /crm/marketing/campaign-manager-performance` — Campaign performance summary - `DELETE /crm/marketing/campaign-manager/{id}` — Delete a campaign - `GET /crm/marketing/campaign-manager/{id}` — Get a campaign card - `POST /crm/marketing/campaign-manager/{id}/actuals` — Enter actual results - `POST /crm/marketing/campaign-manager/{id}/ad-account` — Override a campaign's ad account on one platform - `POST /crm/marketing/campaign-manager/{id}/complete` — End a campaign - `POST /crm/marketing/campaign-manager/{id}/copy` — Save ad copy - `POST /crm/marketing/campaign-manager/{id}/duplicate` — Duplicate a campaign - `POST /crm/marketing/campaign-manager/{id}/launch` — Launch a campaign - `POST /crm/marketing/campaign-manager/{id}/pause` — Pause a campaign - `POST /crm/marketing/campaign-manager/{id}/refresh-metrics` — Pull platform insights - `POST /crm/marketing/campaign-manager/{id}/resume` — Resume a paused campaign - `POST /crm/marketing/campaign-manager/{id}/schedule` — Schedule a launch - `POST /crm/marketing/campaign-manager/{id}/test-launch` — Test-launch a campaign on Meta, paused - `POST /crm/marketing/campaign-manager/{id}/test-remove` — Remove a paused test campaign - `POST /crm/marketing/campaign-manager/{id}/unschedule` — Cancel a scheduled launch - `POST /crm/marketing/campaign-manager/{id}/update` — Update a campaign - `GET /crm/marketing/campaign-manager/ad-accounts` — List the ad accounts a platform connection can use - `GET /crm/marketing/campaign-manager/ad-accounts/{platform}` — Ad accounts for one platform - `POST /crm/marketing/campaign-manager/ad-accounts/default` — Choose a platform connection's ad account - `GET /crm/marketing/campaign-manager/ads-readiness` — Check whether each ad platform can publish ads - `GET /crm/marketing/campaign-manager/ads-readiness/{campaignId}` — Ads readiness for one campaign - `POST /crm/marketing/campaign-manager/create` — Create a campaign - `POST /crm/marketing/campaign-manager/list` — List campaigns (Campaign Manager) - `POST /crm/marketing/campaign-manager/social-draft` — Draft a social post for a campaign - `GET /crm/marketing/campaign-manager/social-feeds` — Social feeds by platform - `GET /crm/marketing/campaign-types` — List campaign types - `GET /crm/marketing/campaigns` — List marketing campaigns - `POST /crm/marketing/campaigns` — Create a marketing campaign - `DELETE /crm/marketing/campaigns/{id}` — Delete a marketing campaign - `GET /crm/marketing/campaigns/{id}` — Get a marketing campaign - `PUT /crm/marketing/campaigns/{id}` — Update a marketing campaign - `GET /crm/marketing/campaigns/{id}/analytics` — Get campaign analytics - `POST /crm/marketing/campaigns/aggregated-metrics` — Get aggregated campaign metrics - `GET /crm/marketing/dashboard` — Get the marketing dashboard - `GET /crm/marketing/health` — Get marketing health - `GET /crm/marketing/platforms` — List marketing platforms - `GET /crm/marketing/social-profiles/{platform}` — Get connected social profiles ### CRM · Merchant accounts - `POST /crm/merchant-customers/approve/{id}` — Approve a merchant account - `GET /crm/merchant-customers/authorized/{id}/{customerId}` — Check whether a user is authorized - `GET /crm/merchant-customers/balances/outstanding` — Get outstanding balances - `GET /crm/merchant-customers/by-customer/{customerId}` — Get a merchant account by customer - `POST /crm/merchant-customers/charge/{id}` — Charge to an account - `POST /crm/merchant-customers/close/{id}` — Close a merchant account - `POST /crm/merchant-customers/credit/{id}` — Credit an account - `GET /crm/merchant-customers/dashboard` — Get merchant dashboard metrics - `GET /crm/merchant-customers/detail` — List merchant accounts - `POST /crm/merchant-customers/detail` — Create a merchant account - `GET /crm/merchant-customers/detail/{id}` — Get a merchant account - `PUT /crm/merchant-customers/detail/{id}` — Update a merchant account - `GET /crm/merchant-customers/invoices/all` — Get all invoices across merchants - `POST /crm/merchant-customers/invoices/generate-all` — Generate invoices for all merchants - `POST /crm/merchant-customers/invoices/generate/{id}` — Generate an invoice for an account - `POST /crm/merchant-customers/invoices/mark-overdue/{id}/{invoiceId}` — Mark an invoice overdue - `POST /crm/merchant-customers/invoices/payment/{id}/{invoiceId}` — Record an invoice payment - `POST /crm/merchant-customers/invoices/send-all` — Send all draft invoices - `POST /crm/merchant-customers/invoices/send/{id}/{invoiceId}` — Send an invoice - `PUT /crm/merchant-customers/payment-terms/{id}` — Set payment terms - `POST /crm/merchant-customers/reactivate/{id}` — Reactivate a merchant account - `POST /crm/merchant-customers/reminders/{merchantId}/{invoiceId}` — Send a payment reminder - `POST /crm/merchant-customers/reminders/bulk` — Send reminders for all overdue invoices - `GET /crm/merchant-customers/reports/aging` — Get the accounts receivable aging report - `PUT /crm/merchant-customers/spending-limit/{id}` — Set a spending limit - `GET /crm/merchant-customers/statements/{merchantId}` — Generate an account statement - `POST /crm/merchant-customers/statements/{merchantId}/send` — Generate and send an account statement - `GET /crm/merchant-customers/stats/{id}` — Get account statistics - `POST /crm/merchant-customers/suspend/{id}` — Suspend a merchant account - `GET /crm/merchant-customers/transactions/{id}` — Get an account's transaction history - `GET /crm/merchant-customers/transactions/all` — Get all transactions across merchants - `POST /crm/merchant-customers/users/{id}` — Add an authorized user - `DELETE /crm/merchant-customers/users/{id}/{customerId}` — Remove an authorized user - `PUT /crm/merchant-customers/users/{id}/{customerId}` — Update an authorized user ### CRM · Pipelines - `GET /crm/leads/pipelines` — List lead pipelines - `POST /crm/leads/pipelines` — Create a lead pipeline - `DELETE /crm/leads/pipelines/{id}` — Delete a lead pipeline - `GET /crm/leads/pipelines/{id}` — Get a lead pipeline - `PUT /crm/leads/pipelines/{id}` — Update a lead pipeline - `POST /crm/leads/pipelines/{id}/route-unassigned` — Route unassigned leads in a pipeline - `POST /crm/leads/pipelines/stages/{id}` — Add a stage to a pipeline - `DELETE /crm/leads/pipelines/stages/{id}/{stageId}` — Delete a pipeline stage - `PUT /crm/leads/pipelines/stages/{id}/{stageId}` — Update a pipeline stage - `PUT /crm/leads/pipelines/stages/reorder/{id}` — Reorder pipeline stages ### CRM · Promotions - `GET /crm/promotions` — List promotions - `POST /crm/promotions` — Create a promotion - `DELETE /crm/promotions/{name}` — Delete a promotion - `GET /crm/promotions/{name}` — Get a promotion - `PUT /crm/promotions/{name}` — Update a promotion - `POST /crm/promotions/{name}/incentive-claimed` — Record an incentive claim - `POST /crm/promotions/{name}/subscribe` — Subscribe to a promotion - `GET /crm/promotions/{name}/subscribers` — List promotion subscribers - `POST /crm/promotions/{name}/unsubscribe` — Unsubscribe from a promotion - `GET /crm/promotions/confirm/{token}` — Confirm a subscription - `GET /crm/promotions/preferences` — Get subscription preferences ### CRM · Reservations - `POST /crm/reservations/availability` — Availability across a run of days - `GET /crm/reservations/by-email/{email}/{reservationNumber}` — Get reservations by email - `DELETE /crm/reservations/cancel/{email}/{reservationNumber}` — Cancel a reservation - `POST /crm/reservations/create` — Create a reservation - `GET /crm/reservations/definitions` — Get reservation definitions - `DELETE /crm/reservations/delete/{id}` — Delete a reservation - `GET /crm/reservations/get/{id}` — Get reservations - `POST /crm/reservations/meeting/create` — Create a meeting room - `GET /crm/reservations/meeting/token` — Get a meeting token - `POST /crm/reservations/meeting/validate` — Validate a meeting - `GET /crm/reservations/mine` — My hosted bookings - `POST /crm/reservations/reschedule/{id}` — Reschedule a reservation - `POST /crm/reservations/send-reminder/{reservationId}` — Send a reservation reminder - `POST /crm/reservations/service-point/create` — Create a service point - `DELETE /crm/reservations/service-point/delete/{id}` — Delete a service point - `GET /crm/reservations/service-point/get/{id}` — Get service points - `POST /crm/reservations/service-point/update` — Update a service point - `POST /crm/reservations/slot-bookings` — Bookings in a slot - `POST /crm/reservations/slots` — Generate appointment slots - `GET /crm/reservations/stats` — Reservation figures - `POST /crm/reservations/update` — Update a reservation ### CRM · Shared accounts - `GET /crm/shared-accounts` — List shared accounts - `GET /crm/shared-accounts/{accountId}` — Get a shared account - `GET /crm/shared-accounts/{accountId}/activity` — Shared account activity - `POST /crm/shared-accounts/{accountId}/invites/{invitationId}/cancel` — Withdraw an invitation - `POST /crm/shared-accounts/{accountId}/members` — Add someone to a shared account - `DELETE /crm/shared-accounts/{accountId}/members/{associationId}` — Remove a shared account member - `PUT /crm/shared-accounts/{accountId}/members/{associationId}` — Change a shared account member - `GET /crm/shared-accounts/{accountId}/orders` — Shared account orders ### CRM · Social - `GET /sync/social-activities/ads` — Get social ad activity - `GET /sync/social-activities/ai-hold` — Get AI hold state for a customer - `POST /sync/social-activities/ai-hold` — Pause or resume AI replies to a customer - `GET /sync/social-activities/analytics` — Get social analytics records - `GET /sync/social-activities/author/{authorId}` — Get activity by author - `GET /sync/social-activities/campaigns` — Get social campaign activity - `GET /sync/social-activities/comments` — Get social comments - `GET /sync/social-activities/conversation-thread` — Get a social conversation thread - `GET /sync/social-activities/conversations` — List social conversations - `GET /sync/social-activities/dashboard/analytics` — Get social dashboard analytics - `GET /sync/social-activities/dashboard/analytics/{platform}` — Get dashboard analytics for one platform - `GET /sync/social-activities/engagement` — Get engagement activity - `GET /sync/social-activities/leads` — Get social leads - `GET /sync/social-activities/messages` — Get social messages - `GET /sync/social-activities/metrics/business` — Get business metrics from social - `GET /sync/social-activities/metrics/engagement` — Get engagement metrics - `GET /sync/social-activities/platform/{platform}/type/{activityType}` — Get activity by platform and type - `GET /sync/social-activities/platforms` — List platforms with activity - `GET /sync/social-activities/posts` — Get social posts - `GET /sync/social-activities/profiles/{platform}` — Get connected social profiles - `GET /sync/social-activities/refresh/{platform}/{action}` — Refresh social data from a platform - `POST /sync/social-activities/reply` — Reply to a social message or comment - `POST /sync/social-activities/search` — Search social activity - `GET /sync/social-activities/summary/platforms` — Get a per-platform summary ### CRM · Templates - `POST /crm/send-invitation` — Send an invitation - `POST /crm/send-template` — Send a templated message - `POST /crm/test-template` — Test a message template ### CRM · Tickets - `PATCH /crm/tickets/assign/{ticketId}` — Reassign a ticket - `POST /crm/tickets/bulk-update` — Update several tickets - `GET /crm/tickets/canned-responses` — Get canned responses - `POST /crm/tickets/chat-request` — Leave a request from the chat widget - `GET /crm/tickets/collections` — Get ticket collections - `GET /crm/tickets/comments/{ticketId}` — Get internal comments - `POST /crm/tickets/comments/{ticketId}` — Add an internal comment - `POST /crm/tickets/create` — Create a ticket - `POST /crm/tickets/create-ticket` — Create a ticket (alternate) - `DELETE /crm/tickets/delete-by-email/{email}/{id}` — Delete a ticket by email - `DELETE /crm/tickets/delete/{id}` — Delete a ticket - `POST /crm/tickets/email/create/{email}` — Create a ticket for an email address - `GET /crm/tickets/get-by-email/{email}/{number}` — Get tickets by email - `GET /crm/tickets/get/{number}` — Get tickets - `GET /crm/tickets/list` — List tickets (staff) - `GET /crm/tickets/messages/{ticketId}` — Get ticket messages - `PATCH /crm/tickets/priority/{ticketId}` — Change a ticket priority - `POST /crm/tickets/reply/{ticketId}` — Reply to a ticket - `POST /crm/tickets/report-ide-issue` — Report an IDE issue - `PATCH /crm/tickets/status/{ticketId}` — Change a ticket status - `POST /crm/tickets/update` — Update a ticket - `GET /crm/tickets/workflow/{id}` — Where a ticket stands in its workflow - `GET /crm/tickets/workflows` — Ticket workflows ### Customer 360 - `GET /crm/customer-360` — Everything recent about a phone number or email ### Data enrichment - `POST /enrichment/bulk` — Bulk enrich - `POST /enrichment/cache/clear` — Clear the enrichment cache - `POST /enrichment/company` — Enrich a company - `POST /enrichment/person` — Enrich a person - `GET /enrichment/providers` — List enrichment providers - `GET /enrichment/providers/{name}/status` — Get a provider's status - `POST /enrichment/search/companies` — Search for companies - `POST /enrichment/search/persons` — Search for people - `POST /enrichment/validate-email` — Validate an email address ### Device integrations - `GET /device-integrations/adapters` — List device adapters - `GET /device-integrations/adapters/configured` — List configured adapters - `POST /device-integrations/call` — Dispatch a device call - `GET /device-integrations/events` — Stream hub events - `GET /device-integrations/hubs/{hubName}/discover-paths` — Discover device paths on a hub - `POST /device-integrations/hubs/{hubName}/endpoints` — Configure a hub peripheral - `POST /device-integrations/hubs/{hubName}/ping` — Ping a hub - `GET /device-integrations/hubs/{hubName}/state` — Get a hub's diagnostic state - `POST /device-integrations/hubs/{sk}/api-key` — Generate a hub API key - `GET /device-integrations/hubs/live-states` — Get live hub states - `POST /device-integrations/page` — Page a guest ### Events - `GET /events` — List events - `GET /events/{eventId}/checkin-stats` — Get check-in statistics - `GET /events/{eventId}/credentials` — List credentials - `POST /events/{eventId}/credentials/import` — Import credentials - `POST /events/{eventId}/credentials/import-range` — Import a credential range - `GET /events/{eventId}/media` — Get event media - `GET /events/{eventId}/media/guest/{guestId}` — Get a guest's media - `GET /events/{eventId}/media/guests` — List media contributors - `POST /events/{eventId}/media/share` — Share event media - `POST /events/{eventId}/media/upload` — Upload event media - `POST /events/{eventId}/media/upload/{guestId}` — Upload media as a guest - `GET /events/{eventId}/occupancy` — Get live occupancy - `GET /events/{eventId}/participants` — List participants - `POST /events/{eventId}/participants` — Add a participant - `GET /events/{eventId}/schedule` — Get the event schedule - `GET /events/{eventId}/sessions` — List sessions - `POST /events/{eventId}/sessions` — Create a session - `GET /events/{eventId}/ticket-types` — Get ticket types - `GET /events/{eventId}/tickets` — List event tickets - `POST /events/{eventId}/tickets` — Issue a ticket - `GET /events/{id}` — Get an event - `POST /events/{id}/cancel` — Cancel an event - `POST /events/{id}/complete` — Complete an event - `POST /events/{id}/live` — Mark an event live - `POST /events/{id}/publish` — Publish an event - `POST /events/bookings/{bookingId}/cancel` — Cancel a booking - `POST /events/bookings/{bookingId}/refund` — Refund a booking - `POST /events/checkin` — Check someone in - `POST /events/checkout` — Check someone out - `POST /events/credentials/{code}/revoke` — Revoke a credential - `POST /events/credentials/assign` — Assign a credential - `DELETE /events/participants/{participantId}` — Delete a participant - `PUT /events/participants/{participantId}` — Update a participant - `POST /events/participants/{participantId}/cancel` — Cancel a participant - `POST /events/participants/{participantId}/confirm` — Confirm a participant - `DELETE /events/sessions/{sessionId}` — Delete a session - `PUT /events/sessions/{sessionId}` — Update a session - `DELETE /events/tickets/{ticketId}` — Delete a ticket - `POST /events/tickets/{ticketId}/activate` — Activate a pre-generated ticket - `GET /events/tickets/{ticketId}/badge` — Get a ticket badge - `POST /events/tickets/{ticketId}/badge/printed` — Mark a badge as printed - `POST /events/tickets/{ticketId}/cancel` — Cancel a ticket - `GET /events/tickets/{ticketId}/perks` — Get ticket perks - `POST /events/tickets/{ticketId}/perks/{perkId}/claim` — Claim a perk - `POST /events/tickets/{ticketId}/perks/{perkId}/fulfill` — Fulfil a perk - `GET /events/tickets/{ticketId}/qr` — Get a ticket QR code - `POST /events/tickets/{ticketId}/refund` — Refund a ticket - `POST /events/tickets/{ticketId}/transfer` — Transfer a ticket - `POST /events/tickets/comp` — Issue complimentary tickets - `POST /events/tickets/fulfill` — Fulfil tickets - `GET /events/tickets/lookup/{eventId}` — Look up a ticket - `POST /events/tickets/pre-generate` — Pre-generate tickets - `POST /events/tickets/purchase` — Purchase tickets - `POST /events/tickets/validate` — Validate a ticket - `POST /events/verify-scan` — Verify a scan without admitting ### Events · Attendee - `GET /client/events` — Browse events - `GET /client/events/{eventId}` — Get an event - `GET /client/events/{eventId}/media` — Get event media - `GET /client/events/{eventId}/media/guest/{guestId}` — Get a guest's media - `POST /client/events/{eventId}/media/upload` — Upload media to an event - `POST /client/events/{eventId}/media/upload/{guestId}` — Upload media as a guest - `GET /client/events/{eventId}/participants` — Get event participants - `GET /client/events/{eventId}/schedule` — Get the event schedule - `GET /client/events/{eventId}/sessions` — Get event sessions - `GET /client/events/{eventId}/ticket-types` — Get ticket types - `GET /client/events/booking` — Look up a booking - `PUT /client/events/participation/{participantId}/respond` — Respond to a participation invitation - `GET /client/events/participation/mine` — Get my participation invitations - `POST /client/events/stripe/checkout-session` — Create a Stripe Checkout session - `GET /client/events/stripe/config` — Get the Stripe configuration - `POST /client/events/stripe/intent` — Create a Stripe PaymentIntent - `GET /client/events/tickets/{ticketId}` — Get a ticket - `GET /client/events/tickets/{ticketId}/perks` — Get ticket perks - `GET /client/events/tickets/{ticketId}/qr` — Get a ticket QR code - `POST /client/events/tickets/{ticketId}/transfer` — Transfer a ticket - `POST /client/events/tickets/confirm-order` — Confirm a ticket order - `GET /client/events/tickets/mine` — Get my tickets - `POST /client/events/tickets/purchase` — Purchase tickets - `POST /client/events/tickets/register` — Register for an event ### Finance · ACH batches - `GET /finance/payout-batches` — List ACH batches - `POST /finance/payout-batches` — Build an ACH batch - `GET /finance/payout-batches/{batchId}/file` — Download an ACH batch file - `POST /finance/payout-batches/{batchId}/items/{payoutId}/return` — Record an ACH return - `POST /finance/payout-batches/{batchId}/sent` — Mark an ACH batch sent to the bank - `POST /finance/payout-batches/{batchId}/settle` — Mark an ACH batch settled - `GET /finance/payout-batches/eligible` — List bank payouts waiting for a batch ### Finance · My account - `GET /client/finance/payout-methods` — Get my payout methods - `POST /client/finance/payout-methods` — Add a payout method - `DELETE /client/finance/payout-methods/{methodId}` — Remove a payout method - `PUT /client/finance/payout-methods/{methodId}` — Update a payout method - `PUT /client/finance/payout-methods/{methodId}/default` — Set the default payout method - `PUT /client/finance/payout-settings` — Update my payout settings - `GET /client/finance/payouts` — Get my payouts - `GET /client/finance/payouts/{payoutId}` — Get one of my payouts - `POST /client/finance/payouts/request` — Request a payout - `GET /client/finance/wallet` — Get my wallet ### Finance · Payments - `POST /finance/payments/action` — Execute a payment action - `POST /finance/payments/authorize` — Authorize a payment - `POST /finance/payments/cancel` — Cancel a payment - `POST /finance/payments/capture` — Capture an authorized payment - `POST /finance/payments/charge` — Charge a payment method - `GET /finance/payments/gateway-transactions` — List transactions from the gateway - `POST /finance/payments/gateway-url` — Get the gateway dashboard URL for a payment - `POST /finance/payments/mark-paid` — Mark a payment as paid - `POST /finance/payments/refund` — Refund a payment - `POST /finance/payments/resend-receipt` — Resend a payment receipt - `POST /finance/payments/retry` — Retry a failed payment - `POST /finance/payments/verify` — Verify a payment - `POST /finance/payments/void` — Void an authorization ### Finance · Payouts - `POST /finance/batch/payouts` — Process payouts for several wallets - `GET /finance/payouts` — List payouts - `GET /finance/payouts/{payoutId}` — Get a payout - `POST /finance/payouts/{payoutId}/approve` — Approve a payout - `POST /finance/payouts/{payoutId}/cancel` — Cancel a payout - `POST /finance/payouts/{payoutId}/complete` — Complete a payout - `POST /finance/payouts/{payoutId}/fail` — Fail a payout - `POST /finance/payouts/{payoutId}/process` — Process a payout - `POST /finance/payouts/{payoutId}/refresh-status` — Refresh one payout from its rail - `GET /finance/payouts/number/lookup` — Get a payout by number - `POST /finance/payouts/run-schedule` — Run the payout schedule - `POST /finance/payouts/sweep` — Refresh every in-flight payout - `GET /finance/stats/payouts` — Get payout statistics - `GET /finance/wallets/{walletId}/payout-summary` — Get a wallet's payout summary - `POST /finance/wallets/{walletId}/request-payout` — Request a payout from a wallet ### Finance · Wallets - `GET /finance/stats/wallets` — Get wallet statistics - `GET /finance/wallets` — List wallets - `POST /finance/wallets` — Create a wallet - `GET /finance/wallets/{walletId}` — Get a wallet - `POST /finance/wallets/{walletId}/credit` — Credit a wallet - `POST /finance/wallets/{walletId}/debit` — Debit a wallet - `POST /finance/wallets/{walletId}/freeze` — Freeze a wallet - `POST /finance/wallets/{walletId}/hold` — Hold funds in a wallet - `PUT /finance/wallets/{walletId}/payout-settings` — Update payout settings - `POST /finance/wallets/{walletId}/release/{holdIndex}` — Release held funds - `POST /finance/wallets/{walletId}/unfreeze` — Unfreeze a wallet - `POST /finance/wallets/get-or-create` — Get or create a wallet - `GET /finance/wallets/owner/lookup` — Get a wallet by owner - `GET /finance/wallets/transactions/lookup` — Get a wallet with its transactions ### Forms Client - `GET /client/forms/{name}` — Open a form (customer) - `POST /client/forms/{name}/access` — Ask for a form link or code (customer) - `POST /client/forms/{name}/submit` — Submit a form (customer) ### Handling - `GET /handling/{datatype}/{id}` — Who is dealing with a record - `POST /handling/{datatype}/{id}/done` — Finish a record - `POST /handling/{datatype}/{id}/no-action` — Close a record — nothing needed - `POST /handling/{datatype}/{id}/release` — Give a record back - `POST /handling/{datatype}/{id}/take` — Take a record ### Kubernetes - `POST /k8/apply-service` — Apply a Kubernetes service - `GET /k8/check-status/{namespace}/{kind}/{resource}` — Check a resource's status - `POST /k8/cleanup-resources` — Clean up site resources - `DELETE /k8/delete-service/{namespace}/{kind}/{name}` — Delete a Kubernetes resource - `GET /k8/namespaces` — List namespaces - `DELETE /k8/namespaces/{name}` — Delete a namespace - `GET /k8/namespaces/{namespaceName}` — Get a namespace - `GET /k8/namespaces/{namespaceName}/pods` — List pods in a namespace - `POST /k8/scale-down` — Scale a deployment to zero - `POST /k8/scale-up` — Scale up a deployment ### Logistics - `GET /logistics/delivery/agents` — List delivery agents - `GET /logistics/delivery/agents/{agentId}` — Get a delivery agent - `PUT /logistics/delivery/agents/{agentId}/approve` — Approve an agent - `PUT /logistics/delivery/agents/{agentId}/availability` — Update an agent's availability - `GET /logistics/delivery/agents/{agentId}/available-jobs` — List jobs available to an agent - `PUT /logistics/delivery/agents/{agentId}/location` — Update an agent's location - `PUT /logistics/delivery/agents/{agentId}/recalculate-performance` — Recalculate an agent's performance - `PUT /logistics/delivery/agents/{agentId}/reject` — Reject an agent application - `PUT /logistics/delivery/agents/{agentId}/suspend` — Suspend an agent - `GET /logistics/delivery/agents/online` — List online agents - `GET /logistics/delivery/config` — Get the delivery configuration - `POST /logistics/delivery/geocode` — Geocode an address - `GET /logistics/delivery/jobs` — List delivery jobs - `POST /logistics/delivery/jobs` — Create a delivery job - `GET /logistics/delivery/jobs/{jobId}` — Get a delivery job - `PUT /logistics/delivery/jobs/{jobId}/accept` — Accept a job on an agent's behalf - `GET /logistics/delivery/jobs/{jobId}/adjustments` — Get job adjustments - `POST /logistics/delivery/jobs/{jobId}/adjustments` — Add a job adjustment - `PUT /logistics/delivery/jobs/{jobId}/adjustments/{adjustmentId}/remove` — Remove a job adjustment - `POST /logistics/delivery/jobs/{jobId}/alert-agents` — Alert agents about a job - `PUT /logistics/delivery/jobs/{jobId}/arrive-dropoff` — Arrive at dropoff - `PUT /logistics/delivery/jobs/{jobId}/arrive-pickup` — Arrive at pickup - `PUT /logistics/delivery/jobs/{jobId}/assign` — Assign a job to an agent - `PUT /logistics/delivery/jobs/{jobId}/broadcast` — Broadcast a job - `PUT /logistics/delivery/jobs/{jobId}/cancel` — Cancel a job - `PUT /logistics/delivery/jobs/{jobId}/complete` — Complete a job - `PUT /logistics/delivery/jobs/{jobId}/complete-dropoff` — Complete the dropoff - `PUT /logistics/delivery/jobs/{jobId}/complete-pickup` — Complete the pickup - `PUT /logistics/delivery/jobs/{jobId}/fail` — Mark a job failed - `GET /logistics/delivery/jobs/{jobId}/images` — Get job images - `POST /logistics/delivery/jobs/{jobId}/images` — Add job images - `GET /logistics/delivery/jobs/{jobId}/issues` — Get job issues - `POST /logistics/delivery/jobs/{jobId}/issues` — Report a job issue - `PUT /logistics/delivery/jobs/{jobId}/issues/{issueId}/escalate` — Escalate a job issue - `PUT /logistics/delivery/jobs/{jobId}/issues/{issueId}/resolve` — Resolve a job issue - `GET /logistics/delivery/jobs/{jobId}/messages` — Get job messages - `POST /logistics/delivery/jobs/{jobId}/messages` — Send a job message - `PUT /logistics/delivery/jobs/{jobId}/offer` — Offer a job to an agent - `GET /logistics/delivery/jobs/{jobId}/payment-status` — Get a job's payment status - `PUT /logistics/delivery/jobs/{jobId}/pricing` — Update a job's pricing - `POST /logistics/delivery/jobs/{jobId}/process-payment` — Process a job payment - `PUT /logistics/delivery/jobs/{jobId}/reject` — Reject a job on an agent's behalf - `PUT /logistics/delivery/jobs/{jobId}/start-dropoff` — Start the dropoff leg - `PUT /logistics/delivery/jobs/{jobId}/start-pickup` — Start the pickup leg - `PUT /logistics/delivery/jobs/{jobId}/tracking` — Update job live tracking - `POST /logistics/delivery/quote` — Get a delivery price quote - `POST /logistics/delivery/route-distance` — Calculate route distance - `GET /logistics/delivery/stats` — Get delivery statistics - `POST /logistics/delivery/validate-address` — Validate an address - `GET /logistics/delivery/zones` — List delivery zones - `GET /logistics/delivery/zones/{zoneName}` — Get a delivery zone - `GET /logistics/delivery/zones/lookup` — Find the zone for a location ### Logistics · Customer - `POST /client/logistics/jobs` — Create a delivery job - `GET /client/logistics/orders` — List my orders - `POST /client/logistics/orders` — Create a delivery order - `PUT /client/logistics/orders/{jobId}` — Update an order - `PUT /client/logistics/orders/{jobId}/cancel` — Cancel an order - `POST /client/logistics/orders/{jobId}/complete-payment` — Complete an order payment - `POST /client/logistics/orders/{jobId}/payment-intent` — Create a payment intent for an order - `POST /client/logistics/orders/{jobId}/rate` — Rate a delivery - `POST /client/logistics/orders/{jobId}/tip` — Tip a driver - `POST /client/logistics/orders/{jobId}/tip/complete` — Complete a tip payment - `GET /client/logistics/orders/{jobId}/track` — Track an order - `POST /client/logistics/paypal/capture` — Capture a PayPal order - `POST /client/logistics/paypal/create` — Create a PayPal order - `POST /client/logistics/quote` — Get a delivery quote - `POST /client/logistics/quote/validated` — Get a validated delivery quote - `GET /client/logistics/stripe/config` — Get the Stripe client configuration - `POST /client/logistics/stripe/intent` — Create a Stripe payment intent - `POST /client/logistics/stripe/verify` — Verify a Stripe payment ### Logistics · Driver - `PUT /client/logistics/availability` — Set my availability - `GET /client/logistics/init` — Get client init data - `GET /client/logistics/jobs` — List my jobs - `GET /client/logistics/jobs/{jobId}` — Get one of my jobs - `PUT /client/logistics/jobs/{jobId}/accept` — Accept a job - `PUT /client/logistics/jobs/{jobId}/arrive-dropoff` — Arrive at dropoff - `PUT /client/logistics/jobs/{jobId}/arrive-pickup` — Arrive at pickup - `PUT /client/logistics/jobs/{jobId}/complete` — Complete a job - `PUT /client/logistics/jobs/{jobId}/complete-dropoff` — Complete the dropoff - `PUT /client/logistics/jobs/{jobId}/complete-pickup` — Complete the pickup - `GET /client/logistics/jobs/{jobId}/contacts` — Get job contacts - `GET /client/logistics/jobs/{jobId}/images` — Get job images - `POST /client/logistics/jobs/{jobId}/images` — Add job images - `GET /client/logistics/jobs/{jobId}/issues` — Get job issues - `POST /client/logistics/jobs/{jobId}/issues` — Report a job issue - `GET /client/logistics/jobs/{jobId}/messages` — Get job messages - `POST /client/logistics/jobs/{jobId}/messages` — Send a job message - `PUT /client/logistics/jobs/{jobId}/messages/read` — Mark job messages read - `PUT /client/logistics/jobs/{jobId}/reject` — Reject a job - `PUT /client/logistics/jobs/{jobId}/start-dropoff` — Start the dropoff leg - `PUT /client/logistics/jobs/{jobId}/start-pickup` — Start the pickup leg - `PUT /client/logistics/jobs/{jobId}/tracking` — Update job tracking - `GET /client/logistics/jobs/available` — List jobs I can take - `PUT /client/logistics/location` — Update my location - `GET /client/logistics/me` — Get my agent profile - `GET /client/logistics/payments` — List my payments - `GET /client/logistics/payments/{jobId}` — Get a job's payment - `GET /client/logistics/payout-methods` — List my payout methods - `POST /client/logistics/payout-methods` — Add a payout method - `DELETE /client/logistics/payout-methods/{methodId}` — Remove a payout method - `PUT /client/logistics/payout-methods/{methodId}` — Update a payout method - `PUT /client/logistics/payout-methods/{methodId}/default` — Set the default payout method - `GET /client/logistics/payouts` — List my payouts - `POST /client/logistics/payouts/request` — Request a payout - `POST /client/logistics/register` — Register as a delivery driver - `POST /client/logistics/upload` — Upload a file ### Monitoring - `GET /monitoring/alert-notifications` — Monitor alerts and notifications - `GET /monitoring/alerts` — Get recent alerts - `GET /monitoring/company-creation` — Monitor company creation - `GET /monitoring/domain-mappings` — Monitor domain mappings - `GET /monitoring/health` — Get detailed health checks - `GET /monitoring/historical` — Get historical metrics - `GET /monitoring/overview` — Get the system overview - `GET /monitoring/queues` — Get queue statistics - `GET /monitoring/queues/{queueName}` — Get one queue's statistics - `GET /monitoring/system-metrics` — Get system resource metrics - `GET /monitoring/usage` — Monitor platform usage - `GET /monitoring/user-activity` — Get user activity metrics - `GET /monitoring/web-activity` — Monitor web activity ### Notes - `GET /notes/{datatype}/{id}` — List a record's notes - `POST /notes/{datatype}/{id}` — Add a note to a record ### Notices - `POST /notice/{id}/accept` — Accept a notice - `POST /notice/{id}/click` — Record a notice click - `POST /notice/{id}/dismiss` — Dismiss a notice - `POST /notice/{id}/display` — Record a notice display - `GET /notice/{id}/insights` — Get one notice's insights - `POST /notice/{id}/reject` — Reject a notice - `GET /notice/activity` — Get the notice activity log - `GET /notice/feed` — Get notices for this viewer - `GET /notice/inbox` — Get the notice inbox - `GET /notice/insights` — Get notice engagement ### Organization - `POST /org-management/account/cancel` — Cancel the account - `PUT /org-management/account/reactivate` — Reactivate an account (admin) - `POST /org-management/billing/add-credit` — Add credit to an organization - `GET /org-management/billing/balance` — Get the credit balance - `POST /org-management/billing/buy-credits` — Buy credits - `POST /org-management/billing/complete-payment` — Complete a credit payment - `POST /org-management/billing/gift-credits` — Gift credits (admin) - `GET /org-management/billing/transactions` — Get transaction history - `POST /org-management/billing/transactions/backfill-org-links` — Backfill transaction org links - `POST /org-management/business-made-register` — Register a Business Made organization - `GET /org-management/check-org-name/{orgName}` — Check organization name availability - `POST /org-management/company/meta` — Update company metadata - `GET /org-management/customers/{orgid}` — List an organization's customers - `GET /org-management/customers/{orgid}/{customerId}` — Get an organization customer - `POST /org-management/customers/{orgid}/change-password` — Change an organization customer's password - `POST /org-management/customers/{orgid}/create` — Create an organization customer - `POST /org-management/customers/{orgid}/delete` — Delete organization customers - `POST /org-management/customers/{orgid}/send-reset` — Send a password reset to an organization customer - `POST /org-management/customers/{orgid}/status` — Set organization customers' status - `POST /org-management/customers/{orgid}/update` — Update an organization customer - `POST /org-management/delete` — Delete an organization - `GET /org-management/init/{orgid}` — Check an org's initialization - `POST /org-management/init/{orgid}` — Initialize an org - `POST /org-management/org-register` — Register an organization - `GET /org-management/pre-approved-signups` — List pre-approved signups (admin) - `POST /org-management/pre-approved-signups` — Add a pre-approved signup (admin) - `POST /org-management/pre-approved-signups/remove` — Remove a pre-approved signup (admin) - `POST /org-management/pre-approved-signups/validate` — Validate a pre-approved signup - `GET /org-management/profile/{orgId}` — Get an organization profile - `GET /org-management/profile/addresses` — Get addresses - `POST /org-management/profile/addresses` — Add an address - `PUT /org-management/profile/customer` — Update the customer profile - `POST /org-management/profile/update` — Update the company profile - `GET /org-management/services/agreement/{serviceName}` — Get a service agreement - `POST /org-management/services/agreement/accept/{serviceName}` — Accept a service agreement - `POST /org-management/services/agreement/revoke/{serviceName}` — Revoke a service agreement - `GET /org-management/services/agreements` — Get service agreements - `GET /org-management/services/available` — Get available services - `POST /org-management/services/complete-payment` — Complete a service payment - `GET /org-management/services/pricing/{serviceName}` — Get service pricing - `POST /org-management/services/purchase` — Purchase a service - `GET /org-management/services/purchased` — Get purchased services - `GET /org-management/setup/catalog` — Get the setup wizard catalog - `POST /org-management/subscription/admin/update` — Update a customer plan (admin) - `POST /org-management/subscription/cancel` — Cancel a subscription - `POST /org-management/subscription/complete-checkout` — Complete a subscription checkout - `POST /org-management/subscription/complete-payment` — Complete a subscription payment - `POST /org-management/subscription/create` — Create a subscription - `GET /org-management/subscription/current` — Get the current subscription - `POST /org-management/subscription/downgrade` — Downgrade a subscription - `GET /org-management/subscription/plans` — Get subscription plans - `POST /org-management/subscription/upgrade` — Upgrade a subscription - `POST /org-management/transfer/assets` — Transfer assets between organizations - `POST /org-management/transfer/assets-bulk` — Bulk-transfer assets between organizations - `POST /org-management/transfer/change-email` — Change the primary email - `POST /org-management/transfer/ownership` — Transfer organization ownership - `GET /org-management/transfer/requests` — List transfer requests - `POST /org-management/transfer/requests` — Ask another org to accept a data transfer - `GET /org-management/transfer/requests/{id}` — Get one transfer request - `POST /org-management/transfer/requests/{id}/accept` — Accept a transfer request - `POST /org-management/transfer/requests/{id}/cancel` — Cancel a transfer request - `POST /org-management/transfer/requests/{id}/reject` — Reject a transfer request - `GET /org-management/transfer/requests/check-org/{targetOrgId}` — Check a target org before sending - `GET /org-management/users/{orgid}` — List an organization's users - `GET /org-management/users/{orgid}/{userId}` — Get an organization user - `POST /org-management/users/{orgid}/change-password` — Change an organization user's password - `POST /org-management/users/{orgid}/create` — Create an organization user - `POST /org-management/users/{orgid}/delete` — Delete organization users - `POST /org-management/users/{orgid}/send-reset` — Send a password reset to an organization user - `POST /org-management/users/{orgid}/status` — Set organization users' status - `POST /org-management/users/{orgid}/update` — Update an organization user ### Phone - `GET /phone/a2p/brand` — Get the A2P brand - `POST /phone/a2p/check` — Check an SMS registration before submitting - `GET /phone/a2p/draft` — The SMS registration, pre-filled - `POST /phone/a2p/site-pages` — Publish SMS terms and a privacy policy - `GET /phone/available` — Search available numbers - `POST /phone/calls/ai` — Make an AI phone call (call someone) - `POST /phone/migration/run` — Run the phone migration - `GET /phone/migration/status` — Get phone migration status - `GET /phone/numbers` — List phone numbers - `POST /phone/numbers` — Purchase a phone number - `DELETE /phone/numbers/{phoneId}` — Release a phone number - `GET /phone/numbers/{phoneId}` — Get a phone number - `PUT /phone/numbers/{phoneId}` — Update a phone number - `POST /phone/numbers/{phoneId}/routing` — Configure number routing - `GET /phone/numbers/{phoneId}/sms-requirements` — Get SMS requirements for a number - `POST /phone/numbers/add` — Add an existing number - `POST /phone/numbers/register-sms/{phoneId}` — Register a number for SMS - `GET /phone/numbers/sms-status/{phoneId}` — Get SMS registration status - `POST /phone/setup` — Set up phone - `DELETE /phone/sms-number` — Clear the default SMS number - `GET /phone/sms-number` — Get the default SMS number - `POST /phone/sms-number` — Set the default SMS number - `DELETE /phone/system` — Remove the system phone configuration - `GET /phone/system` — Get the system phone configuration - `POST /phone/system` — Update the system phone configuration - `POST /phone/token` — Get a phone access token - `GET /phone/user-phones` — Get user phone assignments - `GET /phone/verify` — Verify phone setup - `GET /phone/voice/app` — Get the voice application - `POST /phone/voice/app` — Update the voice application - `GET /phone/voice/devices` — List registered voice devices - `POST /phone/voice/heartbeat` — Send a device heartbeat - `POST /phone/voice/preview` — Preview a line in an AI voice - `POST /phone/voice/register-device` — Register a voice device - `POST /phone/voice/unregister-device` — Unregister a voice device - `GET /phone/voice/voices` — List available AI voices ### Platform - `GET /` — Hello world - `GET /health` — Health check - `GET /profile` — Get the caller's profile - `GET /readiness` — Readiness check - `GET /version` — Get the application version ### Print - `POST /print/{datatype}/{id}` — Render a record in a chosen format - `GET /print/{datatype}/{id}/pdf` — Render a record as PDF - `GET /print/{datatype}/{id}/thermal` — Render a record for a thermal printer - `GET /print/templates` — List printable datatypes and templates ### Repository - `POST /repository/aggregate/{datatype}` — Run an aggregation - `POST /repository/bulk-create` — Create many records - `GET /repository/category/{datatype}` — Get categories for a datatype - `PUT /repository/clone` — Clone a record - `GET /repository/collections/{name}/{subName}` — Get collection definitions - `POST /repository/collections/fix` — Repair collection definitions - `POST /repository/create` — Create a record - `PUT /repository/create` — Create a record - `PUT /repository/create-extended` — Create a record with extensions - `POST /repository/delete-query/{datatype}` — Delete every record a query matches - `POST /repository/delete/{datatype}` — Delete several records - `DELETE /repository/delete/{datatype}/{id}` — Delete a record - `POST /repository/export/{datatype}` — Export records - `GET /repository/find-any-id/{datatype}/{id}` — Get a record by any identifier - `GET /repository/find-by-attribute/{datatype}/{attribute}/{attrValue}` — Find records by attribute - `GET /repository/find-experts` — Find experts - `GET /repository/find-page-data/{datatype}/{dataId}` — Query records (alias) - `GET /repository/find-related/{datatype}/{anyId}` — Find related records - `GET /repository/find-timed-data/{startDate}/{endDate}` — Find records in a date range - `POST /repository/find/{datatype}` — Find records of any data type — look up a user (staff, colleague) by email or name and get their phone, or customers, orders, anything - `GET /repository/find/{datatype}/{dataId}` — Query records - `GET /repository/get/{datatype}/{attribute}/{value}` — Find records by attribute - `GET /repository/get/{datatype}/{id}` — Get a record by id - `GET /repository/isunique/{datatype}/{attribute}/{value}/{scopeValue}` — Check whether a value is unique - `GET /repository/link/{datatype}/{id}` — A studio link to a record - `POST /repository/lookup-code` — Resolve a scanned code - `GET /repository/preview/{orgId}/{site}/{page}` — Preview a page - `POST /repository/query/{datatype}` — Query records with a body (alias) - `GET /repository/search/{datatype}` — Search records - `POST /repository/search/{datatype}` — Search records with a body - `GET /repository/tag` — List tags - `POST /repository/tag` — Create a tag - `POST /repository/trash-restore` — Restore records from trash - `DELETE /repository/truncate/{datatype}` — Truncate a collection - `POST /repository/update-partial/{datatype}/{id}` — Partially update a record - `POST /repository/update/{id}` — Update a record ### Repository · Assets - `POST /repository/delete-asset/{datatype}` — Delete assets - `POST /repository/find-asset/{datatype}` — Find assets - `POST /repository/search-asset/{datatype}` — Search assets - `POST /repository/update-asset/{datatype}/{id}` — Update an asset ### Repository · Files - `POST /repository/customer/file/delete` — Delete a customer file - `POST /repository/customer/file/flatlist` — List customer files - `POST /repository/customer/file/upload` — Upload a customer file - `POST /repository/file` — Write a file - `POST /repository/file/append` — Append to a file - `POST /repository/file/buffer` — Get file contents as a buffer - `POST /repository/file/copy` — Copy a file - `POST /repository/file/create_favicon` — Create a favicon - `POST /repository/file/createfolder` — Create a folder - `POST /repository/file/delete` — Delete a file - `GET /repository/file/driver` — Get the storage driver - `POST /repository/file/exists` — Check whether a file exists - `POST /repository/file/flatlist` — List files - `GET /repository/file/flatlist/{prefix}/{pageNumber}` — List files (URL form) - `POST /repository/file/get_asset` — Get an asset file - `POST /repository/file/index` — Index files - `POST /repository/file/make-private` — Make a file private - `POST /repository/file/make-public` — Make a file public - `POST /repository/file/move` — Move a file - `POST /repository/file/prepend` — Prepend to a file - `POST /repository/file/signurl` — Get a signed URL for a file - `POST /repository/file/stat` — Get file metadata - `POST /repository/file/stream` — Stream a file - `POST /repository/file/thumbnails` — Generate thumbnails - `POST /repository/file/upload` — Upload a file - `POST /repository/file/upload-url` — Upload a file from a URL - `POST /repository/file/url` — Get a file URL ### Repository · History - `GET /repository/history/{datatype}/{id}` — Get a record's history - `POST /repository/history/{restore}` — Restore a record revision ### Repository · Media - `POST /repository/media/photos` — Search stock photos - `POST /repository/media/photos/curated` — Get curated stock photos - `POST /repository/media/videos` — Search stock videos - `POST /repository/media/videos/popular` — Get popular stock videos ### Repository · Migration - `POST /repository/migrate` — Migrate data between collections - `POST /repository/migrate/cancel/{jobId}` — Cancel a migration job - `GET /repository/migrate/jobs` — List migration jobs - `GET /repository/migrate/status/{jobId}` — Get migration job status ### Repository · Organizations - `GET /repository/org` — Query organizations - `GET /repository/org-by-hostname/{hostname}` — Get an organization by hostname - `GET /repository/org/{orgid}` — Get an organization - `POST /repository/org/create` — Create an organization - `DELETE /repository/org/delete/{orgid}` — Delete an organization - `POST /repository/org/query/{datatype}` — Query data across organizations - `POST /repository/org/update/{orgid}` — Update an organization - `GET /repository/org/user/{email}` — Get a user's organizations - `DELETE /repository/org/user/{email}:/{orgid}` — Remove a user from an organization ### Repository · Settings - `DELETE /repository/setting/{settingType}/{settingName}/{subName}` — Delete an org setting - `GET /repository/setting/{settingType}/{settingName}/{subName}` — Get an org setting - `POST /repository/setting/{settingType}/{settingName}/{subName}` — Set an org setting ### Repository · Workflow - `POST /repository/approve/{datatype}/{id}` — Approve a record - `POST /repository/publish/{datatype}/{id}` — Publish a record - `POST /repository/reject/{id}` — Reject a record - `GET /repository/request-approval/{datatype}/{id}` — Request approval for a record - `POST /repository/unpublish/{datatype}/{id}` — Unpublish a record ### Sales channels - `GET /sales-channel/analytics/compare` — Compare channels - `GET /sales-channel/analytics/dashboard` — Get the channel dashboard - `GET /sales-channel/analytics/metrics` — Get sales metrics - `POST /sales-channel/analytics/metrics/{channelId}` — Record sales metrics - `POST /sales-channel/analytics/metrics/sync/{channelId}` — Sync sales metrics from a channel - `GET /sales-channel/analytics/products` — Get product performance - `POST /sales-channel/analytics/products/{sku}/{channelId}` — Record product performance - `GET /sales-channel/analytics/summary` — Get an analytics summary - `GET /sales-channel/channels` — List supported channels - `POST /sales-channel/channels/{channelId}/disable` — Disable a channel - `POST /sales-channel/channels/{channelId}/enable` — Enable a channel - `POST /sales-channel/channels/{channelId}/execute` — Execute a channel operation - `GET /sales-channel/channels/{channelId}/status` — Get one channel's status - `POST /sales-channel/channels/bulk-execute` — Execute an operation on many channels - `GET /sales-channel/channels/configured` — List configured channels - `GET /sales-channel/channels/status` — Get all channel statuses - `GET /sales-channel/inventory/{sku}` — Get master inventory for a SKU - `PUT /sales-channel/inventory/{sku}` — Update master inventory - `GET /sales-channel/inventory/{sku}/channels` — Get a SKU's stock across channels - `GET /sales-channel/inventory/alerts/low-stock` — List low-stock items - `PUT /sales-channel/inventory/bulk/update` — Bulk-update master inventory - `POST /sales-channel/inventory/pull/{channelId}` — Pull inventory from a channel - `POST /sales-channel/inventory/reservation/{reservationId}/commit` — Commit a reservation - `POST /sales-channel/inventory/reservation/{reservationId}/release` — Release a reservation - `POST /sales-channel/inventory/reserve` — Reserve inventory for an order - `POST /sales-channel/inventory/sync` — Push inventory to all channels - `POST /sales-channel/inventory/sync/{channelId}` — Push inventory to one channel - `POST /sales-channel/mappings/apply-template/{templateId}` — Apply a template to a product - `GET /sales-channel/mappings/attributes` — List attribute mappings - `POST /sales-channel/mappings/attributes` — Save an attribute mapping - `DELETE /sales-channel/mappings/attributes/{mappingId}` — Delete an attribute mapping - `GET /sales-channel/mappings/attributes/{sourceAttribute}` — Get an attribute mapping - `GET /sales-channel/mappings/categories` — List category mappings - `POST /sales-channel/mappings/categories` — Save a category mapping - `DELETE /sales-channel/mappings/categories/{mappingId}` — Delete a category mapping - `GET /sales-channel/mappings/categories/{sourceCategory}` — Get a category mapping - `GET /sales-channel/mappings/categories/{sourceCategory}/channel/{channelId}` — Resolve a category for a channel - `GET /sales-channel/mappings/templates` — List channel templates - `POST /sales-channel/mappings/templates` — Save a channel template - `DELETE /sales-channel/mappings/templates/{templateId}` — Delete a channel template - `GET /sales-channel/mappings/templates/{templateId}` — Get a channel template - `POST /sales-channel/mappings/transform/{channelId}` — Transform a product for a channel - `POST /sales-channel/mappings/validate/{channelId}` — Validate a product for a channel - `GET /sales-channel/mappings/validate/{channelId}/bulk` — Validate the whole catalogue for a channel - `POST /sales-channel/optimization/analyze/{channelId}` — Analyse a listing - `POST /sales-channel/optimization/analyze/{channelId}/bulk` — Analyse the whole catalogue - `GET /sales-channel/optimization/scores` — List listing scores - `GET /sales-channel/optimization/suggestions` — List optimisation suggestions - `PUT /sales-channel/optimization/suggestions/{suggestionId}/apply` — Apply an optimisation suggestion - `GET /sales-channel/optimization/summary` — Get an optimisation summary - `GET /sales-channel/orders` — List aggregated orders - `GET /sales-channel/orders/{orderId}` — Get an aggregated order - `PUT /sales-channel/orders/{orderId}/status` — Update an order's status - `GET /sales-channel/orders/stats/summary` — Get order statistics - `POST /sales-channel/orders/sync` — Pull orders from all channels - `POST /sales-channel/orders/sync/{channelId}` — Pull orders from a channel - `POST /sales-channel/pricing/calculate/{channelId}` — Calculate a channel price - `POST /sales-channel/pricing/calculate/all` — Calculate prices for every channel - `GET /sales-channel/pricing/compare/{sku}` — Compare a SKU's prices - `POST /sales-channel/pricing/competitor` — Record a competitor price - `GET /sales-channel/pricing/competitor/{sku}` — Get competitor prices for a SKU - `GET /sales-channel/pricing/history/{sku}` — Get price history for a SKU - `GET /sales-channel/pricing/rules` — List pricing rules - `POST /sales-channel/pricing/rules` — Save a pricing rule - `DELETE /sales-channel/pricing/rules/{ruleId}` — Delete a pricing rule - `GET /sales-channel/pricing/rules/{ruleId}` — Get a pricing rule - `POST /sales-channel/pricing/sync/{channelId}` — Push prices to a channel - `GET /sales-channel/sync/history` — Get sync history ### Shipping - `GET /shipping/{id}` — Get a shipping record - `POST /shipping/address-autocomplete` — Autocomplete an address - `POST /shipping/calculate` — Calculate cart shipping cost - `POST /shipping/cancel` — Cancel a shipment - `POST /shipping/create` — Create a shipping label - `POST /shipping/estimated-delivery` — Get estimated delivery times - `GET /shipping/google-keys` — Get the Google Maps key for this org - `POST /shipping/label` — Get a shipping label - `GET /shipping/label/{shippingId}/{format}` — Get a shipping label by id - `GET /shipping/list` — List shipping records - `GET /shipping/locations/available` — Get available ship-from locations - `GET /shipping/methods` — Get shipping methods - `POST /shipping/options` — Shipping options for a cart and destination - `POST /shipping/order/create` — Create a shipment for an order - `POST /shipping/order/manual` — Add manual shipping info to an order - `POST /shipping/order/rates` — Get shipping rates for an order - `POST /shipping/order/ship` — Create shipment for order - `GET /shipping/order/shipments/{orderNumber}` — Get shipments for an order - `GET /shipping/order/status/{orderNumber}` — Get shipping status for an order - `GET /shipping/place-details/{placeId}` — Get address details for a place - `POST /shipping/product-cost` — Get shipping cost for one product - `POST /shipping/rates` — Get shipping rates - `POST /shipping/refresh-tracking` — Refresh tracking and apply any change - `GET /shipping/track/{trackingNumber}` — Track a shipment - `GET /shipping/tracking-webhook` — Read saved automatic tracking setup without contacting the provider - `POST /shipping/tracking-webhook` — Register the tracking webhook - `POST /shipping/update-address` — Update a delivery address - `POST /shipping/verify-address` — Verify a shipping address ### Shipping · Admin - `POST /shipping/admin/calculate-packing` — Preview how items would be packed - `GET /shipping/admin/configs` — List shipping configurations - `POST /shipping/admin/configs` — Create a shipping configuration - `GET /shipping/admin/configs/{name}` — Get a shipping configuration - `POST /shipping/admin/configs/{name}` — Update a shipping configuration - `POST /shipping/admin/configs/delete/{name}` — Delete a shipping configuration - `POST /shipping/admin/configs/set-default/{name}` — Set the default shipping configuration - `GET /shipping/admin/integrations` — Get configured shipping integrations - `POST /shipping/admin/preview-rate` — Preview a rate calculation - `POST /shipping/admin/product/shipping` — Update shipping settings for a product - `POST /shipping/admin/products/shipping` — Bulk update product shipping settings - `GET /shipping/admin/providers` — List supported shipping providers - `GET /shipping/admin/stats` — Get shipping statistics ### Site - `POST /site/{site}/features/{feature}/link` — Link a site feature from the footer or menu - `POST /site/add` — Add a site - `GET /site/app/dsl/{name}` — Get an app DSL - `POST /site/apply-template` — Apply a template to a site - `POST /site/attach-domain` — Attach a domain to a site - `GET /site/base-url` — Get the org's public site URL - `POST /site/change-site-domain-names` — Rename site domains in bulk - `POST /site/clone-site` — Clone a site - `GET /site/company/{domainName}` — Get the public company profile for a domain - `POST /site/create` — Create a site with plan validation (legacy) - `POST /site/create-site` — Create a site - `DELETE /site/delete-site/{siteOrgId}/{siteId}` — Delete a site - `POST /site/fix-domains` — Rebuild a site's domain mappings - `GET /site/get-org/{domainName}` — Resolve a domain to an organization - `GET /site/get-site-by-hostname/{hostname}` — Get a site by hostname - `GET /site/get-site-host-mappings/{siteName}` — Get a site's host mappings - `GET /site/get-site/{configSiteName}/{domainName}` — Get site information - `POST /site/make-site-template` — Register a site as a template - `GET /site/org-sites/{siteOrgId}` — List an organization's sites - `GET /site/page-data/{datatype}/{dataId}` — Get page data - `GET /site/page/{hostName}/{siteName}` — Render a site page - `GET /site/page/{hostName}/{siteName}/*` — Render a site page by path - `POST /site/page/{hostName}/{siteName}/*` — Render a site page with a body - `GET /site/plan-limits` — Get organization plan limits - `POST /site/remove` — Remove a site - `POST /site/remove-domain/{domain}` — Remove a site domain - `POST /site/site-map` — Create a site map - `DELETE /site/unregister-site-domain/{siteId}/{domainName}` — Unregister a site domain - `POST /site/update-domain/{domain}` — Update a site domain - `GET /site/usage-stats` — Get organization usage statistics ### Site · Dev environments - `DELETE /dev-env/{envName}` — Delete a development environment - `GET /dev-env/{envName}/logs` — Get container logs - `POST /dev-env/{envName}/rebuild` — Rebuild a container - `POST /dev-env/{envName}/restart` — Restart a container - `POST /dev-env/{envName}/start` — Start a container - `GET /dev-env/{envName}/status` — Get container status - `POST /dev-env/{envName}/stop` — Stop a container - `POST /dev-env/attach-domain/{envName}` — Attach a custom domain to an environment - `POST /dev-env/convert/{siteName}` — Convert a site to a development environment - `POST /dev-env/create` — Create a development environment - `POST /dev-env/detach-domain/{envName}` — Detach a custom domain from an environment - `POST /dev-env/enable-hosting/{envName}` — Enable hosting for an environment - `GET /dev-env/get-spinforge/{devEnvName}` — Get SpinForge details for an environment - `GET /dev-env/get/{envName}` — Get a development environment - `POST /dev-env/send-session-invitation` — Send a session invitation ### Staff directory - `GET /staff-directory` — Everyone who works here - `GET /staff-directory/{ref}` — One colleague ### Staff portal - `GET /staff-portal/approvals` — Requests waiting on me - `POST /staff-portal/approvals/{id}/{decision}` — Decide a request - `GET /staff-portal/availability` — My availability - `PUT /staff-portal/availability` — Set my availability - `GET /staff-portal/dashboard` — Get my dashboard - `GET /staff-portal/deductions` — Get my deductions - `POST /staff-portal/direct-deposit` — Add a direct deposit account - `DELETE /staff-portal/direct-deposit/{accountId}` — Remove a direct deposit account - `GET /staff-portal/landing` — Where do I belong - `GET /staff-portal/onboarding` — My onboarding - `GET /staff-portal/pay-method` — Get my pay method - `PUT /staff-portal/pay-method` — Set my pay method - `GET /staff-portal/payslips` — List my payslips - `GET /staff-portal/payslips/{stubId}` — Get a payslip - `GET /staff-portal/payslips/{stubId}/pdf` — Download a payslip PDF - `GET /staff-portal/payslips/year/{year}/summary` — Get a year-to-date summary - `GET /staff-portal/profile` — Get my profile - `PUT /staff-portal/profile` — Update my profile - `GET /staff-portal/schedule` — Get my schedule - `POST /staff-portal/schedule/{scheduleId}/shifts/{shiftId}/{action}` — Act on a shift as me - `GET /staff-portal/schedule/colleagues` — Who could swap with me - `GET /staff-portal/schedule/off` — Days I am off - `GET /staff-portal/schedule/takeable` — Shifts I could take - `GET /staff-portal/schedule/upcoming` — Get my upcoming shifts - `GET /staff-portal/tasks` — My own journey tasks - `GET /staff-portal/tax-info` — Get my tax information - `PUT /staff-portal/tax-info` — Update my tax information - `GET /staff-portal/time-off` — My time off - `POST /staff-portal/time-off` — Request time off - `POST /staff-portal/time-off/{id}/cancel` — Cancel my request - `POST /staff-portal/time-off/{id}/edit` — Edit my request - `POST /staff-portal/time-off/{id}/resubmit` — Send my request again - `GET /staff-portal/time-off/cost` — What a date range would cost me - `GET /staff-portal/time-off/team` — Who at my site is off - `GET /staff-portal/timesheets` — List my timesheets - `POST /staff-portal/timesheets/{timesheetId}/entries` — Add a time entry - `POST /staff-portal/timesheets/{timesheetId}/submit` — Submit a timesheet - `POST /staff-portal/timesheets/clock-in` — Clock in - `GET /staff-portal/timesheets/clock-in/active` — Get my active clock-in - `POST /staff-portal/timesheets/clock-out` — Clock out - `GET /staff-portal/timesheets/current` — Get my current timesheet - `GET /staff-portal/w2/{year}` — Get my W-2 - `GET /staff-portal/w2/{year}/pdf` — Download my W-2 PDF ### Staff Portal · Forms - `GET /staff-portal/forms` — All my government forms - `GET /staff-portal/forms/{formKey}` — My government form - `PUT /staff-portal/forms/{formKey}` — Save or sign my form ### Staff Portal · Training - `GET /staff-portal/training` — My training - `POST /staff-portal/training/{requirementId}/acknowledge` — Acknowledge a policy - `POST /staff-portal/training/{requirementId}/complete` — Complete a course - `POST /staff-portal/training/{requirementId}/start` — Start a course - `GET /staff-portal/training/at-clock-in` — Training required at clock-in - `GET /staff-portal/training/courses` — My courses - `POST /staff-portal/training/courses/launch` — Start / resume a course - `POST /staff-portal/training/qr-session` — Start a training session (QR / kiosk) - `GET /staff-portal/training/session` — My training (session) - `POST /staff-portal/training/session/{requirementId}/acknowledge` — Acknowledge a policy (session) - `POST /staff-portal/training/session/{requirementId}/complete` — Complete a course (session) - `POST /staff-portal/training/session/{requirementId}/start` — Start a course (session) - `GET /staff-portal/training/session/at-clock-in` — At-clock-in (session) - `POST /staff-portal/training/session/courses/launch` — Start / resume a course (session) - `POST /staff-portal/training/session/end` — End the training session ### Stats - `GET /stats/{datatype}/{id}` — Get a record's stats - `POST /stats/{datatype}/{id}/bookmark` — Bookmark a record - `POST /stats/{datatype}/{id}/dislike` — Dislike a record - `POST /stats/{datatype}/{id}/favorite` — Favorite a record - `POST /stats/{datatype}/{id}/follow` — Follow a record - `POST /stats/{datatype}/{id}/like` — Like a record - `POST /stats/{datatype}/{id}/rating` — Rate a record - `POST /stats/{datatype}/{id}/reaction` — React to a record - `POST /stats/{datatype}/{id}/share` — Record a share - `POST /stats/{datatype}/{id}/view` — Record a view - `GET /stats/by-customer/{datatype}/{id}` — Get stats by customer - `GET /stats/by-resource/{datatype}/{id}` — Get stats by resource ### Storefront - `GET /storefront/attributes/{attribute}` — List storefront filter attributes - `GET /storefront/brands/{brand}` — List brands - `GET /storefront/categories` — Get the storefront category tree - `POST /storefront/categories` — Add a storefront category - `GET /storefront/collections/{collection}` — List collections - `GET /storefront/data/{siteId}` — Get everything a storefront landing page needs - `GET /storefront/pos-categories` — Get POS quick-pick categories - `GET /storefront/product/{id}` — Get a product - `GET /storefront/product/{id}/related` — Get related products **(deprecated)** - `GET /storefront/products` — List and search products ### Storefront · Cart - `GET /storefront/cart/clear/{cartid}` — Clear a cart - `GET /storefront/cart/get/{authorid}/{cartid}` — Get a cart - `POST /storefront/cart/update/{cartid}` — Update a cart ### Storefront · Checkout - `GET /storefront/cart/mine` — Restore my saved cart - `POST /storefront/checkout-buy-now` — Buy now, without a cart - `POST /storefront/checkout-cart` — Check out a cart - `POST /storefront/checkout-mixed` — Check out a basket of products and rentals ### Storefront · Discounts - `GET /storefront/discounts` — List discounts - `POST /storefront/discounts` — Create a discount - `DELETE /storefront/discounts/{identifier}` — Delete a discount - `GET /storefront/discounts/{identifier}` — Get a discount - `PUT /storefront/discounts/{identifier}` — Update a discount - `PUT /storefront/discounts/{identifier}/activate` — Activate a discount - `PUT /storefront/discounts/{identifier}/deactivate` — Deactivate a discount - `POST /storefront/discounts/{identifier}/reverse` — Reverse a discount redemption - `POST /storefront/discounts/{identifier}/usage` — Record a discount redemption - `POST /storefront/discounts/apply` — Apply a coupon and price the cart - `POST /storefront/discounts/automatic` — Get automatic discounts for a cart - `POST /storefront/discounts/calculate` — Calculate a cart with all discounts - `GET /storefront/discounts/promotions/active` — List active promotions for display - `GET /storefront/discounts/stats` — Get discount statistics - `POST /storefront/discounts/validate` — Validate a discount code ### Storefront · Gift cards - `GET /client/giftcards/balance` — Look a card up by its code (shopper) - `GET /client/giftcards/me` — My gift cards - `POST /client/giftcards/me/{serial}/share` — Send part of my card to someone - `POST /client/giftcards/redeem` — Spend a card at checkout (shopper) - `GET /client/giftcards/wallet/apple` — Apple Wallet pass for my card - `GET /client/giftcards/wallet/google` — Google Wallet link for my card - `GET /client/giftcards/wallet/status` — Which wallet passes this store can issue - `GET /storefront/giftcards` — List gift cards - `POST /storefront/giftcards` — Create a gift card - `GET /storefront/giftcards/{serial}` — Get a gift card - `PUT /storefront/giftcards/{serial}/activate` — Activate a gift card - `POST /storefront/giftcards/{serial}/adjust` — Adjust a gift card balance - `PUT /storefront/giftcards/{serial}/cancel` — Cancel a gift card - `POST /storefront/giftcards/{serial}/owner` — Set the holder of a card - `PUT /storefront/giftcards/{serial}/reactivate` — Reactivate a suspended gift card - `POST /storefront/giftcards/{serial}/refund` — Refund value onto a gift card - `POST /storefront/giftcards/{serial}/reissue` — Reissue a card - `POST /storefront/giftcards/{serial}/resend` — Resend a gift card email - `POST /storefront/giftcards/{serial}/send` — Send a gift card - `PUT /storefront/giftcards/{serial}/suspend` — Suspend a gift card - `POST /storefront/giftcards/{serial}/template` — Set the message template a card is sent with - `GET /storefront/giftcards/{serial}/timeline` — A card's timeline - `GET /storefront/giftcards/activity` — Gift card activity - `GET /storefront/giftcards/balance` — Check a gift card balance - `POST /storefront/giftcards/batch` — Create a batch of gift cards - `GET /storefront/giftcards/batches` — List gift card batches - `POST /storefront/giftcards/batches/{batch}/{action}` — Block, unblock or cancel a whole batch - `GET /storefront/giftcards/batches/{batch}/cards` — Cards in a batch - `POST /storefront/giftcards/batches/{batch}/details` — Rename a batch or add a note - `POST /storefront/giftcards/expire-due` — Expire due cards - `POST /storefront/giftcards/import` — Issue cards from a list - `GET /storefront/giftcards/insights` — Gift card insights - `POST /storefront/giftcards/link-owners` — Link cards to customers - `GET /storefront/giftcards/policy` — Get the gift card expiry policy - `POST /storefront/giftcards/policy` — Set the gift card expiry policy - `GET /storefront/giftcards/reconciliation` — Reconcile gift cards with the books - `POST /storefront/giftcards/redeem` — Redeem a gift card - `GET /storefront/giftcards/stats` — Gift card statistics - `POST /storefront/giftcards/transfer` — Transfer balance between gift cards - `GET /storefront/giftcards/unusual` — Unusual gift card redemptions - `GET /storefront/giftcards/verify/{transactionId}` — Verify a redemption reference - `GET /storefront/giftcards/wallet/apple` — Apple Wallet pass for a card - `GET /storefront/giftcards/wallet/google` — Google Wallet link for a card - `GET /storefront/giftcards/wallet/status` — Which wallet passes this store can issue ### Storefront · Inventory - `POST /storefront/inventory` — Set inventory for a SKU at a location - `POST /storefront/inventory/adjust` — Adjust inventory - `GET /storefront/inventory/alerts/low-stock` — Get low stock alerts - `POST /storefront/inventory/count` — Record a physical count - `POST /storefront/inventory/fulfill` — Fulfill inventory after shipment - `GET /storefront/inventory/location/{locationId}` — List inventory at a location - `POST /storefront/inventory/release` — Release a reservation - `POST /storefront/inventory/reserve` — Reserve inventory for an order - `POST /storefront/inventory/return` — Return stock from a return - `GET /storefront/inventory/sku/{sku}` — Get inventory for a SKU across locations - `GET /storefront/inventory/sku/{sku}/location/{locationId}` — Get inventory for a SKU at one location - `GET /storefront/inventory/sku/{sku}/transactions` — Get transaction history for a SKU - `GET /storefront/inventory/stats` — Get inventory statistics - `GET /storefront/inventory/transfers` — List inventory transfers - `POST /storefront/inventory/transfers` — Create an inventory transfer - `GET /storefront/inventory/transfers/{transferId}` — Get an inventory transfer - `PUT /storefront/inventory/transfers/{transferId}/cancel` — Cancel an inventory transfer - `PUT /storefront/inventory/transfers/{transferId}/receive` — Receive an inventory transfer - `PUT /storefront/inventory/transfers/{transferId}/ship` — Ship an inventory transfer ### Storefront · Invoices - `GET /storefront/invoices` — List invoices - `GET /storefront/invoices/{id}` — Get an invoice - `POST /storefront/invoices/{id}/accept` — Accept a quote on the customer's behalf - `GET /storefront/invoices/{id}/amount-due` — Get the amount still due - `POST /storefront/invoices/{id}/cancel` — Cancel an invoice - `POST /storefront/invoices/{id}/create-order` — Create an order from an invoice - `POST /storefront/invoices/{id}/decline` — Record that the customer declined a quote - `POST /storefront/invoices/{id}/duplicate` — Duplicate an invoice - `POST /storefront/invoices/{id}/mark-overdue` — Mark an invoice as overdue - `POST /storefront/invoices/{id}/mark-paid` — Mark an invoice as paid - `GET /storefront/invoices/{id}/payment-link` — Get the customer payment link for an invoice - `POST /storefront/invoices/{id}/refund` — Refund an invoice - `POST /storefront/invoices/{id}/reminder` — Send a payment reminder - `POST /storefront/invoices/{id}/reopen` — Reopen an invoice - `POST /storefront/invoices/{id}/send` — Send an invoice - `GET /storefront/invoices/dashboard/metrics` — Get invoice dashboard metrics - `GET /storefront/invoices/pay/{id}` — Get an invoice for the payment page - `POST /storefront/invoices/pay/{id}` — Record a payment from the payment page - `POST /storefront/invoices/pay/{id}/accept` — Accept a quote from the payment page - `POST /storefront/invoices/pay/{id}/decline` — Decline a quote from the payment page - `POST /storefront/invoices/save` — Create or update an invoice ### Storefront · Orders - `POST /storefront/order/cancel/{orderNumber}` — Cancel an order - `POST /storefront/order/complete/{orderNumber}` — Complete an order - `POST /storefront/order/deliver/{orderNumber}` — Mark an order as delivered - `GET /storefront/order/email/{email}/{orderNumber}` — Look up an order by email - `GET /storefront/order/get/{author}/{orderNumber}` — Get a customer's order - `POST /storefront/order/hold/{orderNumber}` — Put an order on hold - `POST /storefront/order/process/{orderNumber}` — Mark an order as being fulfilled - `POST /storefront/order/refund/{orderNumber}` — Refund an order - `POST /storefront/order/release/{orderNumber}` — Release an order from hold - `GET /storefront/order/remove/{author}/{orderNumber}` — Remove an order - `GET /storefront/order/send-welcome/{orderNumber}` — Send the order confirmation email - `POST /storefront/order/set-status/{orderNumber}` — Set an order status directly - `POST /storefront/order/ship/{orderNumber}` — Ship an order - `POST /storefront/order/update/{orderNumber}` — Update order details - `GET /storefront/orders/get/{author}` — List a customer's orders ### Storefront · Payments - `GET /storefront/payment-gateways` — List available payment gateways - `POST /storefront/payments/charge-link` — Create a standalone charge and its payment link - `POST /storefront/payments/charge-link/{id}/send` — Send a charge's payment link - `GET /storefront/payments/charge-link/{id}/status` — Has a charge been paid - `GET /storefront/paypal/config` — Get the PayPal configuration - `POST /storefront/stripe/capture` — Capture an authorized PaymentIntent - `POST /storefront/stripe/checkout-session` — Create a Stripe Checkout session - `POST /storefront/stripe/intent` — Create a Stripe PaymentIntent - `POST /storefront/stripe/terminal/connection-token` — Get a Stripe Terminal connection token - `POST /storefront/stripe/terminal/intent` — Create a card-present PaymentIntent - `POST /storefront/stripe/terminal/location/ensure` — Find or create a Stripe Terminal location - `POST /storefront/take-payment` — Take a payment - `GET /storefront/verify-payment/{provider}/{configId}/{paymentId}` — Verify a payment with the provider ### Storefront · POS - `GET /storefront/order/{id}` — Get an order with tasks enriched - `POST /storefront/order/{id}/fire` — Fire order items to a workflow - `POST /storefront/order/{id}/items` — Add items to an order - `GET /storefront/order/{id}/payments` — List payments and balance for an order - `GET /storefront/pos/readiness` — May the signed-in operator use the POS? - `POST /storefront/pos/tab` — Open a POS tab - `POST /storefront/pos/tab/{id}/assign-service-point` — Assign a service point to a tab - `GET /storefront/pos/tab/{id}/breakdown` — Get the money breakdown of a POS tab - `GET /storefront/pos/tab/{id}/check-payload` — Get check print primitives - `POST /storefront/pos/tab/{id}/close` — Close a paid POS tab - `POST /storefront/pos/tab/{id}/print-check` — Print a pre-payment check - `POST /storefront/pos/tab/{id}/print-receipt` — Print or reprint a receipt - `GET /storefront/pos/tab/{id}/receipt-payload` — Get receipt print primitives - `POST /storefront/pos/tab/{id}/refund` — Refund a payment on a POS tab - `POST /storefront/pos/tab/{id}/release-service-point` — Release a tab's service point - `POST /storefront/pos/tab/{id}/retry-accounting` — Retry the journal for a settled POS tab - `POST /storefront/pos/tab/{id}/retry-stock` — Retry the stock deduction for a settled POS tab - `POST /storefront/pos/tab/{id}/send-receipt` — Email or SMS a receipt - `POST /storefront/pos/tab/{id}/settle` — Settle a POS tab - `POST /storefront/pos/tab/{id}/split` — Split a POS tab - `GET /storefront/pos/tabs` — List open POS tabs - `GET /storefront/pos/tabs/closed` — List closed POS tabs - `POST /storefront/service-point/{id}/status` — Set a service point status ### Storefront · Pricing - `POST /storefront/pricing/calculate` — Calculate a product price - `POST /storefront/pricing/calculate-cart` — Calculate cart prices - `GET /storefront/pricing/customer-price-lists` — Get the calling customer's price lists - `POST /storefront/pricing/preview-as-customer` — Preview a price as another customer - `GET /storefront/pricing/price-lists` — List price lists - `POST /storefront/pricing/price-lists` — Create a price list - `DELETE /storefront/pricing/price-lists/{name}` — Delete a price list - `GET /storefront/pricing/price-lists/{name}` — Get a price list - `PUT /storefront/pricing/price-lists/{name}` — Update a price list - `GET /storefront/pricing/product/{sku}` — Get pricing variations for a product ### Storefront · Rentals - `GET /storefront/rental` — List rentals - `POST /storefront/rental` — Create a rental booking - `GET /storefront/rental/{rentalId}` — Get a rental - `PUT /storefront/rental/{rentalId}/active` — Mark a rental active - `PUT /storefront/rental/{rentalId}/cancel` — Cancel a rental - `PUT /storefront/rental/{rentalId}/checkin` — Record check-in condition - `PUT /storefront/rental/{rentalId}/checkout` — Record check-out condition - `PUT /storefront/rental/{rentalId}/complete` — Complete a rental - `PUT /storefront/rental/{rentalId}/confirm` — Confirm a rental - `PUT /storefront/rental/{rentalId}/delivered` — Mark a rental delivered - `POST /storefront/rental/{rentalId}/deposit/deduction` — Deduct from the deposit - `PUT /storefront/rental/{rentalId}/deposit/hold` — Record a deposit hold - `PUT /storefront/rental/{rentalId}/deposit/refund` — Refund the deposit - `PUT /storefront/rental/{rentalId}/dropped-off` — Mark a rental dropped off - `PUT /storefront/rental/{rentalId}/notes` — Update internal notes - `PUT /storefront/rental/{rentalId}/overdue` — Mark a rental overdue - `POST /storefront/rental/{rentalId}/payment` — Record a rental payment - `PUT /storefront/rental/{rentalId}/picked-up` — Mark a rental picked up - `PUT /storefront/rental/{rentalId}/ready` — Mark a rental ready - `PUT /storefront/rental/{rentalId}/returned` — Mark a rental returned **(deprecated)** - `GET /storefront/rental/config` — Get rental configuration - `GET /storefront/rental/items` — List rental items - `GET /storefront/rental/items/{sku}` — Get a rental item - `GET /storefront/rental/items/{sku}/availability` — Check rental availability - `POST /storefront/rental/items/{sku}/price` — Calculate a rental price - `POST /storefront/rental/items/{sku}/validate-restrictions` — Validate customer restrictions - `GET /storefront/rental/status/due-today` — Get rentals due today - `GET /storefront/rental/status/overdue` — Get overdue rentals ### Storefront · Returns - `GET /storefront/returns` — List returns - `PUT /storefront/returns/{rmaNumber}/approve` — Approve a return request - `PUT /storefront/returns/{rmaNumber}/cancel` — Cancel a return (operator) - `PUT /storefront/returns/{rmaNumber}/complete` — Complete a return and refund - `PUT /storefront/returns/{rmaNumber}/inspect` — Record inspection results - `POST /storefront/returns/{rmaNumber}/notes` — Add a note to a return - `PUT /storefront/returns/{rmaNumber}/receive` — Mark a return as received - `PUT /storefront/returns/{rmaNumber}/reject` — Reject a return request - `GET /storefront/returns/my-returns` — Get the calling customer's returns - `GET /storefront/returns/order/{orderNumber}` — Get returns for an order - `POST /storefront/returns/request` — Create a return request - `GET /storefront/returns/rma/{rmaNumber}` — Get a return by RMA number - `PUT /storefront/returns/rma/{rmaNumber}/cancel` — Cancel a return (customer) - `PUT /storefront/returns/rma/{rmaNumber}/ship` — Mark a return as shipped - `GET /storefront/returns/stats` — Get return statistics ### Storefront · Social - `POST /storefront/sync/post-to-social` — Post products to social media - `POST /storefront/sync/preview-social-post` — Preview a social post - `GET /storefront/sync/social-targets/{platform}` — List social post targets ### Storefront · Subscriptions - `POST /storefront/stripe/subscription-session` — Create a Stripe subscription session - `GET /storefront/subscriptions/get/{author}/{subscriptionid}` — Get a customer's subscriptions - `POST /storefront/update-subscription` — Update a subscription ### Storefront · Sync - `DELETE /storefront/sync/{partner}/{productId}` — Remove a product from a partner - `POST /storefront/sync/{partner}/{productId}` — Sync one product to a partner - `POST /storefront/sync/add-products` — Sync several products to a partner - `POST /storefront/sync/all/{productId}` — Sync one product to every partner - `POST /storefront/sync/delete-products` — Remove several products from a partner - `GET /storefront/sync/partners` — List shopping partners - `GET /storefront/sync/products` — List products across all partners - `GET /storefront/sync/products/{partner}` — List products at one partner ### Storefront · Tax - `POST /storefront/tax/apply-exemption` — Apply a tax exemption to a customer - `POST /storefront/tax/calculate` — Calculate tax for a cart - `POST /storefront/tax/check-exempt` — Check tax exemption status - `POST /storefront/tax/product` — Calculate tax for one product - `POST /storefront/tax/rate` — Get the tax rate stack for an address - `GET /storefront/tax/rates/resolve` — Check which tax rates apply to an address - `POST /storefront/tax/remove-exemption` — Remove a tax exemption from a customer ### Storefront · Workflows - `POST /storefront/workflows/order-management` — Create an order management workflow - `GET /storefront/workflows/order-management/{name}` — Get the order management workflow ### Stowbo · Browse - `GET /client/stowbo/chat-config` — Get the support chat settings - `POST /client/stowbo/checkout/suggestions` — Get mid-booking suggestions - `GET /client/stowbo/listings` — Search places - `GET /client/stowbo/listings/{listingId}` — Get a place - `GET /client/stowbo/listings/{listingId}/availability` — Check availability for a window - `GET /client/stowbo/listings/{listingId}/calendar` — Get a place's availability calendar - `GET /client/stowbo/listings/{listingId}/more-from-host` — Get other places by the same host - `GET /client/stowbo/listings/{listingId}/nearby` — Find similar places nearby - `GET /client/stowbo/pay/{ref}` — Get what a payment link is for - `POST /client/stowbo/pay/{ref}` — Pay what a payment reference owes - `GET /client/stowbo/pickup/{token}` — Get a pickup pass - `GET /client/stowbo/pickup/{token}/receipt` — Get the receipt for a collected pickup ### Stowbo · Calendar - `GET /stowbo/availability` — Check how many of a space are free - `GET /stowbo/listing/{listing}/addons` — List the add-ons a space offers - `GET /stowbo/listing/{listing}/blackouts` — List the days a space is closed - `POST /stowbo/listing/{listing}/blackouts` — Close a space for servicing - `DELETE /stowbo/listing/{listing}/blackouts/{blackoutId}` — Reopen a space - `GET /stowbo/listing/{listing}/calendar` — Get the occupancy calendar for a space - `POST /stowbo/listing/{listing}/capacity` — Cap a space's capacity for a window ### Stowbo · Custody - `GET /stowbo/custody` — List what is in custody right now - `POST /stowbo/items/{itemId}/assign` — Assign an item to a unit - `POST /stowbo/items/{itemId}/checkin` — Check an item in - `GET /stowbo/items/{itemId}/checkout` — Get what an item owes before check-out - `POST /stowbo/items/{itemId}/checkout` — Check an item out - `POST /stowbo/items/{itemId}/movement` — Record an item going in or out - `GET /stowbo/listing/{listing}/occupancy-now` — See what is in a space right now - `GET /stowbo/overdue` — List what is past its window and still here ### Stowbo · Discounts - `GET /stowbo/discounts` — List discounts - `POST /stowbo/discounts` — Create a platform discount - `GET /stowbo/discounts/{id}` — Get one discount - `PUT /stowbo/discounts/{id}` — Edit a discount - `POST /stowbo/discounts/{id}/{action}` — Switch a discount on or off ### Stowbo · Fees - `GET /stowbo/platform-fees` — Get the platform fee list - `POST /stowbo/platform-fees` — Replace the platform fee list ### Stowbo · Guest - `GET /client/stowbo/bookings` — List my bookings - `POST /client/stowbo/bookings` — Book directly - `GET /client/stowbo/bookings/{bookingId}` — Get one of my bookings - `POST /client/stowbo/bookings/{bookingId}/addons` — Add an add-on to a booking - `PUT /client/stowbo/bookings/{bookingId}/cancel` — Cancel a booking - `GET /client/stowbo/bookings/{bookingId}/delegations` — List the hand-offs on my booking - `POST /client/stowbo/bookings/{bookingId}/delegations` — Hand my pickup to someone else - `GET /client/stowbo/bookings/{bookingId}/due` — Get what I owe or get back - `POST /client/stowbo/bookings/{bookingId}/extend` — Extend a stay - `GET /client/stowbo/bookings/{bookingId}/host` — Get my booking's host - `POST /client/stowbo/bookings/{bookingId}/request` — Ask the host to act - `POST /client/stowbo/bookings/{bookingId}/settle-payment` — Settle an outstanding balance - `GET /client/stowbo/bookings/{bookingId}/timeline` — Get my booking's timeline - `DELETE /client/stowbo/checkout/{checkoutId}` — Abandon checkout - `POST /client/stowbo/checkout/{checkoutId}/confirm` — Pay and confirm - `PUT /client/stowbo/checkout/{checkoutId}/progress` — Record checkout progress - `POST /client/stowbo/checkout/cart` — Save the cart - `POST /client/stowbo/checkout/hold` — Start checkout and hold the capacity - `POST /client/stowbo/checkout/quote` — Price a cart - `GET /client/stowbo/checkout/resume` — Resume an unfinished purchase - `DELETE /client/stowbo/delegations/{id}` — Cancel a hand-off - `POST /client/stowbo/delegations/{id}/resend` — Re-send a pickup pass - `POST /client/stowbo/host/apply` — Apply to list space - `GET /client/stowbo/host/me` — Get my host application - `GET /client/stowbo/init` — Get app launch data - `POST /client/stowbo/items/{itemId}/movement` — Record my own movement (self-serve) - `DELETE /client/stowbo/items/{itemId}/request` — Cancel my open request - `POST /client/stowbo/items/{itemId}/request` — Request a retrieval or return (attended) - `GET /client/stowbo/my-items` — List everything I have booked - `GET /client/stowbo/my-pickups` — List passes addressed to me - `GET /client/stowbo/my-stuff` — List what I have stored right now - `POST /client/stowbo/park` — Start a parking session - `GET /client/stowbo/park/{itemId}` — Get my running parking session - `POST /client/stowbo/park/{itemId}/stop` — Stop my parking session ### Stowbo · Host - `GET /client/stowbo/host/addons` — List my add-ons - `POST /client/stowbo/host/addons` — Create an add-on - `DELETE /client/stowbo/host/addons/{addonId}` — Retire an add-on - `PUT /client/stowbo/host/addons/{addonId}` — Update an add-on - `GET /client/stowbo/host/bookings` — List every booking at my places - `POST /client/stowbo/host/bookings` — Create a booking for a customer - `GET /client/stowbo/host/bookings/{bookingId}` — Get an order at my place - `POST /client/stowbo/host/bookings/{bookingId}/cancel` — Cancel an order - `POST /client/stowbo/host/bookings/{bookingId}/charge` — Add a charge to the bill - `GET /client/stowbo/host/bookings/{bookingId}/customer` — Get an order's guest - `GET /client/stowbo/host/bookings/{bookingId}/delegations` — List the hand-offs on a booking I host - `GET /client/stowbo/host/bookings/{bookingId}/due` — Get what a booking owes right now - `POST /client/stowbo/host/bookings/{bookingId}/hold` — Hold a payout - `GET /client/stowbo/host/bookings/{bookingId}/items` — Get an order's items - `POST /client/stowbo/host/bookings/{bookingId}/lines/{index}/reverse` — Undo a bill line - `POST /client/stowbo/host/bookings/{bookingId}/refund` — Credit the bill - `POST /client/stowbo/host/bookings/{bookingId}/release` — Release a held payout - `POST /client/stowbo/host/bookings/{bookingId}/requests/{requestId}` — Respond to a guest request - `POST /client/stowbo/host/bookings/{bookingId}/settle` — Settle an order and pay out - `GET /client/stowbo/host/bookings/{bookingId}/timeline` — Get an order's timeline - `GET /client/stowbo/host/discounts` — List my coupons - `POST /client/stowbo/host/discounts` — Create a coupon - `DELETE /client/stowbo/host/discounts/{id}` — Retire a coupon - `PUT /client/stowbo/host/discounts/{id}` — Edit a coupon - `GET /client/stowbo/host/discounts/{id}/stats` — Get a coupon's usage - `GET /client/stowbo/host/earnings` — Get my earnings - `PUT /client/stowbo/host/fees/{feeId}` — Edit one of my fees - `GET /client/stowbo/host/handover` — Resolve a scanned pickup code - `POST /client/stowbo/host/handover` — Hand items over - `GET /client/stowbo/host/handovers` — List hand-offs at my places - `POST /client/stowbo/host/items/{itemId}/assign` — Assign or move an item - `POST /client/stowbo/host/items/{itemId}/checkin` — Check in an item - `GET /client/stowbo/host/items/{itemId}/checkout` — Preview a check-out - `POST /client/stowbo/host/items/{itemId}/checkout` — Check out an item - `POST /client/stowbo/host/items/{itemId}/movement` — Record a movement - `POST /client/stowbo/host/items/{itemId}/refuse` — Refuse a pickup - `POST /client/stowbo/host/items/{itemId}/request` — Advance a guest request - `GET /client/stowbo/host/listings` — List my listings - `POST /client/stowbo/host/listings` — Create a listing - `DELETE /client/stowbo/host/listings/{id}` — Delete a listing - `GET /client/stowbo/host/listings/{id}` — Get one of my listings - `PUT /client/stowbo/host/listings/{id}` — Edit a listing - `GET /client/stowbo/host/listings/{id}/blackouts` — Get a listing's blackouts - `POST /client/stowbo/host/listings/{id}/blackouts` — Close days on a listing - `DELETE /client/stowbo/host/listings/{id}/blackouts/{blackoutId}` — Re-open blacked-out days - `GET /client/stowbo/host/listings/{id}/bookings` — Get a listing's bookings - `GET /client/stowbo/host/listings/{id}/calendar` — Get a listing's occupancy calendar - `GET /client/stowbo/host/listings/{id}/occupancy-now` — Get current occupancy - `PUT /client/stowbo/host/listings/{id}/status` — Publish, pause or unlist a listing - `PUT /client/stowbo/host/listings/{listingId}/addons` — Set a listing's add-ons - `GET /client/stowbo/host/listings/{listingId}/fees` — List the fees on my listing - `POST /client/stowbo/host/listings/{listingId}/fees` — Create a fee on my listing - `PUT /client/stowbo/host/listings/{listingId}/fees` — Set the fees on my listing - `DELETE /client/stowbo/host/listings/{listingId}/fees/{feeId}` — Detach a fee from my listing - `POST /client/stowbo/host/payment-request` — Create a self-serve payment request - `GET /client/stowbo/host/payment-request/{requestId}` — Get a payment request's status - `POST /client/stowbo/host/payment-request/{requestId}/cancel` — Void a payment request - `POST /client/stowbo/host/payment-request/{requestId}/complete` — Mark a payment request paid - `GET /client/stowbo/host/payout-methods` — List my payout destinations - `POST /client/stowbo/host/payout-methods` — Add a payout destination - `DELETE /client/stowbo/host/payout-methods/{methodId}` — Remove a payout destination - `PUT /client/stowbo/host/payout-methods/{methodId}/default` — Make a payout destination the default - `GET /client/stowbo/host/payouts` — List my payouts - `POST /client/stowbo/host/payouts` — Request a payout - `GET /client/stowbo/host/resolve` — Find a booking by any identifier - `POST /client/stowbo/host/take-payment` — Record an in-person card payment - `GET /client/stowbo/host/today` — Get today at my place - `GET /client/stowbo/host/transactions` — List my transactions - `POST /client/stowbo/host/transactions/{ref}/receipt` — Resend a receipt - `POST /client/stowbo/host/transactions/{ref}/refund` — Refund a payment I collected - `GET /client/stowbo/host/units` — List my units - `POST /client/stowbo/host/units` — Add units to a listing - `PUT /client/stowbo/host/units/{id}` — Edit a unit - `GET /client/stowbo/host/wallet` — Get my wallet ### Stowbo · Ledger - `GET /stowbo/ledger` — List every Stowbo transaction - `GET /stowbo/transactions/{ref}` — Get one transaction - `POST /stowbo/transactions/{ref}/receipt` — Resend a receipt - `POST /stowbo/transactions/{ref}/refund` — Refund a transaction - `POST /stowbo/transactions/{requestId}/cancel` — Void a payment request ### Stowbo · Money - `GET /stowbo/booking/{bookingId}/adjustments` — Get the bill, line by line - `POST /stowbo/booking/{bookingId}/adjustments` — Put a line on the bill - `PUT /stowbo/booking/{bookingId}/adjustments/{index}/reverse` — Undo a line on the bill - `POST /stowbo/booking/{bookingId}/cancel` — Cancel a booking - `POST /stowbo/booking/{bookingId}/charge` — Charge the guest now - `POST /stowbo/booking/{bookingId}/hold` — Hold the money on a booking - `POST /stowbo/booking/{bookingId}/payment-request` — Send a payment link for a booking - `POST /stowbo/booking/{bookingId}/refund` — Refund a booking - `POST /stowbo/booking/{bookingId}/release-hold` — Release a payment hold - `POST /stowbo/booking/{bookingId}/settle` — Settle a booking - `POST /stowbo/booking/{bookingId}/take-payment` — Record a payment taken on a booking ### Stowbo · Oversight - `GET /stowbo/activity` — List every booking timeline, merged - `GET /stowbo/addons` — Get the add-on catalogue - `GET /stowbo/audience` — Resolve a message audience - `GET /stowbo/bookings` — List bookings - `GET /stowbo/calendar` — Get the platform calendar - `GET /stowbo/customer/{id}` — Get one customer - `GET /stowbo/funnel` — Get the booking funnel - `GET /stowbo/hosts` — Get the host scorecard - `GET /stowbo/items` — List every item on the platform - `GET /stowbo/money` — See where the money is - `GET /stowbo/pulse` — Get the platform right now - `GET /stowbo/search` — Search everything ### Stowbo · Pickups - `POST /stowbo/booking/{bookingId}/handovers` — Hand a pickup to someone else - `GET /stowbo/handovers` — List delegated pickups - `GET /stowbo/handovers/{id}` — Get one hand-off - `POST /stowbo/handovers/{id}/resend` — Re-send a pickup pass - `POST /stowbo/handovers/{id}/revoke` — Revoke a hand-off ### Stowbo · Setup - `GET /stowbo/platform-config` — Get the platform money config - `POST /stowbo/platform-config` — Change the platform money config - `POST /stowbo/setup` — Set Stowbo up - `GET /stowbo/setup/status` — Check what is set up - `GET /stowbo/site` — Get the Stowbo site ### Stowbo · Stay - `POST /stowbo/booking` — Book on a customer's behalf - `POST /stowbo/booking/{bookingId}/access` — Record an access - `POST /stowbo/booking/{bookingId}/addon` — Add an add-on to a running booking - `POST /stowbo/booking/{bookingId}/extend` — Extend a stay - `POST /stowbo/booking/{bookingId}/move-unit` — Move stored things to another unit - `POST /stowbo/booking/{bookingId}/request` — Raise a request for a customer - `POST /stowbo/booking/{bookingId}/requests/{requestId}` — Answer a customer request - `GET /stowbo/booking/{bookingId}/timeline` — Get everything that happened to a booking ### Sync - `GET /sync` — Get sync information - `GET /sync/info` — Get organization sync info - `GET /sync/pause/{name}` — Pause a sync job - `GET /sync/platforms` — List platforms and sync types - `GET /sync/purge` — Purge sync data - `POST /sync/queue` — Queue a sync job - `GET /sync/resume/{name}` — Resume a sync job - `GET /sync/status` — Get sync job status - `GET /sync/status/{platform}` — Get one platform's sync status - `POST /sync/trigger` — Trigger a sync - `POST /sync/trigger/{platform}/{syncType}` — Trigger a sync by URL ### Sync · Queues - `POST /queue-manager/action/{queueName}` — Perform a queue action - `GET /queue-manager/debug/delayed-jobs` — List delayed jobs (debug) - `GET /queue-manager/details/{queueName}` — Get queue details - `GET /queue-manager/list-queues` — List queues - `GET /queue-manager/list-stats` — Get queue statistics - `GET /queue-manager/org-schedules` — List the org's schedules - `GET /queue-manager/org-schedules/{queueName}` — List the org's schedules on a queue - `POST /queue-manager/queue/{queueName}` — Queue a job - `GET /queue-manager/schedule-runs/{scheduleId}` — List schedule runs - `GET /queue-manager/schedule-stats/{scheduleId}` — Get schedule statistics - `POST /queue-manager/schedule/{queueName}` — Create a schedule - `POST /queue-manager/schedule/oneoff/{queueName}` — Create a one-off schedule - `POST /queue-manager/schedule/pause/{queueName}` — Pause a schedule - `POST /queue-manager/schedule/resume/{queueName}` — Resume a schedule - `GET /queue-manager/schedules/{queueName}` — List a queue's schedules - `GET /queue-manager/sync-ticks` — List sync ticks - `POST /queue-manager/sync-ticks/remove` — Remove sync ticks ### Tools - `POST /tools/create-page-image/{siteName}/{pageName}` — Generate a page image - `POST /tools/create-site-favicon/{siteName}` — Generate a site favicon - `GET /tools/default-templates` — List default templates - `GET /tools/default-templates/{name}` — Get a default template - `POST /tools/domain/buy` — Buy a domain - `POST /tools/domain/cloudflare/dns/import` — Import DNS records into Cloudflare - `GET /tools/domain/cloudflare/ssl/{domain}` — Get Cloudflare SSL settings - `POST /tools/domain/cloudflare/ssl/{domain}` — Update Cloudflare SSL settings - `POST /tools/domain/cloudflare/transfer` — Transfer a domain to Cloudflare - `GET /tools/domain/cloudflare/transfer/{domain}` — Get Cloudflare transfer status - `GET /tools/domain/cloudflare/zone/{domain}` — Get a Cloudflare zone - `GET /tools/domain/cloudflare/zone/{domain}/activation` — Check Cloudflare zone activation - `GET /tools/domain/cloudflare/zone/{domain}/nameservers` — Get Cloudflare nameservers - `POST /tools/domain/cloudflare/zone/{domain}/nameservers` — Update Cloudflare nameservers - `POST /tools/domain/cloudflare/zone/create` — Create a Cloudflare zone - `GET /tools/domain/dns/{domainName}/{type}` — Get DNS records - `POST /tools/domain/dns/add` — Add a DNS record - `POST /tools/domain/dns/delete` — Delete a DNS record - `POST /tools/domain/dns/modify` — Modify a DNS record - `GET /tools/domain/list/{domainName}/{orderId}` — List domains or get an order - `POST /tools/domain/manage` — Manage a domain - `GET /tools/domain/search/{domainName}/{tld}` — Search for a domain - `POST /tools/domain/search/advanced` — Search domains across TLDs - `GET /tools/email-templates` — List default email templates - `GET /tools/email-templates/{name}` — Get a default email template - `POST /tools/fake-generate` — Generate fake data - `POST /tools/index-site/{siteName}` — Index a site - `POST /tools/presentation/publish` — Publish an HTML presentation - `POST /tools/presentation/to-pdf` — Convert a page to PDF - `POST /tools/presentation/to-pptx` — Convert a page to PowerPoint - `POST /tools/presentation/unpublish` — Unpublish a hosted presentation - `POST /tools/remove-background` — Remove an image background by URL - `POST /tools/remove-background-file` — Remove an image background from an upload - `POST /tools/tailwind-css/{siteName}/{pageName}` — Generate Tailwind CSS for a page - `POST /tools/tailwind-map/{siteName}/{pageName}` — Generate a Tailwind class map for a page - `POST /tools/web-activity` — Record web activity - `POST /tools/web-visit-direct` — Record a direct web visit - `POST /tools/web-visit-indirect` — Record a page view from the browser ### Upstream - `GET /upstream/active/{type}` — List active integrations - `GET /upstream/active/detail/{id}` — Get an active integration - `GET /upstream/call/{integration}/{operation}` — Call an integration operation (GET) - `POST /upstream/call/{integration}/{operation}` — Call an integration operation - `GET /upstream/get-config/{type}/{configId}` — Get an integration configuration - `POST /upstream/get-integration` — Get an integration by id - `GET /upstream/integration-types/{type}` — Get integration types - `GET /upstream/integration-use-cases/{useCase}` — Get integrations for a use case - `POST /upstream/save-integration` — Save an integration - `GET /upstream/service/{serviceName}/{operation}` — Call a service operation (GET) - `POST /upstream/service/{serviceName}/{operation}` — Call a service operation - `POST /upstream/shutdown/{id}` — Shut down an integration - `POST /upstream/test/{integration}/{operation}` — Test an integration operation ### Usage - `GET /usage/{orgId}/current/{type}` — Get an organization's usage counts - `POST /usage/ai/charge` — Charge AI usage - `GET /usage/ai/models` — List AI models and pricing - `GET /usage/ai/provider-key` — Get an AI provider key and balance - `GET /usage/balance` — Get the organization balance - `GET /usage/endpoints` — List tokenized endpoints - `POST /usage/endpoints` — Set an endpoint cost - `DELETE /usage/endpoints/{endpoint}` — Remove an endpoint from tokenization - `POST /usage/gift` — Gift credit to another organization - `GET /usage/history/{type}` — Get usage history - `GET /usage/shared` — Get shared services used by this org - `GET /usage/statement` — Get the organization statement - `GET /usage/stats` — Get usage records ### Usage · Platform admin - `GET /usage/admin/credits` — List every organization’s credit - `GET /usage/admin/service-usage` — Get service usage across the platform - `GET /usage/admin/service-usage/orgs/{orgId}` — Get one organization’s service usage - `GET /usage/admin/service-usage/orgs/{orgId}/charges` — List one organization’s charges ### Usage · Service pricing - `POST /service-pricing` — Create service pricing - `DELETE /service-pricing/{name}` — Delete service pricing - `PUT /service-pricing/{name}` — Update service pricing - `GET /service-pricing/{service}` — Get service pricing - `GET /service-pricing/active` — Get active services - `DELETE /service-pricing/all` — Delete all service pricing - `GET /service-pricing/catalog` — Get the services catalog - `GET /service-pricing/check-balance/{service}` — Check the balance for a service - `POST /service-pricing/initialize` — Initialize default service pricing - `GET /service-pricing/list` — List service pricing ### Users - `POST /profile/refresh` — Refresh token - `POST /user/refresh` — Refresh token ### Users · Administration - `POST /profile/app/key` — Get an application key - `POST /profile/app/register` — Register an application - `POST /profile/blacklist/add` — Add to the blacklist - `POST /profile/blacklist/apikey/add` — Blacklist an API key - `DELETE /profile/blacklist/apikey/delete/{apiKey}` — Unblacklist an API key - `DELETE /profile/blacklist/delete/{value}` — Remove from the blacklist - `GET /profile/blacklist/get` — Get the blacklist - `POST /profile/group/add` — Add a user to a group - `POST /profile/group/remove` — Remove a user from a group - `POST /profile/role/add` — Grant a role - `POST /profile/role/remove` — Revoke a role - `GET /profile/system-orgs` — List system organizations - `POST /profile/user/{userId}/meta` — Update another user's metadata - `POST /profile/user/directory/backfill` — Rebuild the account directory - `GET /profile/user/employee/{employeeId}/user-candidates` — Get user candidates for an employee - `GET /profile/user/employee/candidates/{userId}` — Get employee candidates for a user - `POST /profile/user/employee/create-from-employee` — Create a user from an employee - `POST /profile/user/employee/create-from-user` — Create an employee from a user - `POST /profile/user/employee/link` — Link a user to an employee - `POST /profile/user/group/add` — Add a user to a group - `POST /profile/user/group/remove` — Remove a user from a group - `POST /profile/user/invite/resend/{invitationId}` — Resend an invitation - `POST /profile/user/invite/send` — Send an invitation - `POST /profile/user/lockout` — Switch a user's access off or on - `POST /profile/user/role/add` — Grant a role - `POST /profile/user/role/remove` — Revoke a role - `POST /profile/user/two-factor/reset` — Clear an account's second factor - `GET /profile/user/two-factor/status/{userType}/{userId}` — Read another account's second-factor state - `POST /user/app/key` — Get an application key - `POST /user/app/register` — Register an application - `POST /user/blacklist/add` — Add to the blacklist - `POST /user/blacklist/apikey/add` — Blacklist an API key - `DELETE /user/blacklist/apikey/delete/{apiKey}` — Unblacklist an API key - `DELETE /user/blacklist/delete/{value}` — Remove from the blacklist - `GET /user/blacklist/get` — Get the blacklist - `POST /user/group/add` — Add a user to a group - `POST /user/group/remove` — Remove a user from a group - `POST /user/role/add` — Grant a role - `POST /user/role/remove` — Revoke a role - `GET /user/system-orgs` — List system organizations - `POST /user/user/{userId}/meta` — Update another user's metadata - `POST /user/user/directory/backfill` — Rebuild the account directory - `GET /user/user/employee/{employeeId}/user-candidates` — Get user candidates for an employee - `GET /user/user/employee/candidates/{userId}` — Get employee candidates for a user - `POST /user/user/employee/create-from-employee` — Create a user from an employee - `POST /user/user/employee/create-from-user` — Create an employee from a user - `POST /user/user/employee/link` — Link a user to an employee - `POST /user/user/group/add` — Add a user to a group - `POST /user/user/group/remove` — Remove a user from a group - `POST /user/user/invite/resend/{invitationId}` — Resend an invitation - `POST /user/user/invite/send` — Send an invitation - `POST /user/user/lockout` — Switch a user's access off or on - `POST /user/user/role/add` — Grant a role - `POST /user/user/role/remove` — Revoke a role - `POST /user/user/two-factor/reset` — Clear an account's second factor - `GET /user/user/two-factor/status/{userType}/{userId}` — Read another account's second-factor state ### Users · API keys - `DELETE /api-key/{keyId}` — Delete an API key - `GET /api-key/{keyId}` — Get an API key - `PUT /api-key/{keyId}` — Update an API key - `GET /api-key/admin/list` — List all API keys (admin) - `POST /api-key/admin/revoke/{keyId}` — Revoke an API key (admin) - `POST /api-key/auth` — Authenticate with an API key - `POST /api-key/create` — Create an API key - `GET /api-key/list` — List my API keys - `GET /api-key/org/{orgid}` — List an organization's API keys - `POST /api-key/org/{orgid}/create` — Create an API key for an organization - `POST /api-key/org/{orgid}/delete` — Delete an organization API key - `POST /api-key/regenerate/{keyId}` — Regenerate an API key - `GET /api-key/usage/{keyId}` — Get API key usage ### Users · Authentication - `GET /profile/auth/success` — Authentication success callback - `GET /profile/code/{email}` — Request a login code - `GET /profile/facebook` — Start Facebook sign-in - `GET /profile/facebook/redirect` — Facebook sign-in callback - `POST /profile/facebook/token` — Exchange a Facebook token - `GET /profile/facebook/url` — Get the Facebook auth URL - `GET /profile/github` — Start GitHub sign-in - `GET /profile/github/redirect` — GitHub sign-in callback - `POST /profile/github/redirect` — GitHub sign-in callback (POST) - `POST /profile/github/token` — Exchange a GitHub token - `GET /profile/github/url` — Get the GitHub auth URL - `POST /profile/global-login` — Global login - `GET /profile/google` — Start Google sign-in - `GET /profile/google/redirect` — Google sign-in callback - `POST /profile/guest/auth` — Authenticate as a guest - `GET /profile/logout/{userId}` — Log a user out - `GET /profile/magic-link` — Sign in with a magic link - `POST /profile/magic-link/redirect` — Redirect after a magic link - `GET /profile/passcode/card/{identifier}` — Get card information - `POST /profile/passcode/card/register` — Register a passcode card - `POST /profile/passcode/card/status` — Set a card status - `GET /profile/passcode/cards/{employeeId}` — List an employee's cards - `POST /profile/passcode/remove` — Remove a passcode - `POST /profile/passcode/set` — Set a passcode - `POST /profile/password/change` — Change a password - `GET /profile/password/forgot/{email}` — Request a password reset - `POST /profile/password/reset` — Reset a password - `POST /profile/password/validate-token` — Validate a reset token - `POST /profile/session-access` — Get a session access token - `POST /profile/signin` — Sign in - `POST /profile/signin/passcode` — Sign in with a passcode - `POST /profile/signout` — Sign out - `POST /profile/signup` — Sign up - `POST /profile/user/directory/lookup` — Find the orgs an email belongs to - `POST /profile/user/invite/complete` — Complete an invitation - `POST /profile/user/invite/validate` — Validate an invitation - `GET /profile/user/logout/{userId}` — Log a user out - `GET /profile/user/magic-link` — Sign in with a magic link (user) - `POST /profile/user/magic-link/redirect` — Redirect after a user magic link - `GET /profile/user/passcode/card/{identifier}` — Get card information - `POST /profile/user/passcode/card/register` — Register a passcode card - `POST /profile/user/passcode/card/status` — Set a card status - `GET /profile/user/passcode/cards/{employeeId}` — List an employee's cards - `POST /profile/user/passcode/remove` — Remove a passcode - `POST /profile/user/passcode/set` — Set a passcode - `POST /profile/user/password-policy/assign` — Assign a password policy - `GET /profile/user/password-policy/assignments` — Password policies and who they apply to - `POST /profile/user/password/change` — Change a password - `GET /profile/user/password/forgot/{email}` — Request a password reset - `POST /profile/user/password/reset` — Reset a password - `POST /profile/user/password/validate-token` — Validate a reset token - `POST /profile/user/refresh` — Refresh an access token - `GET /profile/user/shared-site-auth/{token}` — Authenticate via a shared-site token - `POST /profile/user/signin` — Sign in - `POST /profile/user/signin/passcode` — Sign in with a passcode - `POST /profile/user/signup` — Sign up - `POST /profile/validate-app-key` — Validate an application key - `GET /user/auth/success` — Authentication success callback - `GET /user/code/{email}` — Request a login code - `GET /user/facebook` — Start Facebook sign-in - `GET /user/facebook/redirect` — Facebook sign-in callback - `POST /user/facebook/token` — Exchange a Facebook token - `GET /user/facebook/url` — Get the Facebook auth URL - `GET /user/github` — Start GitHub sign-in - `GET /user/github/redirect` — GitHub sign-in callback - `POST /user/github/redirect` — GitHub sign-in callback (POST) - `POST /user/github/token` — Exchange a GitHub token - `GET /user/github/url` — Get the GitHub auth URL - `POST /user/global-login` — Global login - `GET /user/google` — Start Google sign-in - `GET /user/google/redirect` — Google sign-in callback - `POST /user/guest/auth` — Authenticate as a guest - `GET /user/logout/{userId}` — Log a user out - `GET /user/magic-link` — Sign in with a magic link - `POST /user/magic-link/redirect` — Redirect after a magic link - `GET /user/passcode/card/{identifier}` — Get card information - `POST /user/passcode/card/register` — Register a passcode card - `POST /user/passcode/card/status` — Set a card status - `GET /user/passcode/cards/{employeeId}` — List an employee's cards - `POST /user/passcode/remove` — Remove a passcode - `POST /user/passcode/set` — Set a passcode - `POST /user/password/change` — Change a password - `GET /user/password/forgot/{email}` — Request a password reset - `POST /user/password/reset` — Reset a password - `POST /user/password/validate-token` — Validate a reset token - `POST /user/session-access` — Get a session access token - `POST /user/signin` — Sign in - `POST /user/signin/passcode` — Sign in with a passcode - `POST /user/signout` — Sign out - `POST /user/signup` — Sign up - `POST /user/user/directory/lookup` — Find the orgs an email belongs to - `POST /user/user/invite/complete` — Complete an invitation - `POST /user/user/invite/validate` — Validate an invitation - `GET /user/user/logout/{userId}` — Log a user out - `GET /user/user/magic-link` — Sign in with a magic link (user) - `POST /user/user/magic-link/redirect` — Redirect after a user magic link - `GET /user/user/passcode/card/{identifier}` — Get card information - `POST /user/user/passcode/card/register` — Register a passcode card - `POST /user/user/passcode/card/status` — Set a card status - `GET /user/user/passcode/cards/{employeeId}` — List an employee's cards - `POST /user/user/passcode/remove` — Remove a passcode - `POST /user/user/passcode/set` — Set a passcode - `POST /user/user/password-policy/assign` — Assign a password policy - `GET /user/user/password-policy/assignments` — Password policies and who they apply to - `POST /user/user/password/change` — Change a password - `GET /user/user/password/forgot/{email}` — Request a password reset - `POST /user/user/password/reset` — Reset a password - `POST /user/user/password/validate-token` — Validate a reset token - `POST /user/user/refresh` — Refresh an access token - `GET /user/user/shared-site-auth/{token}` — Authenticate via a shared-site token - `POST /user/user/signin` — Sign in - `POST /user/user/signin/passcode` — Sign in with a passcode - `POST /user/user/signup` — Sign up - `POST /user/validate-app-key` — Validate an application key ### Users · Customers - `POST /profile/customer/dashboard/auth/{authOrgId}` — Authenticate a customer for a dashboard - `GET /profile/customer/exist/{emailOrUsername}` — Check whether a customer exists - `POST /profile/customer/google/token` — Exchange a Google token for a customer - `POST /profile/customer/password/change` — Change a customer password - `GET /profile/customer/password/forgot/{email}/{redirectUrl}` — Request a customer password reset - `POST /profile/customer/password/reset` — Reset a customer password - `POST /profile/customer/password/validate-token` — Validate a customer reset token - `DELETE /profile/customer/profile/{emailOrUsername}` — Delete a customer - `GET /profile/customer/profile/{emailOrUsername}` — Get a customer profile - `POST /profile/customer/refresh` — Refresh a customer token - `DELETE /profile/customer/self` — Delete my customer account - `POST /profile/customer/shared-account` — Choose the account a customer buys for - `POST /profile/customer/signin` — Customer sign in - `POST /profile/customer/signup` — Customer sign up - `POST /profile/customer/social-login` — Validate a customer social login - `POST /profile/customer/subscribe` — Subscribe a customer - `POST /profile/customer/unsubscribe` — Unsubscribe a customer - `POST /profile/customer/update` — Update a customer - `GET /profile/customers/{attr}/{value}` — Find customers by attribute - `POST /user/customer/dashboard/auth/{authOrgId}` — Authenticate a customer for a dashboard - `GET /user/customer/exist/{emailOrUsername}` — Check whether a customer exists - `POST /user/customer/google/token` — Exchange a Google token for a customer - `POST /user/customer/password/change` — Change a customer password - `GET /user/customer/password/forgot/{email}/{redirectUrl}` — Request a customer password reset - `POST /user/customer/password/reset` — Reset a customer password - `POST /user/customer/password/validate-token` — Validate a customer reset token - `DELETE /user/customer/profile/{emailOrUsername}` — Delete a customer - `GET /user/customer/profile/{emailOrUsername}` — Get a customer profile - `POST /user/customer/refresh` — Refresh a customer token - `DELETE /user/customer/self` — Delete my customer account - `POST /user/customer/shared-account` — Choose the account a customer buys for - `POST /user/customer/signin` — Customer sign in - `POST /user/customer/signup` — Customer sign up - `POST /user/customer/social-login` — Validate a customer social login - `POST /user/customer/subscribe` — Subscribe a customer - `POST /user/customer/unsubscribe` — Unsubscribe a customer - `POST /user/customer/update` — Update a customer - `GET /user/customers/{attr}/{value}` — Find customers by attribute ### Users · Profiles - `POST /profile/meta` — Update my metadata - `POST /profile/update` — Update a user - `DELETE /profile/user/delete/{emailOrUsername}` — Delete a user - `POST /profile/user/meta` — Update my metadata - `GET /profile/user/profile/{emailOrUsername}` — Get a user profile (admins only) - `DELETE /profile/user/self` — Delete my account - `POST /profile/user/update` — Update a user - `GET /profile/who-is` — Identify a user - `GET /profile/whoami` — Get the current user - `POST /user/meta` — Update my metadata - `POST /user/update` — Update a user - `DELETE /user/user/delete/{emailOrUsername}` — Delete a user - `POST /user/user/meta` — Update my metadata - `GET /user/user/profile/{emailOrUsername}` — Get a user profile (admins only) - `DELETE /user/user/self` — Delete my account - `POST /user/user/update` — Update a user - `GET /user/who-is` — Identify a user - `GET /user/whoami` — Get the current user ### Users · Security - `POST /profile/security/2fa/backup-codes` — Generate backup codes - `GET /profile/security/2fa/backup-codes/count` — Count remaining backup codes - `POST /profile/security/2fa/disable` — Disable two-factor authentication - `POST /profile/security/2fa/enable` — Enable two-factor authentication - `GET /profile/security/2fa/factors` — List my second factors - `DELETE /profile/security/2fa/factors/{factorId}` — Remove one second factor - `POST /profile/security/2fa/factors/{factorId}/default` — Choose which factor is challenged first - `POST /profile/security/2fa/setup/{method}` — Set up two-factor authentication - `GET /profile/security/2fa/status` — Get two-factor status - `POST /profile/security/2fa/verify-setup` — Verify two-factor setup - `POST /profile/security/challenge/send` — Send a security challenge - `POST /profile/security/challenge/verify` — Verify a security challenge - `GET /profile/security/devices` — List my devices - `DELETE /profile/security/devices/{deviceId}` — Remove a device - `POST /profile/security/devices/{deviceId}/block` — Block a device - `POST /profile/security/devices/{deviceId}/trust` — Trust a device - `GET /profile/security/devices/current` — Get the current device - `GET /profile/security/login-history` — Get login history - `GET /profile/security/settings` — Get security settings - `PATCH /profile/security/settings` — Update security settings ### Voice - `POST /ai/voice/session` — Start talking to the in-app assistant - `POST /ai/voice/session/end` — The voice session ended: body { sessionId, conversationId? }. Charges the minutes talked. ### Workflow - `GET /workflow/analytics/{workflowId}/wait-times` — Get wait-time statistics - `GET /workflow/analytics/task/{taskId}/eta` — Estimate a task's remaining time - `GET /workflow/definition` — List workflow definitions - `POST /workflow/definition` — Create a workflow definition - `DELETE /workflow/definition/{id}` — Delete a workflow definition - `GET /workflow/definition/{id}` — Get a workflow definition - `PATCH /workflow/definition/{id}` — Update a workflow definition - `POST /workflow/definition/from-template/{name}` — Create a workflow from a template - `GET /workflow/escalation/breached` — List breached tasks - `POST /workflow/escalation/scan` — Run the overdue scan now - `GET /workflow/escalation/upcoming` — List tasks about to breach - `POST /workflow/fire` — Fire a record into a workflow - `GET /workflow/for/{datatype}` — Which workflow takes a datatype, and why - `GET /workflow/stations` — Get the kitchen board scope - `GET /workflow/task` — List tasks - `GET /workflow/task/{taskId}` — Get a task - `POST /workflow/task/{taskId}/advance` — Advance a task one stage - `POST /workflow/task/{taskId}/archive` — Archive a task - `POST /workflow/task/{taskId}/cancel` — Cancel a task - `POST /workflow/task/{taskId}/complete` — Complete a task - `POST /workflow/task/{taskId}/escalate-now` — Escalate a task immediately - `GET /workflow/task/{taskId}/history` — Get a task's stage history - `POST /workflow/task/{taskId}/move-to/{stageId}` — Move a task to a specific stage - `POST /workflow/task/{taskId}/note` — Add a note to a task - `POST /workflow/task/{taskId}/reassign` — Reassign a task - `GET /workflow/task/{taskId}/sla` — Get a task's SLA snapshot - `POST /workflow/task/{taskId}/snooze` — Snooze a task's SLA - `POST /workflow/task/{taskId}/unarchive` — Unarchive a task - `POST /workflow/task/restart` — Restart an owner's tasks ### Workspace - `GET /workspace` — List workspaces - `POST /workspace` — Create a workspace or conversation - `GET /workspace/{id}` — Get a workspace - `PATCH /workspace/{id}` — Update a workspace - `GET /workspace/{id}/agenda` — Agendas (projects) - `GET /workspace/{id}/analytics` — Workspace analytics - `POST /workspace/{id}/archive` — Archive a workspace - `GET /workspace/{id}/calendar` — Workspace calendar - `GET /workspace/{id}/files` — Workspace files - `POST /workspace/{id}/item` — Post an item - `GET /workspace/{id}/items` — Read the journal - `POST /workspace/{id}/join` — Join a public workspace - `POST /workspace/{id}/leave` — Leave a workspace - `GET /workspace/{id}/meetings/{mid}` — Get a meeting - `PATCH /workspace/{id}/meetings/{mid}` — Edit or cancel a meeting - `GET /workspace/{id}/members` — List members - `POST /workspace/{id}/members` — Add members - `DELETE /workspace/{id}/members/{email}` — Remove a member - `PATCH /workspace/{id}/members/{email}` — Change a member - `POST /workspace/{id}/notify` — My notification setting - `DELETE /workspace/{id}/pin/{iid}` — Unpin an item - `POST /workspace/{id}/pin/{iid}` — Pin an item - `POST /workspace/{id}/read` — Mark as read - `POST /workspace/{id}/restore` — Restore an archived workspace - `GET /workspace/{id}/rooms` — List rooms - `GET /workspace/{id}/search` — Search a workspace - `GET /workspace/{id}/tasks` — Task board - `GET /workspace/{id}/tasks/{tid}` — Get a task - `PATCH /workspace/{id}/tasks/{tid}` — Edit a task - `POST /workspace/digest/run` — Send the away digests now - `GET /workspace/home` — Home - `GET /workspace/home/calendar` — My calendar - `GET /workspace/home/files` — Recent files - `GET /workspace/home/inbox` — Inbox and mentions - `GET /workspace/home/search` — Search everything I have joined - `GET /workspace/home/tasks` — My tasks - `DELETE /workspace/item/{iid}` — Delete an item - `GET /workspace/item/{iid}` — Get an item - `PATCH /workspace/item/{iid}` — Edit an item - `POST /workspace/migrate` — Migrate existing workspaces