Skip to main content
GET
/
api
/
v3
/
admin
/
tags
Spree Admin SDK
import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const { data: tags } = await client.tags.list({
  taggable_type: 'Spree::User',
  q: 'vip',
})
{
  "data": [
    {
      "name": "vip"
    },
    {
      "name": "wholesale"
    }
  ]
}

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.

Authorizations

​
x-spree-api-key
string
header
required

Secret API key for admin access

​
Authorization
string
header
required

JWT token for admin user authentication

Headers

​
x-spree-api-key
string
required
​
Authorization
string
required

Query Parameters

​
taggable_type
string
required

Taggable type (Spree::Product, Spree::Order, or Spree::User)

​
q
string

Optional case-insensitive substring filter

Response

tags found