Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'
const client = createAdminClient({
baseUrl: 'https://your-store.com',
secretKey: 'sk_xxx',
})
const { data: permissions } = await client.permissions.list()spree api get /permissions{
"data": [
{
"key": "read_dashboard",
"resource": "dashboard",
"kind": "read",
"group": "analytics",
"group_label": "Analytics",
"label": "Analytics dashboard",
"description": "Sales and performance analytics"
},
{
"key": "read_reports",
"resource": "reports",
"kind": "read",
"group": "analytics",
"group_label": "Analytics",
"label": "Reports",
"description": ""
},
{
"key": "write_reports",
"resource": "reports",
"kind": "write",
"group": "analytics",
"group_label": "Analytics",
"label": "Reports",
"description": ""
},
{
"key": "read_orders",
"resource": "orders",
"kind": "read",
"group": "orders",
"group_label": "Orders",
"label": "Orders",
"description": "Orders, line items, returns, exchanges and claims"
},
{
"key": "write_orders",
"resource": "orders",
"kind": "write",
"group": "orders",
"group_label": "Orders",
"label": "Orders",
"description": "Orders, line items, returns, exchanges and claims"
},
{
"key": "read_payments",
"resource": "payments",
"kind": "read",
"group": "orders",
"group_label": "Orders",
"label": "Payments",
"description": "Order payments and payment capture"
},
{
"key": "write_payments",
"resource": "payments",
"kind": "write",
"group": "orders",
"group_label": "Orders",
"label": "Payments",
"description": "Order payments and payment capture"
},
{
"key": "read_fulfillments",
"resource": "fulfillments",
"kind": "read",
"group": "orders",
"group_label": "Orders",
"label": "Fulfillments",
"description": "Pack, ship and track order fulfillments"
},
{
"key": "write_fulfillments",
"resource": "fulfillments",
"kind": "write",
"group": "orders",
"group_label": "Orders",
"label": "Fulfillments",
"description": "Pack, ship and track order fulfillments"
},
{
"key": "read_refunds",
"resource": "refunds",
"kind": "read",
"group": "orders",
"group_label": "Orders",
"label": "Refunds",
"description": "Issue and view refunds"
},
{
"key": "write_refunds",
"resource": "refunds",
"kind": "write",
"group": "orders",
"group_label": "Orders",
"label": "Refunds",
"description": "Issue and view refunds"
},
{
"key": "read_products",
"resource": "products",
"kind": "read",
"group": "catalog",
"group_label": "Catalog",
"label": "Products",
"description": "Products, variants, options, prices and media"
},
{
"key": "write_products",
"resource": "products",
"kind": "write",
"group": "catalog",
"group_label": "Catalog",
"label": "Products",
"description": "Products, variants, options, prices and media"
},
{
"key": "read_product_types",
"resource": "product_types",
"kind": "read",
"group": "catalog",
"group_label": "Catalog",
"label": "Product types",
"description": ""
},
{
"key": "write_product_types",
"resource": "product_types",
"kind": "write",
"group": "catalog",
"group_label": "Catalog",
"label": "Product types",
"description": ""
},
{
"key": "read_publishing",
"resource": "publishing",
"kind": "read",
"group": "catalog",
"group_label": "Catalog",
"label": "Publishing",
"description": ""
},
{
"key": "write_publishing",
"resource": "publishing",
"kind": "write",
"group": "catalog",
"group_label": "Catalog",
"label": "Publishing",
"description": ""
},
{
"key": "read_media",
"resource": "media",
"kind": "read",
"group": "catalog",
"group_label": "Catalog",
"label": "Media",
"description": ""
},
{
"key": "write_media",
"resource": "media",
"kind": "write",
"group": "catalog",
"group_label": "Catalog",
"label": "Media",
"description": ""
},
{
"key": "read_categories",
"resource": "categories",
"kind": "read",
"group": "catalog",
"group_label": "Catalog",
"label": "Categories",
"description": "Category tree and taxonomies"
},
{
"key": "write_categories",
"resource": "categories",
"kind": "write",
"group": "catalog",
"group_label": "Catalog",
"label": "Categories",
"description": "Category tree and taxonomies"
},
{
"key": "read_collections",
"resource": "collections",
"kind": "read",
"group": "catalog",
"group_label": "Catalog",
"label": "Collections",
"description": "Manual and rule-based product collections"
},
{
"key": "write_collections",
"resource": "collections",
"kind": "write",
"group": "catalog",
"group_label": "Catalog",
"label": "Collections",
"description": "Manual and rule-based product collections"
},
{
"key": "read_stock",
"resource": "stock",
"kind": "read",
"group": "catalog",
"group_label": "Catalog",
"label": "Inventory",
"description": "Stock levels, locations, movements and transfers"
},
{
"key": "write_stock",
"resource": "stock",
"kind": "write",
"group": "catalog",
"group_label": "Catalog",
"label": "Inventory",
"description": "Stock levels, locations, movements and transfers"
},
{
"key": "read_purchasing",
"resource": "purchasing",
"kind": "read",
"group": "catalog",
"group_label": "Catalog",
"label": "Purchasing",
"description": "Suppliers and purchase orders"
},
{
"key": "write_purchasing",
"resource": "purchasing",
"kind": "write",
"group": "catalog",
"group_label": "Catalog",
"label": "Purchasing",
"description": "Suppliers and purchase orders"
},
{
"key": "read_customers",
"resource": "customers",
"kind": "read",
"group": "customers",
"group_label": "Customers",
"label": "Customers",
"description": "Customer accounts, addresses, cards and groups"
},
{
"key": "write_customers",
"resource": "customers",
"kind": "write",
"group": "customers",
"group_label": "Customers",
"label": "Customers",
"description": "Customer accounts, addresses, cards and groups"
},
{
"key": "read_sellers",
"resource": "sellers",
"kind": "read",
"group": "sellers",
"group_label": "Sellers",
"label": "Sellers",
"description": ""
},
{
"key": "write_sellers",
"resource": "sellers",
"kind": "write",
"group": "sellers",
"group_label": "Sellers",
"label": "Sellers",
"description": ""
},
{
"key": "read_commissions",
"resource": "commissions",
"kind": "read",
"group": "sellers",
"group_label": "Sellers",
"label": "Commissions",
"description": ""
},
{
"key": "write_commissions",
"resource": "commissions",
"kind": "write",
"group": "sellers",
"group_label": "Sellers",
"label": "Commissions",
"description": ""
},
{
"key": "read_payouts",
"resource": "payouts",
"kind": "read",
"group": "sellers",
"group_label": "Sellers",
"label": "Payouts",
"description": ""
},
{
"key": "write_payouts",
"resource": "payouts",
"kind": "write",
"group": "sellers",
"group_label": "Sellers",
"label": "Payouts",
"description": ""
},
{
"key": "read_gift_cards",
"resource": "gift_cards",
"kind": "read",
"group": "loyalty",
"group_label": "Loyalty",
"label": "Gift cards",
"description": "Gift cards and gift card batches"
},
{
"key": "write_gift_cards",
"resource": "gift_cards",
"kind": "write",
"group": "loyalty",
"group_label": "Loyalty",
"label": "Gift cards",
"description": "Gift cards and gift card batches"
},
{
"key": "read_store_credits",
"resource": "store_credits",
"kind": "read",
"group": "loyalty",
"group_label": "Loyalty",
"label": "Store credits",
"description": "Customer store credit balances"
},
{
"key": "write_store_credits",
"resource": "store_credits",
"kind": "write",
"group": "loyalty",
"group_label": "Loyalty",
"label": "Store credits",
"description": "Customer store credit balances"
},
{
"key": "read_promotions",
"resource": "promotions",
"kind": "read",
"group": "marketing",
"group_label": "Marketing",
"label": "Promotions",
"description": "Promotions, rules and coupon codes"
},
{
"key": "write_promotions",
"resource": "promotions",
"kind": "write",
"group": "marketing",
"group_label": "Marketing",
"label": "Promotions",
"description": "Promotions, rules and coupon codes"
},
{
"key": "read_settings",
"resource": "settings",
"kind": "read",
"group": "settings",
"group_label": "Settings",
"label": "Store settings",
"description": "Store, payment, delivery, tax and channel configuration"
},
{
"key": "write_settings",
"resource": "settings",
"kind": "write",
"group": "settings",
"group_label": "Settings",
"label": "Store settings",
"description": "Store, payment, delivery, tax and channel configuration"
},
{
"key": "read_delivery_methods",
"resource": "delivery_methods",
"kind": "read",
"group": "settings",
"group_label": "Settings",
"label": "Delivery methods",
"description": ""
},
{
"key": "write_delivery_methods",
"resource": "delivery_methods",
"kind": "write",
"group": "settings",
"group_label": "Settings",
"label": "Delivery methods",
"description": ""
},
{
"key": "read_package_types",
"resource": "package_types",
"kind": "read",
"group": "settings",
"group_label": "Settings",
"label": "Package types",
"description": ""
},
{
"key": "write_package_types",
"resource": "package_types",
"kind": "write",
"group": "settings",
"group_label": "Settings",
"label": "Package types",
"description": ""
},
{
"key": "read_webhooks",
"resource": "webhooks",
"kind": "read",
"group": "settings",
"group_label": "Settings",
"label": "Webhooks",
"description": "Webhook endpoints and deliveries"
},
{
"key": "write_webhooks",
"resource": "webhooks",
"kind": "write",
"group": "settings",
"group_label": "Settings",
"label": "Webhooks",
"description": "Webhook endpoints and deliveries"
},
{
"key": "read_email_templates",
"resource": "email_templates",
"kind": "read",
"group": "settings",
"group_label": "Settings",
"label": "Email templates",
"description": "Customer email templates and the email layout"
},
{
"key": "write_email_templates",
"resource": "email_templates",
"kind": "write",
"group": "settings",
"group_label": "Settings",
"label": "Email templates",
"description": "Customer email templates and the email layout"
},
{
"key": "read_integrations",
"resource": "integrations",
"kind": "read",
"group": "settings",
"group_label": "Settings",
"label": "Integrations",
"description": ""
},
{
"key": "write_integrations",
"resource": "integrations",
"kind": "write",
"group": "settings",
"group_label": "Settings",
"label": "Integrations",
"description": ""
},
{
"key": "read_api_keys",
"resource": "api_keys",
"kind": "read",
"group": "access",
"group_label": "Access",
"label": "API keys",
"description": "Create and revoke API credentials"
},
{
"key": "write_api_keys",
"resource": "api_keys",
"kind": "write",
"group": "access",
"group_label": "Access",
"label": "API keys",
"description": "Create and revoke API credentials"
},
{
"key": "read_oauth_applications",
"resource": "oauth_applications",
"kind": "read",
"group": "access",
"group_label": "Access",
"label": "Oauth applications",
"description": ""
},
{
"key": "write_oauth_applications",
"resource": "oauth_applications",
"kind": "write",
"group": "access",
"group_label": "Access",
"label": "Oauth applications",
"description": ""
},
{
"key": "read_staff",
"resource": "staff",
"kind": "read",
"group": "access",
"group_label": "Access",
"label": "Staff & roles",
"description": "Team members, invitations, roles and their permissions"
},
{
"key": "write_staff",
"resource": "staff",
"kind": "write",
"group": "access",
"group_label": "Access",
"label": "Staff & roles",
"description": "Team members, invitations, roles and their permissions"
}
],
"meta": {
"count": 59
}
}List the permission catalog
Returns the permission catalog — the grant vocabulary shared by staff role permissions and secret API key scopes. Entries are grouped for permission pickers; labels and descriptions are localized. Readable by any authenticated admin credential.
GET
/
api
/
v3
/
admin
/
permissions
Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'
const client = createAdminClient({
baseUrl: 'https://your-store.com',
secretKey: 'sk_xxx',
})
const { data: permissions } = await client.permissions.list()spree api get /permissions{
"data": [
{
"key": "read_dashboard",
"resource": "dashboard",
"kind": "read",
"group": "analytics",
"group_label": "Analytics",
"label": "Analytics dashboard",
"description": "Sales and performance analytics"
},
{
"key": "read_reports",
"resource": "reports",
"kind": "read",
"group": "analytics",
"group_label": "Analytics",
"label": "Reports",
"description": ""
},
{
"key": "write_reports",
"resource": "reports",
"kind": "write",
"group": "analytics",
"group_label": "Analytics",
"label": "Reports",
"description": ""
},
{
"key": "read_orders",
"resource": "orders",
"kind": "read",
"group": "orders",
"group_label": "Orders",
"label": "Orders",
"description": "Orders, line items, returns, exchanges and claims"
},
{
"key": "write_orders",
"resource": "orders",
"kind": "write",
"group": "orders",
"group_label": "Orders",
"label": "Orders",
"description": "Orders, line items, returns, exchanges and claims"
},
{
"key": "read_payments",
"resource": "payments",
"kind": "read",
"group": "orders",
"group_label": "Orders",
"label": "Payments",
"description": "Order payments and payment capture"
},
{
"key": "write_payments",
"resource": "payments",
"kind": "write",
"group": "orders",
"group_label": "Orders",
"label": "Payments",
"description": "Order payments and payment capture"
},
{
"key": "read_fulfillments",
"resource": "fulfillments",
"kind": "read",
"group": "orders",
"group_label": "Orders",
"label": "Fulfillments",
"description": "Pack, ship and track order fulfillments"
},
{
"key": "write_fulfillments",
"resource": "fulfillments",
"kind": "write",
"group": "orders",
"group_label": "Orders",
"label": "Fulfillments",
"description": "Pack, ship and track order fulfillments"
},
{
"key": "read_refunds",
"resource": "refunds",
"kind": "read",
"group": "orders",
"group_label": "Orders",
"label": "Refunds",
"description": "Issue and view refunds"
},
{
"key": "write_refunds",
"resource": "refunds",
"kind": "write",
"group": "orders",
"group_label": "Orders",
"label": "Refunds",
"description": "Issue and view refunds"
},
{
"key": "read_products",
"resource": "products",
"kind": "read",
"group": "catalog",
"group_label": "Catalog",
"label": "Products",
"description": "Products, variants, options, prices and media"
},
{
"key": "write_products",
"resource": "products",
"kind": "write",
"group": "catalog",
"group_label": "Catalog",
"label": "Products",
"description": "Products, variants, options, prices and media"
},
{
"key": "read_product_types",
"resource": "product_types",
"kind": "read",
"group": "catalog",
"group_label": "Catalog",
"label": "Product types",
"description": ""
},
{
"key": "write_product_types",
"resource": "product_types",
"kind": "write",
"group": "catalog",
"group_label": "Catalog",
"label": "Product types",
"description": ""
},
{
"key": "read_publishing",
"resource": "publishing",
"kind": "read",
"group": "catalog",
"group_label": "Catalog",
"label": "Publishing",
"description": ""
},
{
"key": "write_publishing",
"resource": "publishing",
"kind": "write",
"group": "catalog",
"group_label": "Catalog",
"label": "Publishing",
"description": ""
},
{
"key": "read_media",
"resource": "media",
"kind": "read",
"group": "catalog",
"group_label": "Catalog",
"label": "Media",
"description": ""
},
{
"key": "write_media",
"resource": "media",
"kind": "write",
"group": "catalog",
"group_label": "Catalog",
"label": "Media",
"description": ""
},
{
"key": "read_categories",
"resource": "categories",
"kind": "read",
"group": "catalog",
"group_label": "Catalog",
"label": "Categories",
"description": "Category tree and taxonomies"
},
{
"key": "write_categories",
"resource": "categories",
"kind": "write",
"group": "catalog",
"group_label": "Catalog",
"label": "Categories",
"description": "Category tree and taxonomies"
},
{
"key": "read_collections",
"resource": "collections",
"kind": "read",
"group": "catalog",
"group_label": "Catalog",
"label": "Collections",
"description": "Manual and rule-based product collections"
},
{
"key": "write_collections",
"resource": "collections",
"kind": "write",
"group": "catalog",
"group_label": "Catalog",
"label": "Collections",
"description": "Manual and rule-based product collections"
},
{
"key": "read_stock",
"resource": "stock",
"kind": "read",
"group": "catalog",
"group_label": "Catalog",
"label": "Inventory",
"description": "Stock levels, locations, movements and transfers"
},
{
"key": "write_stock",
"resource": "stock",
"kind": "write",
"group": "catalog",
"group_label": "Catalog",
"label": "Inventory",
"description": "Stock levels, locations, movements and transfers"
},
{
"key": "read_purchasing",
"resource": "purchasing",
"kind": "read",
"group": "catalog",
"group_label": "Catalog",
"label": "Purchasing",
"description": "Suppliers and purchase orders"
},
{
"key": "write_purchasing",
"resource": "purchasing",
"kind": "write",
"group": "catalog",
"group_label": "Catalog",
"label": "Purchasing",
"description": "Suppliers and purchase orders"
},
{
"key": "read_customers",
"resource": "customers",
"kind": "read",
"group": "customers",
"group_label": "Customers",
"label": "Customers",
"description": "Customer accounts, addresses, cards and groups"
},
{
"key": "write_customers",
"resource": "customers",
"kind": "write",
"group": "customers",
"group_label": "Customers",
"label": "Customers",
"description": "Customer accounts, addresses, cards and groups"
},
{
"key": "read_sellers",
"resource": "sellers",
"kind": "read",
"group": "sellers",
"group_label": "Sellers",
"label": "Sellers",
"description": ""
},
{
"key": "write_sellers",
"resource": "sellers",
"kind": "write",
"group": "sellers",
"group_label": "Sellers",
"label": "Sellers",
"description": ""
},
{
"key": "read_commissions",
"resource": "commissions",
"kind": "read",
"group": "sellers",
"group_label": "Sellers",
"label": "Commissions",
"description": ""
},
{
"key": "write_commissions",
"resource": "commissions",
"kind": "write",
"group": "sellers",
"group_label": "Sellers",
"label": "Commissions",
"description": ""
},
{
"key": "read_payouts",
"resource": "payouts",
"kind": "read",
"group": "sellers",
"group_label": "Sellers",
"label": "Payouts",
"description": ""
},
{
"key": "write_payouts",
"resource": "payouts",
"kind": "write",
"group": "sellers",
"group_label": "Sellers",
"label": "Payouts",
"description": ""
},
{
"key": "read_gift_cards",
"resource": "gift_cards",
"kind": "read",
"group": "loyalty",
"group_label": "Loyalty",
"label": "Gift cards",
"description": "Gift cards and gift card batches"
},
{
"key": "write_gift_cards",
"resource": "gift_cards",
"kind": "write",
"group": "loyalty",
"group_label": "Loyalty",
"label": "Gift cards",
"description": "Gift cards and gift card batches"
},
{
"key": "read_store_credits",
"resource": "store_credits",
"kind": "read",
"group": "loyalty",
"group_label": "Loyalty",
"label": "Store credits",
"description": "Customer store credit balances"
},
{
"key": "write_store_credits",
"resource": "store_credits",
"kind": "write",
"group": "loyalty",
"group_label": "Loyalty",
"label": "Store credits",
"description": "Customer store credit balances"
},
{
"key": "read_promotions",
"resource": "promotions",
"kind": "read",
"group": "marketing",
"group_label": "Marketing",
"label": "Promotions",
"description": "Promotions, rules and coupon codes"
},
{
"key": "write_promotions",
"resource": "promotions",
"kind": "write",
"group": "marketing",
"group_label": "Marketing",
"label": "Promotions",
"description": "Promotions, rules and coupon codes"
},
{
"key": "read_settings",
"resource": "settings",
"kind": "read",
"group": "settings",
"group_label": "Settings",
"label": "Store settings",
"description": "Store, payment, delivery, tax and channel configuration"
},
{
"key": "write_settings",
"resource": "settings",
"kind": "write",
"group": "settings",
"group_label": "Settings",
"label": "Store settings",
"description": "Store, payment, delivery, tax and channel configuration"
},
{
"key": "read_delivery_methods",
"resource": "delivery_methods",
"kind": "read",
"group": "settings",
"group_label": "Settings",
"label": "Delivery methods",
"description": ""
},
{
"key": "write_delivery_methods",
"resource": "delivery_methods",
"kind": "write",
"group": "settings",
"group_label": "Settings",
"label": "Delivery methods",
"description": ""
},
{
"key": "read_package_types",
"resource": "package_types",
"kind": "read",
"group": "settings",
"group_label": "Settings",
"label": "Package types",
"description": ""
},
{
"key": "write_package_types",
"resource": "package_types",
"kind": "write",
"group": "settings",
"group_label": "Settings",
"label": "Package types",
"description": ""
},
{
"key": "read_webhooks",
"resource": "webhooks",
"kind": "read",
"group": "settings",
"group_label": "Settings",
"label": "Webhooks",
"description": "Webhook endpoints and deliveries"
},
{
"key": "write_webhooks",
"resource": "webhooks",
"kind": "write",
"group": "settings",
"group_label": "Settings",
"label": "Webhooks",
"description": "Webhook endpoints and deliveries"
},
{
"key": "read_email_templates",
"resource": "email_templates",
"kind": "read",
"group": "settings",
"group_label": "Settings",
"label": "Email templates",
"description": "Customer email templates and the email layout"
},
{
"key": "write_email_templates",
"resource": "email_templates",
"kind": "write",
"group": "settings",
"group_label": "Settings",
"label": "Email templates",
"description": "Customer email templates and the email layout"
},
{
"key": "read_integrations",
"resource": "integrations",
"kind": "read",
"group": "settings",
"group_label": "Settings",
"label": "Integrations",
"description": ""
},
{
"key": "write_integrations",
"resource": "integrations",
"kind": "write",
"group": "settings",
"group_label": "Settings",
"label": "Integrations",
"description": ""
},
{
"key": "read_api_keys",
"resource": "api_keys",
"kind": "read",
"group": "access",
"group_label": "Access",
"label": "API keys",
"description": "Create and revoke API credentials"
},
{
"key": "write_api_keys",
"resource": "api_keys",
"kind": "write",
"group": "access",
"group_label": "Access",
"label": "API keys",
"description": "Create and revoke API credentials"
},
{
"key": "read_oauth_applications",
"resource": "oauth_applications",
"kind": "read",
"group": "access",
"group_label": "Access",
"label": "Oauth applications",
"description": ""
},
{
"key": "write_oauth_applications",
"resource": "oauth_applications",
"kind": "write",
"group": "access",
"group_label": "Access",
"label": "Oauth applications",
"description": ""
},
{
"key": "read_staff",
"resource": "staff",
"kind": "read",
"group": "access",
"group_label": "Access",
"label": "Staff & roles",
"description": "Team members, invitations, roles and their permissions"
},
{
"key": "write_staff",
"resource": "staff",
"kind": "write",
"group": "access",
"group_label": "Access",
"label": "Staff & roles",
"description": "Team members, invitations, roles and their permissions"
}
],
"meta": {
"count": 59
}
}Was this page helpful?
⌘I

