Skip to main content
GET
/
api
/
v1
/
{team_slug}
/
{app_slug}
/
tags
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "attributes": [
        {
          "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>",
                "value": "<string>"
              }
            ],
            "name": [
              {
                "id": "<string>",
                "locale": "<string>",
                "value": "<string>"
              }
            ]
          },
          "updated_at": "<string>",
          "values": {}
        }
      ],
      "created_at": "<string>",
      "filterable": true,
      "id": "<string>",
      "key": "<string>",
      "markets": [
        {
          "active": true,
          "country_codes": [
            "<string>"
          ],
          "created_at": "<string>",
          "currency_code": "<string>",
          "id": "<string>",
          "locale": "<string>",
          "name": "<string>",
          "slug": "<string>",
          "updated_at": "<string>"
        }
      ],
      "name": "<string>",
      "schedules": [
        {
          "add_category_names": [
            "<string>"
          ],
          "add_collection_names": [
            "<string>"
          ],
          "add_tag_names": [
            "<string>"
          ],
          "execute_at": "<string>",
          "finished_at": "<string>",
          "id": "<string>",
          "item_id": "<string>",
          "item_name": "<string>",
          "item_type": "<string>",
          "remove_category_names": [
            "<string>"
          ],
          "remove_collection_names": [
            "<string>"
          ],
          "remove_tag_names": [
            "<string>"
          ],
          "to_amount_cents_with_tax": 123,
          "to_market_id": "<string>",
          "to_market_status": "<string>",
          "to_on_sale": true,
          "to_sale_amount_cents_with_tax": 123,
          "to_start_sale_timestamp": "<string>",
          "to_status": "<string>",
          "to_stop_sale_timestamp": "<string>",
          "to_store_group_id": "<string>"
        }
      ],
      "source_app_id": "<string>",
      "source_id": "<string>",
      "status": "<string>",
      "translations": {
        "name": [
          {
            "id": "<string>",
            "locale": "<string>",
            "value": "<string>"
          }
        ]
      },
      "updated_at": "<string>"
    }
  ],
  "success": true,
  "total": 123,
  "total_pages": 123
}

Path Parameters

​
app_slug
string
required

App slug

​
team_slug
string
required

Team slug

Query Parameters

​
search
string

Search on tags name

​
page
integer

Page number (default is 1)

​
per-page
integer

Amount of products per page. Minimum 0 and max 100 (default is 20)

​
id
string[]

Filter by tag IDs (can be repeated)

​
status
string[]

Filter by status. Allowed values: active, inactive, archived, draft

Response

List of tags with full details

​
data
object[]
​
success
boolean
​
total
integer
​
total_pages
integer