GET
/
admin
/
attributes
{
  "attributes": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "handle": "<string>",
      "is_filterable": true,
      "ui_component": "select",
      "metadata": {},
      "possible_values": [
        {
          "id": "<string>",
          "value": "<string>",
          "rank": 123,
          "metadata": {},
          "created_at": "2023-11-07T05:31:56Z"
        }
      ],
      "values": [
        {
          "id": "<string>",
          "value": "<string>"
        }
      ],
      "product_categories": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ],
  "count": 123,
  "offset": 123,
  "limit": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

offset
number

The number of items to skip before starting to collect the result set.

limit
number

The number of items to return.

fields
string

Comma-separated fields to include in the response.

id
string

Filter by attribute ID.

name
string

Filter by attribute name.

handle
string

Filter by attribute handle.

is_global
boolean

Filter for global attributes (not assigned to any category).

ui_component
enum<string>

Filter by UI component type.

Available options:
select,
multivalue,
unit,
toggle,
text_area,
color_picker
created_at
object

Filter by creation date using operators.

updated_at
object

Filter by update date using operators.

deleted_at
object

Filter by deletion date using operators.

Response

200 - application/json

OK

attributes
Attribute · object[]
count
integer

The total number of items available

offset
integer

The number of items skipped before these items

limit
integer

The number of items per page