List Product Attributes

GET

admin

product-attributes

curl 'http://localhost:9000/admin/product-attributes?type=single_select&limit=20' \
  -H 'Authorization: Bearer <token>'

const { product_attributes, count } = await client.admin.productAttributes.query({
  type: "single_select",
  limit: 20,
})

{
  "product_attributes": [
    {
      "id": "pattr_01HXYZABCDEF",
      "name": "Material",
      "handle": "material",
      "type": "single_select",
      "is_required": false,
      "is_filterable": true,
      "is_variant_axis": false,
      "is_active": true,
      "values": [
        { "id": "pattrval_01HXYZABCDEF", "name": "Linen", "rank": 0 }
      ]
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

Returns global (non-product-scoped) attributes, with optional filtering by type, flags, and category.

Query parameters

number

default:"50"

Maximum number of records to return.

number

default:"0"

Number of records to skip.

string

Field to sort by, prefix with - for descending order.

string

Comma-separated list of fields to include, prefix with +/- to add or remove from defaults.

string

Search term matched against attribute fields.

string | string[]

Filter by attribute ID(s).

string | string[]

Filter by attribute handle(s).

string | string[]

Filter by type: single_select, multi_select, unit, toggle, or text.

boolean

Filter by the required flag.

boolean

Filter by the variant-axis flag.

boolean

Filter by the filterable flag.

boolean

Filter by the active flag.

string | string[]

Filter to attributes linked to the given category(ies) or global to all categories.

object

Filter by creation date with operators like $gte, $lte.

object

Filter by update date with operators like $gte, $lte.

Response

object[]

Show properties

string

The attribute’s ID.

string

Attribute name.

string

Unique URL-safe handle.

string

Attribute description.

string

One of single_select, multi_select, unit, toggle, text.

boolean

Whether a value is required on products.

boolean

Whether the attribute can be used as a storefront filter.

boolean

Whether the attribute drives variant generation.

boolean

Whether the attribute is active.

string

ID of the actor who created the attribute.

string

Always null for catalog attributes.

number

Sort rank of the attribute.

object[]

The attribute’s values.

object[]

Linked categories with id, name, and handle.

object

Custom key-value data.

string

Creation timestamp.

string

Last update timestamp.

number

Total number of matching attributes.

number

Number of records skipped.

number

Number of records returned.

curl 'http://localhost:9000/admin/product-attributes?type=single_select&limit=20' \
  -H 'Authorization: Bearer <token>'

const { product_attributes, count } = await client.admin.productAttributes.query({
  type: "single_select",
  limit: 20,
})

{
  "product_attributes": [
    {
      "id": "pattr_01HXYZABCDEF",
      "name": "Material",
      "handle": "material",
      "type": "single_select",
      "is_required": false,
      "is_filterable": true,
      "is_variant_axis": false,
      "is_active": true,
      "values": [
        { "id": "pattrval_01HXYZABCDEF", "name": "Linen", "rank": 0 }
      ]
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

curl 'http://localhost:9000/admin/product-attributes?type=single_select&limit=20' \
  -H 'Authorization: Bearer <token>'

const { product_attributes, count } = await client.admin.productAttributes.query({
  type: "single_select",
  limit: 20,
})

{
  "product_attributes": [
    {
      "id": "pattr_01HXYZABCDEF",
      "name": "Material",
      "handle": "material",
      "type": "single_select",
      "is_required": false,
      "is_filterable": true,
      "is_variant_axis": false,
      "is_active": true,
      "values": [
        { "id": "pattrval_01HXYZABCDEF", "name": "Linen", "rank": 0 }
      ]
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 20
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Query parameters

Response

​Query parameters

​Response

Query parameters

Response