Skip to main content
GET
/
api
/
v1
/
:team_slug
/
:app_slug
/
attributes
/
values
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "created_at": "<string>",
      "description": "<string>",
      "filterable": true,
      "id": "<string>",
      "key": "<string>",
      "name": "<string>",
      "template_key": "<string>",
      "template_name": "<string>",
      "translatable": true,
      "translations": {
        "description": [
          {
            "id": "<string>",
            "locale": "<string>",
            "omni_channel_translations": [
              {
                "id": "<string>",
                "market_id": "<string>",
                "store_group_id": "<string>",
                "value": "<string>"
              }
            ],
            "value": "<string>"
          }
        ],
        "name": [
          {
            "id": "<string>",
            "locale": "<string>",
            "omni_channel_translations": [
              {
                "id": "<string>",
                "market_id": "<string>",
                "store_group_id": "<string>",
                "value": "<string>"
              }
            ],
            "value": "<string>"
          }
        ]
      },
      "updated_at": "<string>",
      "values": {}
    }
  ],
  "success": true,
  "total": 123,
  "total_pages": 123
}

Path Parameters

app_slug
string
required

App slug

team_slug
string
required

Team slug

Query Parameters

template_key
string[]

Filter attributes by template keys (e.g., template_key=color&template_key=size)

Search term to filter attributes by name

sort-order
string

Sort order. Should be one of ASC or DESC. Default DESC

sort-key
string

The key to sort on. Can be one of name, created_at, updated_at, key. Default created_at

page
integer

Page number (default is 1)

per-page
integer

Amount of attributes per page. Minimum 1 and max 100 (default is 20)

Response

A list of attributes with pagination details

data
object[]
success
boolean
total
integer
total_pages
integer