Scopes Reference

API keys carry scopes — pairs of a resource and allowed actions (READ, WRITE, UPDATE, DELETE). Each endpoint requires exactly one (resource, action) pair; requests from keys without it fail with 403 INSUFFICIENT_SCOPE.

Actions map to HTTP methods: READ → GET, WRITE → POST (create), UPDATE → PATCH/PUT, DELETE → DELETE. A few POST endpoints that only read data (e.g. segment previews) require READ.

This page is generated from the API source — it lists every endpoint enforcing a scope check.

ANALYTICS

Analytics queries (KPIs, funnels, attribution, cohorts, realtime) and dashboard widget configuration

Method	Path	Required action
GET	/analytics-dashboard/available-widgets	READ
GET	/analytics-dashboard/config	READ
POST	/analytics-dashboard/reset	WRITE
PATCH	/analytics-dashboard/settings	WRITE
POST	/analytics-dashboard/widgets	WRITE
PUT	/analytics-dashboard/widgets	WRITE
DELETE	/analytics-dashboard/widgets/{widgetId}	DELETE
PATCH	/analytics-dashboard/widgets/{widgetId}	WRITE
PATCH	/analytics-dashboard/widgets/reorder	WRITE
GET	/analytics/badges	READ
GET	/analytics/chart-types	READ
GET	/analytics/cohorts	READ
GET	/analytics/devices	READ
GET	/analytics/funnel	READ
GET	/analytics/geography	READ
GET	/analytics/kpis	READ
GET	/analytics/kpis/timeseries	READ
GET	/analytics/marketing	READ
GET	/analytics/metrics	READ
GET	/analytics/products	READ
GET	/analytics/products/{productId}/metrics	READ
GET	/analytics/products/top	READ
GET	/analytics/realtime	READ
GET	/analytics/realtime/summary	READ
GET	/analytics/sales-breakdown	READ
GET	/analytics/sales-by-channel	READ
GET	/analytics/sales-by-referrer	READ
GET	/analytics/search	READ
GET	/analytics/sessions-by-referrer	READ

API_KEYS

Manage API keys themselves (create, rotate, revoke)

Method	Path	Required action
GET	/api-key	READ
POST	/api-key	WRITE
DELETE	/api-key/{keyId}	DELETE
GET	/api-key/{keyId}	READ
PATCH	/api-key/{keyId}	UPDATE
POST	/api-key/{keyId}/revoke	UPDATE
POST	/api-key/{keyId}/rotate	WRITE
GET	/api-key/stats	READ

CATEGORIES

Product categories and subcategories

Method	Path	Required action
POST	/category	WRITE
DELETE	/category/{categoryId}	DELETE
PATCH	/category/{categoryId}	UPDATE
GET	/category/export	READ
POST	/subcategories	WRITE
DELETE	/subcategories/{id}	DELETE
PATCH	/subcategories/{id}	UPDATE

CUSTOMERS

Customer profiles, addresses, comments, exports

Method	Path	Required action
GET	/customer	READ
POST	/customer	WRITE
DELETE	/customer/{customerId}	DELETE
GET	/customer/{customerId}	READ
PATCH	/customer/{customerId}	UPDATE
POST	/customer/{customerId}/address	WRITE
DELETE	/customer/{customerId}/address/{addressId}	DELETE
PATCH	/customer/{customerId}/address/{addressId}	UPDATE
POST	/customer/{customerId}/comment	WRITE
POST	/customer/export	WRITE

DOMAINS

Custom domain management

Method	Path	Required action
GET	/store/integrate/domain	READ
POST	/store/integrate/domain	WRITE
DELETE	/store/integrate/domain/{domainId}	DELETE

MARKETING

Automations, templates, abandoned carts, AI generation, connectors

Method	Path	Required action
GET	/abandoned-carts	READ
GET	/abandoned-carts/{cartId}	READ
POST	/abandoned-carts/{cartId}/recover	UPDATE
GET	/abandoned-carts/stats	READ
POST	/ai/generate	WRITE
GET	/ai/quota	READ
GET	/ai/summary	READ
GET	/automations	READ
POST	/automations	WRITE
DELETE	/automations/{id}	DELETE
GET	/automations/{id}	READ
PATCH	/automations/{id}	UPDATE
POST	/automations/{id}/activate	UPDATE
GET	/automations/{id}/click-breakdown	READ
GET	/automations/{id}/logs	READ
POST	/automations/{id}/pause	UPDATE
GET	/automations/{id}/stats	READ
GET	/connectors/marketing	READ
POST	/connectors/marketing/{type}/test	WRITE
GET	/marketing/overview	READ
GET	/marketing/overview/automations	READ
GET	/marketing/overview/reviews	READ
GET	/store/marketing	READ
PATCH	/store/marketing	UPDATE
GET	/templates	READ
POST	/templates	WRITE
DELETE	/templates/{templateId}	DELETE
GET	/templates/{templateId}	READ
PUT	/templates/{templateId}	UPDATE
POST	/templates/{templateId}/duplicate	WRITE
GET	/templates/{templateId}/mappings	READ
GET	/templates/{templateId}/mappings/{connectorType}	READ
PUT	/templates/{templateId}/mappings/{connectorType}	WRITE
PATCH	/templates/{templateId}/mappings/{connectorType}/toggle	UPDATE
POST	/templates/{templateId}/mappings/{connectorType}/validate	READ
POST	/templates/{templateId}/preview	READ
POST	/templates/{templateId}/test-send	WRITE
POST	/templates/connectors/whatsapp/sync	WRITE
GET	/templates/content-slots	READ
GET	/templates/stats	READ
GET	/templates/usage	READ
GET	/templates/usage/{category}	READ
PUT	/templates/usage/{category}	WRITE
PATCH	/templates/usage/{category}/toggle	UPDATE
GET	/templates/variables	READ
GET	/templates/variables/{source}	READ

ORDERS

Full order lifecycle: drafts, fulfillment, returns, exports, digital delivery

Method	Path	Required action
PATCH	/order/{orderId}	UPDATE
POST	/order/{orderId}/comments	WRITE
DELETE	/order/{orderId}/comments/{commentId}	DELETE
PATCH	/order/{orderId}/comments/{commentId}	UPDATE
PATCH	/order/{orderId}/items	UPDATE
POST	/order/{orderId}/payment/send-invoice	WRITE
GET	/order/{orderId}/returns	READ
POST	/order/{orderId}/returns	WRITE
POST	/order/{orderId}/returns/cancel	WRITE
POST	/order/{orderId}/returns/refund	WRITE
POST	/order/{orderId}/returns/restock	WRITE
DELETE	/order/{orderId}/tags	DELETE
POST	/order/{orderId}/tags	WRITE
GET	/order/abandoned-checkouts	READ
GET	/order/abandoned-checkouts/{checkoutId}	READ
POST	/order/abandoned-checkouts/{checkoutId}/convert	WRITE
POST	/order/collect-payment/{orderId}	WRITE
GET	/order/details/{orderId}	READ
GET	/order/details/{orderId}/journey	READ
GET	/order/draft	READ
POST	/order/draft	WRITE
DELETE	/order/draft/{draftId}	DELETE
GET	/order/draft/{draftId}	READ
PATCH	/order/draft/{draftId}	UPDATE
POST	/order/draft/{draftId}/complete	WRITE
POST	/order/export	WRITE
POST	/order/export-jobs/{id}/disable	UPDATE
POST	/order/export-jobs/{id}/enable	UPDATE
POST	/order/export-jobs/{id}/run	WRITE
GET	/order/export-jobs/{id}/runs	READ
POST	/order/fulfillment-hold/{orderId}	WRITE
POST	/order/fulfillment/{orderId}	WRITE
POST	/order/fulfillment/{orderId}/cancel/{fulfillmentId}	WRITE
POST	/order/fulfillment/{orderId}/edit-tracking	WRITE
GET	/order/metrics	READ
POST	/order/packing-slip/{orderId}	WRITE
GET	/order/tags	READ
POST	/order/vendor/{orderId}/resend-download	WRITE
POST	/order/vendor/{orderId}/restore-downloads	WRITE
POST	/order/vendor/{orderId}/revoke-downloads	WRITE
POST	/order/vendor/archive/{orderId}	WRITE
POST	/order/vendor/cancel/{orderId}	WRITE
POST	/order/vendor/create	WRITE
POST	/order/vendor/refund/{orderId}	WRITE
GET	/order/views	READ
POST	/order/views	WRITE
DELETE	/order/views/{viewId}	DELETE
PATCH	/order/views/{viewId}	UPDATE

PRODUCTS

Products, imports, exports

Method	Path	Required action
GET	/product	READ
POST	/product	WRITE
POST	/product-import/{platform}	WRITE
POST	/product-import/easyorders/api	WRITE
DELETE	/product/{id}	DELETE
PATCH	/product/{id}	UPDATE
GET	/product/{idOrSlug}	READ
GET	/product/export	READ
POST	/product/import	WRITE
GET	/product/import/template	READ
GET	/product/product-types	READ
GET	/product/tags	READ

REVIEWS

Product reviews, moderation, settings

Method	Path	Required action
GET	/review	READ
DELETE	/review/{reviewId}	DELETE
GET	/review/{reviewId}	READ
PATCH	/review/{reviewId}	UPDATE
PATCH	/review/{reviewId}/moderate	UPDATE
POST	/review/{reviewId}/reply	UPDATE
GET	/review/analytics	READ
GET	/review/export	READ
POST	/review/request-manual	UPDATE
GET	/review/settings	READ
PUT	/review/settings	UPDATE

SEGMENTS

Customer segments, membership, exports, segment analytics

Method	Path	Required action
GET	/segments	READ
POST	/segments	WRITE
DELETE	/segments/{id}	DELETE
GET	/segments/{id}	READ
PATCH	/segments/{id}	UPDATE
POST	/segments/{id}/activate	UPDATE
GET	/segments/{id}/analytics/categories	READ
GET	/segments/{id}/analytics/geography	READ
GET	/segments/{id}/analytics/overview	READ
GET	/segments/{id}/analytics/products	READ
POST	/segments/{id}/explain	READ
POST	/segments/{id}/export	WRITE
GET	/segments/{id}/history	READ
GET	/segments/{id}/members	READ
POST	/segments/{id}/pause	UPDATE
POST	/segments/{id}/refresh	UPDATE
GET	/segments/exports	READ
GET	/segments/exports/{jobId}	READ
GET	/segments/field-options/{field}	READ
POST	/segments/preview	READ

STAFF

Staff member management

Method	Path	Required action
GET	/staff	READ
POST	/staff	WRITE
DELETE	/staff/{userId}	DELETE
GET	/staff/{userId}	READ
PATCH	/staff/{userId}	UPDATE
GET	/staff/export	READ

STORE_SETTINGS

Store configuration and country rules

Method	Path	Required action
PATCH	/store	UPDATE
POST	/store/additional	WRITE
GET	/store/countries	READ
POST	/store/countries	WRITE
DELETE	/store/countries/{countryId}	DELETE
PATCH	/store/countries/{countryId}	UPDATE
PATCH	/store/countries/{countryId}/toggle	UPDATE
PATCH	/store/countries/bulk	UPDATE
GET	/store/own	READ

THEME

Theme settings

Method	Path	Required action
GET	/store/themes	READ
PATCH	/store/themes	UPDATE

Resources without API endpoints yet

The scope model also defines BILLING, BLOGS, COUPONS, DISCOUNTS, INTEGRATION, SECRETS, SUPPORT, and UPSELLS. Endpoints for these resources are not part of the public API surface yet; granting them currently has no effect.