/
ST
stacksjs
/
Stacks API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 39m ago · Updated 2h ago
OpenAPI 3.0.0
raw.githubusercontent.com
2026-08-16
1,145
0
796.3 KB
bc0120a99ed2
get
/_stacks/email/unsubscribe/{token}
get
/_stacks/mail/preview
get
/_stacks/mail/preview/{name}
get
/_stacks/mail/preview/{name}/raw
post
/ai/ask
post
/ai/summary
get
/api/activities
get
/api/activities/{id}
get
/api/analytics-events
post
/api/analytics-events
post
/api/analytics-events/bulk-delete
get
/api/analytics-events/{id}
delete
/api/analytics-events/{id}
get
/api/analytics/blog
get
/api/analytics/browsers
get
/api/analytics/commerce
get
/api/analytics/countries
get
/api/analytics/devices
get
/api/analytics/events
get
/api/analytics/marketing
get
/api/analytics/pages
get
/api/analytics/referrers
get
/api/analytics/sales
get
/api/analytics/web
get
/api/auction-items
post
/api/auction-items
post
/api/auction-items/bulk-delete
get
/api/auction-items/{id}
put
/api/auction-items/{id}
delete
/api/auction-items/{id}
patch
/api/auction-items/{id}
get
/api/auctions
post
/api/auctions
post
/api/auctions/bulk-delete
get
/api/auctions/{id}
put
/api/auctions/{id}
delete
/api/auctions/{id}
patch
/api/auctions/{id}
get
/api/authors
post
/api/authors
post
/api/authors/bulk-delete
get
/api/authors/{id}
put
/api/authors/{id}
delete
/api/authors/{id}
patch
/api/authors/{id}
get
/api/automation-runs
get
/api/automation-runs/{id}
get
/api/automations
post
/api/automations
post
/api/automations/bulk-delete
get
/api/automations/{id}
put
/api/automations/{id}
delete
/api/automations/{id}
patch
/api/automations/{id}
get
/api/bids
get
/api/bids/{id}
get
/api/board-columns
post
/api/board-columns
post
/api/board-columns/bulk-delete
get
/api/board-columns/{id}
put
/api/board-columns/{id}
delete
/api/board-columns/{id}
patch
/api/board-columns/{id}
get
/api/boards
post
/api/boards
post
/api/boards/bulk-delete
get
/api/boards/{id}
put
/api/boards/{id}
delete
/api/boards/{id}
patch
/api/boards/{id}
get
/api/campaign-sends
get
/api/campaign-sends/{id}
get
/api/campaign-variants
post
/api/campaign-variants
post
/api/campaign-variants/bulk-delete
get
/api/campaign-variants/{id}
put
/api/campaign-variants/{id}
delete
/api/campaign-variants/{id}
patch
/api/campaign-variants/{id}
get
/api/campaigns
post
/api/campaigns
post
/api/campaigns/bulk-delete
get
/api/campaigns/{id}
put
/api/campaigns/{id}
delete
/api/campaigns/{id}
patch
/api/campaigns/{id}
get
/api/card-comments
post
/api/card-comments
post
/api/card-comments/bulk-delete
get
/api/card-comments/{id}
put
/api/card-comments/{id}
delete
/api/card-comments/{id}
patch
/api/card-comments/{id}
get
/api/cards
post
/api/cards
post
/api/cards/bulk-delete
get
/api/cards/{id}
put
/api/cards/{id}
delete
/api/cards/{id}
patch
/api/cards/{id}
get
/api/cart
get
/api/cart-items
post
/api/cart-items
post
/api/cart-items/bulk-delete
get
/api/cart-items/{id}
put
/api/cart-items/{id}
delete
/api/cart-items/{id}
patch
/api/cart-items/{id}
post
/api/cart/add
post
/api/cart/update
get
/api/carts
post
/api/carts
post
/api/carts/bulk-delete
get
/api/carts/{id}
put
/api/carts/{id}
delete
/api/carts/{id}
patch
/api/carts/{id}
post
/api/checkout/contact
post
/api/checkout/place
post
/api/checkout/shipping
get
/api/comments
post
/api/comments
post
/api/comments/bulk-delete
get
/api/comments/{id}
put
/api/comments/{id}
delete
/api/comments/{id}
patch
/api/comments/{id}
get
/api/commerce/coupons
post
/api/commerce/coupons
get
/api/commerce/coupons/{id}
delete
/api/commerce/coupons/{id}
patch
/api/commerce/coupons/{id}
get
/api/commerce/customers
post
/api/commerce/customers
get
/api/commerce/customers/{id}
delete
/api/commerce/customers/{id}
patch
/api/commerce/customers/{id}
get
/api/commerce/dashboard
get
/api/commerce/delivery-routes
post
/api/commerce/delivery-routes
get
/api/commerce/delivery-routes/{id}
delete
/api/commerce/delivery-routes/{id}
patch
/api/commerce/delivery-routes/{id}
get
/api/commerce/digital-deliveries
post
/api/commerce/digital-deliveries
get
/api/commerce/digital-deliveries/{id}
delete
/api/commerce/digital-deliveries/{id}
patch
/api/commerce/digital-deliveries/{id}
get
/api/commerce/drivers
post
/api/commerce/drivers
get
/api/commerce/drivers/{id}
delete
/api/commerce/drivers/{id}
patch
/api/commerce/drivers/{id}
get
/api/commerce/gift-cards
post
/api/commerce/gift-cards
get
/api/commerce/gift-cards/stats
get
/api/commerce/gift-cards/{id}
delete
/api/commerce/gift-cards/{id}
patch
/api/commerce/gift-cards/{id}
patch
/api/commerce/gift-cards/{id}/balance
get
/api/commerce/license-keys
post
/api/commerce/license-keys
get
/api/commerce/license-keys/{id}
delete
/api/commerce/license-keys/{id}
patch
/api/commerce/license-keys/{id}
get
/api/commerce/orders
post
/api/commerce/orders
get
/api/commerce/orders/export
get
/api/commerce/orders/{id}
delete
/api/commerce/orders/{id}
patch
/api/commerce/orders/{id}
get
/api/commerce/payment-stats
get
/api/commerce/payment-trends
get
/api/commerce/payments
post
/api/commerce/payments
get
/api/commerce/payments/{id}
delete
/api/commerce/payments/{id}
patch
/api/commerce/payments/{id}
get
/api/commerce/pos
get
/api/commerce/print-devices
post
/api/commerce/print-devices
get
/api/commerce/print-devices/{id}
delete
/api/commerce/print-devices/{id}
patch
/api/commerce/print-devices/{id}
get
/api/commerce/product-categories
post
/api/commerce/product-categories
get
/api/commerce/product-manufacturers
post
/api/commerce/product-manufacturers
get
/api/commerce/product-manufacturers/{id}
delete
/api/commerce/product-manufacturers/{id}
patch
/api/commerce/product-manufacturers/{id}
get
/api/commerce/products
post
/api/commerce/products
get
/api/commerce/products/reviews
post
/api/commerce/products/reviews
get
/api/commerce/products/reviews/{id}
delete
/api/commerce/products/reviews/{id}
patch
/api/commerce/products/reviews/{id}
get
/api/commerce/products/units
post
/api/commerce/products/units
get
/api/commerce/products/units/{id}
delete
/api/commerce/products/units/{id}
patch
/api/commerce/products/units/{id}
get
/api/commerce/products/variants
post
/api/commerce/products/variants
get
/api/commerce/products/variants/{id}
delete
/api/commerce/products/variants/{id}
patch
/api/commerce/products/variants/{id}
get
/api/commerce/products/{id}
delete
/api/commerce/products/{id}
patch
/api/commerce/products/{id}
get
/api/commerce/products/{productId}/variants
get
/api/commerce/receipts
post
/api/commerce/receipts
get
/api/commerce/receipts/{id}
delete
/api/commerce/receipts/{id}
patch
/api/commerce/receipts/{id}
get
/api/commerce/shipping-methods
post
/api/commerce/shipping-methods
get
/api/commerce/shipping-methods/{id}
delete
/api/commerce/shipping-methods/{id}
patch
/api/commerce/shipping-methods/{id}
get
/api/commerce/shipping-rates
post
/api/commerce/shipping-rates
get
/api/commerce/shipping-rates/{id}
delete
/api/commerce/shipping-rates/{id}
patch
/api/commerce/shipping-rates/{id}
get
/api/commerce/shipping-zones
post
/api/commerce/shipping-zones
get
/api/commerce/shipping-zones/{id}
delete
/api/commerce/shipping-zones/{id}
patch
/api/commerce/shipping-zones/{id}
get
/api/commerce/tax-rates
post
/api/commerce/tax-rates
get
/api/commerce/tax-rates/{id}
delete
/api/commerce/tax-rates/{id}
patch
/api/commerce/tax-rates/{id}
get
/api/commerce/waitlist/products
post
/api/commerce/waitlist/products
get
/api/commerce/waitlist/products/analytics
get
/api/commerce/waitlist/products/quantity-distribution
get
/api/commerce/waitlist/products/status
get
/api/commerce/waitlist/products/time-series
get
/api/commerce/waitlist/products/{id}
delete
/api/commerce/waitlist/products/{id}
patch
/api/commerce/waitlist/products/{id}
get
/api/commerce/waitlist/restaurants
post
/api/commerce/waitlist/restaurants
get
/api/commerce/waitlist/restaurants/dashboard
get
/api/commerce/waitlist/restaurants/{id}
delete
/api/commerce/waitlist/restaurants/{id}
patch
/api/commerce/waitlist/restaurants/{id}
get
/api/communication-suppressions
post
/api/communication-suppressions
post
/api/communication-suppressions/bulk-delete
get
/api/communication-suppressions/{id}
delete
/api/communication-suppressions/{id}
get
/api/consent-events
get
/api/consent-events/{id}
post
contact.send
get
/api/coupons
post
/api/coupons
post
/api/coupons/bulk-delete
get
/api/coupons/{id}
put
/api/coupons/{id}
delete
/api/coupons/{id}
patch
/api/coupons/{id}
get
/api/customers
post
/api/customers
post
/api/customers/bulk-delete
get
/api/customers/{id}
put
/api/customers/{id}
delete
/api/customers/{id}
patch
/api/customers/{id}
get
/api/dashboard/activity
get
/api/dashboard/analytics/marketing
get
/api/dashboard/analytics/sales
get
/api/dashboard/analytics/web
get
/api/dashboard/auth/me
get
/api/dashboard/authors
post
/api/dashboard/authors
delete
/api/dashboard/authors/{id}
patch
/api/dashboard/authors/{id}
get
/api/dashboard/billing
get
/api/dashboard/blog
post
/api/dashboard/blog
get
/api/dashboard/blog/{slug}
delete
/api/dashboard/blog/{slug}
patch
/api/dashboard/blog/{slug}
get
/api/dashboard/buddy/chat
post
/api/dashboard/buddy/chat
post
/api/dashboard/buddy/chat/clear
get
/api/dashboard/categories
post
/api/dashboard/categories
delete
/api/dashboard/categories/{id}
get
/api/dashboard/ci/repos/{owner}/{name}/runs
get
/api/dashboard/ci/repos/{owner}/{name}/runs/{runId}/jobs
get
/api/dashboard/ci/runner-history
get
/api/dashboard/ci/status
get
/api/dashboard/cloud
get
/api/dashboard/comments
delete
/api/dashboard/comments/{id}
patch
/api/dashboard/comments/{id}
get
/api/dashboard/commerce/categories
post
/api/dashboard/commerce/categories
delete
/api/dashboard/commerce/categories/{id}
patch
/api/dashboard/commerce/categories/{id}
get
/api/dashboard/commerce/coupons
post
/api/dashboard/commerce/coupons
delete
/api/dashboard/commerce/coupons/{id}
patch
/api/dashboard/commerce/coupons/{id}
get
/api/dashboard/commerce/customers
post
/api/dashboard/commerce/customers
delete
/api/dashboard/commerce/customers/{id}
patch
/api/dashboard/commerce/customers/{id}
get
/api/dashboard/commerce/delivery
get
/api/dashboard/commerce/delivery-routes
post
/api/dashboard/commerce/delivery-routes
get
/api/dashboard/commerce/delivery-routes/{id}
delete
/api/dashboard/commerce/delivery-routes/{id}
patch
/api/dashboard/commerce/delivery-routes/{id}
get
/api/dashboard/commerce/digital-deliveries
post
/api/dashboard/commerce/digital-deliveries
get
/api/dashboard/commerce/digital-deliveries/{id}
delete
/api/dashboard/commerce/digital-deliveries/{id}
patch
/api/dashboard/commerce/digital-deliveries/{id}
get
/api/dashboard/commerce/drivers
post
/api/dashboard/commerce/drivers
get
/api/dashboard/commerce/drivers/{id}
delete
/api/dashboard/commerce/drivers/{id}
patch
/api/dashboard/commerce/drivers/{id}
get
/api/dashboard/commerce/gift-cards
post
/api/dashboard/commerce/gift-cards
delete
/api/dashboard/commerce/gift-cards/{id}
patch
/api/dashboard/commerce/gift-cards/{id}
get
/api/dashboard/commerce/license-key-options
get
/api/dashboard/commerce/license-keys
post
/api/dashboard/commerce/license-keys
get
/api/dashboard/commerce/license-keys/{id}
delete
/api/dashboard/commerce/license-keys/{id}
patch
/api/dashboard/commerce/license-keys/{id}
get
/api/dashboard/commerce/manufacturers
post
/api/dashboard/commerce/manufacturers
delete
/api/dashboard/commerce/manufacturers/{id}
patch
/api/dashboard/commerce/manufacturers/{id}
get
/api/dashboard/commerce/orders
post
/api/dashboard/commerce/orders
delete
/api/dashboard/commerce/orders/{id}
patch
/api/dashboard/commerce/orders/{id}
get
/api/dashboard/commerce/payments
post
/api/dashboard/commerce/payments/{id}/refund
get
/api/dashboard/commerce/pos
post
/api/dashboard/commerce/pos/checkout
get
/api/dashboard/commerce/print-devices
post
/api/dashboard/commerce/print-devices
delete
/api/dashboard/commerce/print-devices/{id}
patch
/api/dashboard/commerce/print-devices/{id}
get
/api/dashboard/commerce/print-logs
delete
/api/dashboard/commerce/print-logs/{id}
get
/api/dashboard/commerce/products
post
/api/dashboard/commerce/products
get
/api/dashboard/commerce/products/{id}
delete
/api/dashboard/commerce/products/{id}
patch
/api/dashboard/commerce/products/{id}
get
/api/dashboard/commerce/reviews
delete
/api/dashboard/commerce/reviews/{id}
patch
/api/dashboard/commerce/reviews/{id}
get
/api/dashboard/commerce/shipping-methods
post
/api/dashboard/commerce/shipping-methods
get
/api/dashboard/commerce/shipping-methods/{id}
delete
/api/dashboard/commerce/shipping-methods/{id}
patch
/api/dashboard/commerce/shipping-methods/{id}
get
/api/dashboard/commerce/shipping-rates
post
/api/dashboard/commerce/shipping-rates
get
/api/dashboard/commerce/shipping-rates/{id}
delete
/api/dashboard/commerce/shipping-rates/{id}
patch
/api/dashboard/commerce/shipping-rates/{id}
get
/api/dashboard/commerce/shipping-zones
post
/api/dashboard/commerce/shipping-zones
get
/api/dashboard/commerce/shipping-zones/{id}
delete
/api/dashboard/commerce/shipping-zones/{id}
patch
/api/dashboard/commerce/shipping-zones/{id}
get
/api/dashboard/commerce/stats
get
/api/dashboard/commerce/taxes
post
/api/dashboard/commerce/taxes
delete
/api/dashboard/commerce/taxes/{id}
patch
/api/dashboard/commerce/taxes/{id}
patch
/api/dashboard/commerce/taxes/{id}/default
get
/api/dashboard/commerce/units
post
/api/dashboard/commerce/units
delete
/api/dashboard/commerce/units/{id}
patch
/api/dashboard/commerce/units/{id}
patch
/api/dashboard/commerce/units/{id}/default
get
/api/dashboard/commerce/variants
post
/api/dashboard/commerce/variants
delete
/api/dashboard/commerce/variants/{id}
patch
/api/dashboard/commerce/variants/{id}
get
/api/dashboard/commerce/waitlist-products
post
/api/dashboard/commerce/waitlist-products
delete
/api/dashboard/commerce/waitlist-products/{id}
patch
/api/dashboard/commerce/waitlist-products/{id}
get
/api/dashboard/commerce/waitlist-restaurants
post
/api/dashboard/commerce/waitlist-restaurants
delete
/api/dashboard/commerce/waitlist-restaurants/{id}
patch
/api/dashboard/commerce/waitlist-restaurants/{id}
get
/api/dashboard/content/overview
get
/api/dashboard/data/activity
get
/api/dashboard/data/subscribers
get
/api/dashboard/data/teams
get
/api/dashboard/data/users
get
/api/dashboard/deployments
post
/api/dashboard/deployments
get
/api/dashboard/deployments/avg-time
get
/api/dashboard/deployments/count
post
/api/dashboard/deployments/preview
get
/api/dashboard/deployments/recent
post
/api/dashboard/deployments/rollback
post
/api/dashboard/deployments/rollback/preview
get
/api/dashboard/deployments/script
put
/api/dashboard/deployments/script
get
/api/dashboard/deployments/terminal
get
/api/dashboard/deployments/{id}
get
/api/dashboard/dns
get
/api/dashboard/email/activity
get
/api/dashboard/email/captured
get
/api/dashboard/email/captured/{id}
get
/api/dashboard/email/inbox
get
/api/dashboard/email/inbox/{id}
delete
/api/dashboard/email/inbox/{id}
get
/api/dashboard/email/inbox/{id}/attachments/{attachmentId}
get
/api/dashboard/email/preferences
put
/api/dashboard/email/preferences
post
/api/dashboard/email/read
post
/api/dashboard/email/send
get
/api/dashboard/email/stats
post
/api/dashboard/email/unread
get
/api/dashboard/environment
put
/api/dashboard/environment
get
/api/dashboard/event-metrics
post
/api/dashboard/event-metrics
get
/api/dashboard/files
delete
/api/dashboard/files
post
/api/dashboard/files/directories
post
/api/dashboard/files/uploads
get
/api/dashboard/health
get
/api/dashboard/home
get
/api/dashboard/insights
get
/api/dashboard/jobs
get
/api/dashboard/jobs/stats
get
/api/dashboard/jobs/{id}
post
/api/dashboard/jobs/{id}/retry
get
/api/dashboard/kanban/boards
post
/api/dashboard/kanban/boards
post
/api/dashboard/kanban/boards/reorder
get
/api/dashboard/kanban/boards/{id}
delete
/api/dashboard/kanban/boards/{id}
patch
/api/dashboard/kanban/boards/{id}
post
/api/dashboard/kanban/cards
post
/api/dashboard/kanban/cards/reorder
get
/api/dashboard/kanban/cards/{id}
delete
/api/dashboard/kanban/cards/{id}
patch
/api/dashboard/kanban/cards/{id}
post
/api/dashboard/kanban/cards/{id}/assignees
post
/api/dashboard/kanban/cards/{id}/comments
post
/api/dashboard/kanban/cards/{id}/labels
post
/api/dashboard/kanban/columns
post
/api/dashboard/kanban/columns/reorder
delete
/api/dashboard/kanban/columns/{id}
patch
/api/dashboard/kanban/columns/{id}
delete
/api/dashboard/kanban/comments/{id}
patch
/api/dashboard/kanban/comments/{id}
post
/api/dashboard/kanban/labels
delete
/api/dashboard/kanban/labels/{id}
patch
/api/dashboard/kanban/labels/{id}
get
/api/dashboard/kanban/users
get
/api/dashboard/library/components
post
/api/dashboard/library/components
get
/api/dashboard/library/dependencies
get
/api/dashboard/library/functions
post
/api/dashboard/library/functions
get
/api/dashboard/library/packages
get
/api/dashboard/logs
get
/api/dashboard/mail-settings
put
/api/dashboard/mail-settings
get
/api/dashboard/mailboxes
get
/api/dashboard/marketing/campaigns
post
/api/dashboard/marketing/campaigns
delete
/api/dashboard/marketing/campaigns/{id}
patch
/api/dashboard/marketing/campaigns/{id}
post
/api/dashboard/marketing/campaigns/{id}/cancel
post
/api/dashboard/marketing/campaigns/{id}/schedule
post
/api/dashboard/marketing/campaigns/{id}/send
get
/api/dashboard/marketing/lists
post
/api/dashboard/marketing/lists
delete
/api/dashboard/marketing/lists/{id}
patch
/api/dashboard/marketing/lists/{id}
get
/api/dashboard/marketing/social-posts
post
/api/dashboard/marketing/social-posts
delete
/api/dashboard/marketing/social-posts/{id}
patch
/api/dashboard/marketing/social-posts/{id}
get
/api/dashboard/models
get
/api/dashboard/models/{slug}
post
/api/dashboard/models/{slug}
delete
/api/dashboard/models/{slug}/{id}
patch
/api/dashboard/models/{slug}/{id}
get
/api/dashboard/monitoring/errors
delete
/api/dashboard/monitoring/errors
get
/api/dashboard/monitoring/errors/group
patch
/api/dashboard/monitoring/errors/ignore
patch
/api/dashboard/monitoring/errors/resolve
get
/api/dashboard/monitoring/errors/stats
get
/api/dashboard/monitoring/errors/timeline
patch
/api/dashboard/monitoring/errors/unresolve
get
/api/dashboard/monitoring/errors/{id}
get
/api/dashboard/notification-deliveries
get
/api/dashboard/notification-deliveries/history
get
/api/dashboard/notification-deliveries/overview
post
/api/dashboard/notification-deliveries/{id}/retry
get
/api/dashboard/operations/audit
get
/api/dashboard/operations/changes
post
/api/dashboard/operations/changes/releases/{id}/decision
get
/api/dashboard/operations/incidents
patch
/api/dashboard/operations/incidents/{id}
get
/api/dashboard/operations/migrations
post
/api/dashboard/operations/migrations/apply
post
/api/dashboard/operations/migrations/reconcile
get
/api/dashboard/operations/recovery
post
/api/dashboard/operations/recovery/destinations
post
/api/dashboard/operations/recovery/destinations/{id}/test
patch
/api/dashboard/operations/recovery/points/{id}/protection
post
/api/dashboard/operations/recovery/points/{id}/restore
post
/api/dashboard/operations/recovery/points/{id}/verify
post
/api/dashboard/operations/recovery/policies
post
/api/dashboard/operations/recovery/policies/{id}/run
post
/api/dashboard/operations/recovery/retention
get
/api/dashboard/operations/scheduler
patch
/api/dashboard/operations/scheduler/{name}
post
/api/dashboard/operations/scheduler/{name}/run
get
/api/dashboard/pages
post
/api/dashboard/pages
delete
/api/dashboard/pages/{id}
patch
/api/dashboard/pages/{id}
get
/api/dashboard/posts
post
/api/dashboard/posts
delete
/api/dashboard/posts/{id}
patch
/api/dashboard/posts/{id}
get
/api/dashboard/queries
get
/api/dashboard/queries/{id}
post
/api/dashboard/queue/retry-failed
get
/api/dashboard/queue/stats
get
/api/dashboard/queue/workers
get
/api/dashboard/rbac/permissions
post
/api/dashboard/rbac/permissions
delete
/api/dashboard/rbac/permissions/{name}
get
/api/dashboard/rbac/roles
post
/api/dashboard/rbac/roles
delete
/api/dashboard/rbac/roles/{name}
get
/api/dashboard/rbac/roles/{name}/permissions
post
/api/dashboard/rbac/roles/{name}/permissions
get
/api/dashboard/rbac/users
get
/api/dashboard/rbac/users/{id}/roles
post
/api/dashboard/rbac/users/{id}/roles
get
/api/dashboard/realtime
get
/api/dashboard/releases
get
/api/dashboard/requests
get
/api/dashboard/search
get
/api/dashboard/serverless
get
/api/dashboard/servers
get
/api/dashboard/servers/{id}
get
/api/dashboard/source/actions
get
/api/dashboard/source/commands
get
/api/dashboard/stats
get
/api/dashboard/tags
post
/api/dashboard/tags
delete
/api/dashboard/tags/{id}
post
/api/dashboard/teams/{id}/invitations
delete
/api/dashboard/teams/{id}/invitations/{invitationId}
post
/api/dashboard/teams/{id}/invitations/{invitationId}/resend
delete
/api/dashboard/teams/{id}/members/{memberId}
patch
/api/dashboard/teams/{id}/members/{memberId}
get
/api/dashboard/teams/{id}/people
get
/api/data/activity
get
/api/data/subscribers
get
/api/data/teams
get
/api/data/users
get
/api/delivery-routes
post
/api/delivery-routes
post
/api/delivery-routes/bulk-delete
get
/api/delivery-routes/{id}
put
/api/delivery-routes/{id}
delete
/api/delivery-routes/{id}
patch
/api/delivery-routes/{id}
get
/api/delivery-stops
post
/api/delivery-stops
post
/api/delivery-stops/bulk-delete
get
/api/delivery-stops/{id}
put
/api/delivery-stops/{id}
delete
/api/delivery-stops/{id}
patch
/api/delivery-stops/{id}
get
/api/deployments
get
/api/deployments/{id}
get
/api/digital-deliveries
post
/api/digital-deliveries
post
/api/digital-deliveries/bulk-delete
get
/api/digital-deliveries/{id}
put
/api/digital-deliveries/{id}
delete
/api/digital-deliveries/{id}
patch
/api/digital-deliveries/{id}
get
/api/drivers
post
/api/drivers
post
/api/drivers/bulk-delete
get
/api/drivers/{id}
put
/api/drivers/{id}
delete
/api/drivers/{id}
patch
/api/drivers/{id}
get
/api/email-idempotency
post
/api/email-idempotency/bulk-delete
get
/api/email-idempotency/{id}
delete
/api/email-idempotency/{id}
get
/api/email-list-subscribers
get
/api/email-list-subscribers/{id}
get
/api/email-lists
post
/api/email-lists
post
/api/email-lists/bulk-delete
get
/api/email-lists/{id}
put
/api/email-lists/{id}
delete
/api/email-lists/{id}
patch
/api/email-lists/{id}
get
/api/email-suppressions
post
/api/email-suppressions/bulk-delete
get
/api/email-suppressions/{id}
delete
/api/email-suppressions/{id}
get
/api/email-webhook-events
post
/api/email-webhook-events/bulk-delete
get
/api/email-webhook-events/{id}
delete
/api/email-webhook-events/{id}
post
email.subscribe
get
email.unsubscribe
post
email.unsubscribe
get
/api/form-fields
post
/api/form-fields
post
/api/form-fields/bulk-delete
get
/api/form-fields/{id}
put
/api/form-fields/{id}
delete
/api/form-fields/{id}
patch
/api/form-fields/{id}
get
/api/forms
post
/api/forms
post
/api/forms/bulk-delete
get
/api/forms/{id}
put
/api/forms/{id}
delete
/api/forms/{id}
patch
/api/forms/{id}
get
/api/gift-cards
post
/api/gift-cards
post
/api/gift-cards/bulk-delete
get
/api/gift-cards/{id}
put
/api/gift-cards/{id}
delete
/api/gift-cards/{id}
patch
/api/gift-cards/{id}
get
/api/hello
get
/api/labels
post
/api/labels
post
/api/labels/bulk-delete
get
/api/labels/{id}
put
/api/labels/{id}
delete
/api/labels/{id}
patch
/api/labels/{id}
get
/api/license-keys
post
/api/license-keys
post
/api/license-keys/bulk-delete
get
/api/license-keys/{id}
put
/api/license-keys/{id}
delete
/api/license-keys/{id}
patch
/api/license-keys/{id}
get
/api/logs
get
/api/logs/{id}
get
/api/loyalty-points
post
/api/loyalty-points
post
/api/loyalty-points/bulk-delete
get
/api/loyalty-points/{id}
put
/api/loyalty-points/{id}
delete
/api/loyalty-points/{id}
patch
/api/loyalty-points/{id}
get
/api/loyalty-rewards
post
/api/loyalty-rewards
post
/api/loyalty-rewards/bulk-delete
get
/api/loyalty-rewards/{id}
put
/api/loyalty-rewards/{id}
delete
/api/loyalty-rewards/{id}
patch
/api/loyalty-rewards/{id}
get
/api/mail-preferences
post
/api/mail-preferences
post
/api/mail-preferences/bulk-delete
get
/api/mail-preferences/{id}
put
/api/mail-preferences/{id}
delete
/api/mail-preferences/{id}
patch
/api/mail-preferences/{id}
get
/api/marketing/campaigns
get
/api/marketing/lists
get
/api/marketing/social-posts
get
/api/menu-items
post
/api/menu-items
post
/api/menu-items/bulk-delete
get
/api/menu-items/{id}
put
/api/menu-items/{id}
delete
/api/menu-items/{id}
patch
/api/menu-items/{id}
get
/api/menus
post
/api/menus
post
/api/menus/bulk-delete
get
/api/menus/{id}
put
/api/menus/{id}
delete
/api/menus/{id}
patch
/api/menus/{id}
get
/api/monitoring/errors
delete
/api/monitoring/errors
get
/api/monitoring/errors/group
patch
/api/monitoring/errors/ignore
patch
/api/monitoring/errors/resolve
get
/api/monitoring/errors/stats
get
/api/monitoring/errors/timeline
patch
/api/monitoring/errors/unresolve
get
/api/monitoring/errors/{id}
get
/api/notification-deliveries
post
/api/notification-deliveries/bulk-delete
get
/api/notification-deliveries/{id}
delete
/api/notification-deliveries/{id}
get
/api/notifications
post
/api/notifications
post
/api/notifications/bulk-delete
get
/api/notifications/dashboard
get
/api/notifications/email
get
/api/notifications/history
get
/api/notifications/sms
get
/api/notifications/{id}
put
/api/notifications/{id}
delete
/api/notifications/{id}
patch
/api/notifications/{id}
get
/api/orders
post
/api/orders
post
/api/orders/bulk-delete
get
/api/orders/{id}
put
/api/orders/{id}
delete
/api/orders/{id}
patch
/api/orders/{id}
get
/api/pages
post
/api/pages
post
/api/pages/bulk-delete
get
/api/pages/{id}
put
/api/pages/{id}
delete
/api/pages/{id}
patch
/api/pages/{id}
get
/api/payments
post
/api/payments
post
/api/payments/bulk-delete
get
/api/payments/{id}
put
/api/payments/{id}
delete
/api/payments/{id}
patch
/api/payments/{id}
get
/api/pledges
post
/api/pledges
post
/api/pledges/bulk-delete
get
/api/pledges/{id}
put
/api/pledges/{id}
delete
/api/pledges/{id}
patch
/api/pledges/{id}
get
/api/posts
post
/api/posts
post
/api/posts/bulk-delete
get
/api/posts/{id}
put
/api/posts/{id}
delete
/api/posts/{id}
patch
/api/posts/{id}
get
/api/print-devices
post
/api/print-devices
post
/api/print-devices/bulk-delete
get
/api/print-devices/{id}
put
/api/print-devices/{id}
delete
/api/print-devices/{id}
patch
/api/print-devices/{id}
get
/api/print-logs
post
/api/print-logs
post
/api/print-logs/bulk-delete
get
/api/print-logs/{id}
put
/api/print-logs/{id}
delete
/api/print-logs/{id}
patch
/api/print-logs/{id}
get
/api/product-categories
post
/api/product-categories
post
/api/product-categories/bulk-delete
get
/api/product-categories/{id}
put
/api/product-categories/{id}
delete
/api/product-categories/{id}
patch
/api/product-categories/{id}
get
/api/product-manufacturers
post
/api/product-manufacturers
post
/api/product-manufacturers/bulk-delete
get
/api/product-manufacturers/{id}
put
/api/product-manufacturers/{id}
delete
/api/product-manufacturers/{id}
patch
/api/product-manufacturers/{id}
get
/api/product-reviews
post
/api/product-reviews
post
/api/product-reviews/bulk-delete
get
/api/product-reviews/{id}
put
/api/product-reviews/{id}
delete
/api/product-reviews/{id}
patch
/api/product-reviews/{id}
get
/api/product-units
post
/api/product-units
post
/api/product-units/bulk-delete
get
/api/product-units/{id}
put
/api/product-units/{id}
delete
/api/product-units/{id}
patch
/api/product-units/{id}
get
/api/product-variants
post
/api/product-variants
post
/api/product-variants/bulk-delete
get
/api/product-variants/{id}
put
/api/product-variants/{id}
delete
/api/product-variants/{id}
patch
/api/product-variants/{id}
get
/api/products
post
/api/products
post
/api/products/bulk-delete
get
/api/products/{id}
put
/api/products/{id}
delete
/api/products/{id}
patch
/api/products/{id}
get
/api/queries/dashboard
get
/api/queries/frequent
post
/api/queries/prune
get
/api/queries/recent
get
/api/queries/slow
get
/api/queries/stats
get
/api/queries/timeline
get
/api/queries/:id
get
/api/query-logs
get
/api/query-logs/{id}
get
/api/redirects
post
/api/redirects
post
/api/redirects/bulk-delete
get
/api/redirects/{id}
put
/api/redirects/{id}
delete
/api/redirects/{id}
patch
/api/redirects/{id}
get
/api/releases
get
/api/releases/{id}
get
/api/requests
post
/api/requests
post
/api/requests/bulk-delete
get
/api/requests/{id}
put
/api/requests/{id}
delete
/api/requests/{id}
patch
/api/requests/{id}
post
/api/reviews/submit
get
/api/sender-domains
post
/api/sender-domains
post
/api/sender-domains/bulk-delete
get
/api/sender-domains/{id}
put
/api/sender-domains/{id}
delete
/api/sender-domains/{id}
patch
/api/sender-domains/{id}
get
/api/serverless
get
/api/settings/mail
put
/api/settings/mail
get
/api/shipping-methods
post
/api/shipping-methods
post
/api/shipping-methods/bulk-delete
get
/api/shipping-methods/{id}
put
/api/shipping-methods/{id}
delete
/api/shipping-methods/{id}
patch
/api/shipping-methods/{id}
get
/api/shipping-rates
post
/api/shipping-rates
post
/api/shipping-rates/bulk-delete
get
/api/shipping-rates/{id}
put
/api/shipping-rates/{id}
delete
/api/shipping-rates/{id}
patch
/api/shipping-rates/{id}
get
/api/shipping-zones
post
/api/shipping-zones
post
/api/shipping-zones/bulk-delete
get
/api/shipping-zones/{id}
put
/api/shipping-zones/{id}
delete
/api/shipping-zones/{id}
patch
/api/shipping-zones/{id}
get
/api/site-domains
post
/api/site-domains
post
/api/site-domains/bulk-delete
get
/api/site-domains/{id}
put
/api/site-domains/{id}
delete
/api/site-domains/{id}
patch
/api/site-domains/{id}
get
/api/sites
post
/api/sites
post
/api/sites/bulk-delete
get
/api/sites/{id}
put
/api/sites/{id}
delete
/api/sites/{id}
patch
/api/sites/{id}
get
/api/social-posts
post
/api/social-posts
post
/api/social-posts/bulk-delete
get
/api/social-posts/{id}
put
/api/social-posts/{id}
delete
/api/social-posts/{id}
patch
/api/social-posts/{id}
get
/api/subscriber-emails
get
/api/subscriber-emails/{id}
get
/api/subscribers
post
/api/subscribers
post
/api/subscribers/bulk-delete
get
/api/subscribers/{id}
put
/api/subscribers/{id}
delete
/api/subscribers/{id}
patch
/api/subscribers/{id}
get
/api/tags
post
/api/tags
post
/api/tags/bulk-delete
get
/api/tags/{id}
put
/api/tags/{id}
delete
/api/tags/{id}
patch
/api/tags/{id}
get
/api/tax-rates
post
/api/tax-rates
post
/api/tax-rates/bulk-delete
get
/api/tax-rates/{id}
put
/api/tax-rates/{id}
delete
/api/tax-rates/{id}
patch
/api/tax-rates/{id}
get
/api/team-invitation-links/{token}
get
/api/team-invitations
post
/api/team-invitations/bulk-delete
get
/api/team-invitations/{id}
delete
/api/team-invitations/{id}
post
/api/team-invitations/{token}/accept
get
/api/team-members
post
/api/team-members
post
/api/team-members/bulk-delete
get
/api/team-members/{id}
put
/api/team-members/{id}
delete
/api/team-members/{id}
patch
/api/team-members/{id}
get
/api/teams
post
/api/teams
post
/api/teams/bulk-delete
get
/api/teams/{id}
put
/api/teams/{id}
delete
/api/teams/{id}
patch
/api/teams/{id}
get
/api/transactions
post
/api/transactions
post
/api/transactions/bulk-delete
get
/api/transactions/{id}
put
/api/transactions/{id}
delete
/api/transactions/{id}
patch
/api/transactions/{id}
get
/api/usage-events
get
/api/usage-events/{id}
get
/api/users
post
/api/users
get
/api/users/{id}
get
/api/waitlist-products
post
/api/waitlist-products
post
/api/waitlist-products/bulk-delete
get
/api/waitlist-products/{id}
put
/api/waitlist-products/{id}
delete
/api/waitlist-products/{id}
patch
/api/waitlist-products/{id}
get
/api/waitlist-restaurants
post
/api/waitlist-restaurants
post
/api/waitlist-restaurants/bulk-delete
get
/api/waitlist-restaurants/{id}
put
/api/waitlist-restaurants/{id}
delete
/api/waitlist-restaurants/{id}
patch
/api/waitlist-restaurants/{id}
get
/api/websockets
post
/api/websockets
get
/api/websockets/{id}
get
/auth/abilities
post
/auth/magic-link
post
/auth/magic-link/consume
post
/auth/refresh
post
/auth/token
get
/auth/tokens
delete
/auth/tokens/{id}
get
/cms/authors
post
/cms/authors
get
/cms/authors/{id}
delete
/cms/authors/{id}
patch
/cms/authors/{id}
get
/cms/categories
post
/cms/categories
get
/cms/categories/{id}
delete
/cms/categories/{id}
patch
/cms/categories/{id}
get
/cms/comments
post
/cms/comments
get
/cms/comments/{id}
delete
/cms/comments/{id}
patch
/cms/comments/{id}
get
/cms/dashboard
get
/cms/files
get
/cms/pages
post
/cms/pages
delete
/cms/pages/{id}
patch
/cms/pages/{id}
get
/cms/posts
post
/cms/posts
get
/cms/posts/{id}
delete
/cms/posts/{id}
patch
/cms/posts/{id}
patch
/cms/posts/{id}/views
get
/cms/tags
post
/cms/tags
get
/cms/tags/{id}
delete
/cms/tags/{id}
patch
/cms/tags/{id}
get
/dashboard/activity
get
/dashboard/buddy
get
/dashboard/cms/authors
get
/dashboard/cms/categories
get
/dashboard/cms/comments
get
/dashboard/cms/pages
get
/dashboard/cms/posts
get
/dashboard/cms/tags
get
/dashboard/commerce/coupons
get
/dashboard/commerce/customers
get
/dashboard/commerce/delivery
get
/dashboard/commerce/gift-cards
get
/dashboard/commerce/orders
get
/dashboard/commerce/payments
get
/dashboard/commerce/products
get
/dashboard/commerce/reviews
get
/dashboard/commerce/taxes
get
/dashboard/health
get
/dashboard/home
get
/dashboard/services
get
/dashboard/settings
get
/dashboard/stats
get
/deployments/
post
/deployments/
get
/deployments/avg-time
get
/deployments/count
post
/deployments/preview
get
/deployments/recent
get
/deployments/script
put
/deployments/script
get
/deployments/terminal
post
/disable-two-factor
post
/enable-two-factor
get
/generate-authentication-options
get
/generate-registration-options
post
/generate-two-factor-secret
get
/infrastructure/cloud
get
/infrastructure/dns
get
/infrastructure/environment
get
/infrastructure/insights
get
/infrastructure/logs
get
/infrastructure/mailboxes
get
/infrastructure/permissions
get
/infrastructure/servers
get
/install
get
/jobs/
get
/jobs/stats
post
/jobs/{id}/retry
get
/library/components
post
/library/components
get
/library/components/downloads
get
/library/dependencies
get
/library/downloads
get
/library/functions
post
/library/functions
get
/library/functions/downloads
get
/library/packages
get
/library/releases
get
/library/releases/avg-time
get
/library/releases/count
get
/locale/{locale}
post
/login
post
/logout
post
/logout-all
get
/me
get
/models/
get
/models/subscriber-count
get
/models/user-count
post
/password/forgot
post
/password/reset
post
/password/verify-token
post
/payments/cancel-subscription/{id}
post
/payments/checkout/{id}
post
/payments/create-invoice-subscription/{id}
post
/payments/create-payment-intent/{id}
get
/payments/create-setup-intent/{id}
post
/payments/create-subscription/{id}
get
/payments/default-payment-method/{id}
delete
/payments/delete-payment-method/{id}
get
/payments/fetch-active-subscription/{id}
get
/payments/fetch-customer/{id}
get
/payments/fetch-product/{id}
get
/payments/fetch-transaction-history/{id}
get
/payments/fetch-user-subscriptions/{id}
post
/payments/payment-method/{id}
get
/payments/payment-methods/{id}
post
/payments/set-default-payment-method/{id}
post
/payments/store-transaction/{id}
patch
/payments/update-customer/{id}
put
/payments/update-default-payment-method/{id}
post
/payments/update-subscription/{id}
post
/payments/user-default-payment-method/{id}
post
/queue/retry-failed
get
/queue/stats
get
/queue/workers
get
/queues/
get
/realtime/stats
get
/realtime/websockets
post
/register
get
/releases/
get
/releases/stats
get
/robots.txt
get
/sitemap.xml
get
/test-error
get
/verify-authentication
post
/verify-registration
post
/verify-two-factor-login
post
/voide/browse
post
/voide/cancel
post
/voide/commit
post
/voide/github/connect
post
/voide/github/disconnect
post
/voide/process
post
/voide/process/stream
post
/voide/push
post
/voide/repo
post
/voide/repo/validate
get
/voide/settings
post
/voide/settings
get
/voide/state
post
/voide/title
post
/webhooks/email/mailgun
post
/webhooks/email/postmark
post
/webhooks/email/sendgrid
post
/webhooks/email/ses
/_stacks/email/unsubscribe/{token}
get
/_stacks/email/unsubscribe/{token}
Path parameters
token
string
required
Response
Successful response
object
required