> ## Documentation Index > Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml /api-reference/admin.yaml get /api/v3/admin/permissions openapi: 3.0.3 info: title: Admin API contact: name: Spree Commerce url: https://spreecommerce.org email: hello@spreecommerce.org description: > Spree Admin API v3 - Administrative API for managing products, orders, and store settings. ## Authentication The Admin API requires a secret API key passed in the `x-spree-api-key` header. Secret API keys can be generated in the Spree admin dashboard. ## Response Format All responses are JSON. List endpoints return paginated responses with `data` and `meta` keys. Single resource endpoints return a flat JSON object. ## Resource IDs Every resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`, `variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths, request bodies, and Ransack filters all accept them directly. ## Error Handling Errors return a consistent format: ```json { "error": { "code": "validation_error", "message": "Validation failed", "details": { "name": ["can't be blank"] } } } ``` version: v3 servers: - url: http://{defaultHost} variables: defaultHost: default: localhost:3000 security: [] tags: - name: Authentication description: Admin user login, logout, token refresh, and current user profile - name: Allowed Origins description: CORS allowlist for storefront and admin client origins - name: API Keys description: Secret and publishable API keys - name: Categories description: >- Hierarchical product categories — tree management, repositioning, and product assignments - name: Channels description: >- Sales channels, product publication across channels, and per-channel order routing rules - name: Custom Fields description: >- Custom field definitions for products, variants, customers, and other resources - name: Customer Groups description: >- Customer groups for segmenting customers (e.g. wholesale, VIP) used by pricing and promotions - name: Customers description: Customer profiles, addresses, credit cards, and store credits - name: Email Templates description: >- Customer email templates, the email layout and shared partials: drafts, previews, publishing and history - name: Exports description: Async CSV exports of admin resources - name: Files description: Uploading the files that product media, imports, logos and documents use - name: Fulfillments description: Order fulfillments — shipments, fulfill, cancel, resume, split - name: Gift Cards description: Gift cards and gift card batches - name: Imports description: >- Async CSV imports of admin resources, with per-row status and failed-row retry - name: Markets description: >- Markets — geographic groupings of countries used for pricing, tax, and fulfillment rules - name: Option Types description: >- Option types and option values used to build product variants (e.g. Size, Color) - name: Orders description: Orders, order items, applied gift cards, and applied store credits - name: Payment Methods description: Configured payment providers and their available types - name: Payments description: Order payments — list, capture, void - name: Pricing description: >- Prices and price lists for currency-, market-, and customer-group-specific pricing - name: Products description: >- Products, taxons/categories, product custom field values, and bulk product operations - name: Policies description: The store's legal documents — terms of service, privacy, returns, shipping - name: Reasons description: >- Merchant-owned vocabularies for why a return, claim, refund, cancellation or tax exemption happened - name: Promotions description: Promotions, promotion rules, promotion actions, and coupon codes - name: Refunds description: Order refunds - name: Settings description: Store-level settings — store profile, tags, and configuration - name: Staff description: Admin users, roles, and invitations to the store - name: Stock Locations description: Warehouses and physical fulfillment locations - name: Store Credits description: Prepaid customer balances across all customers, and each balance's ledger - name: Variants description: >- Product variants — the individual SKUs (size/color combinations) sold under a product - name: Webhooks description: Webhook endpoints and webhook delivery history paths: /api/v3/admin/permissions: get: tags: - Staff summary: List the permission catalog description: >- 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. parameters: - name: x-spree-api-key in: header required: true schema: type: string - name: Authorization in: header required: true schema: type: string responses: '200': description: catalog returned content: application/json: example: 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 security: - api_key: [] bearer_auth: [] x-codeSamples: - lang: javascript label: Spree Admin SDK source: |- import { createAdminClient } from '@spree/admin-sdk' const client = createAdminClient({ baseUrl: 'https://your-store.com', secretKey: 'sk_xxx', }) const { data: permissions } = await client.permissions.list() - lang: bash label: Spree CLI source: spree api get /permissions components: securitySchemes: api_key: type: apiKey name: x-spree-api-key in: header description: Secret API key for admin access bearer_auth: type: http scheme: bearer bearerFormat: JWT description: JWT token for admin user authentication ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.