Skip to main content
GET
/
partner
/
tags
curl https://api.thanxsandbox.com/partner/tags \
  -X GET \
  -H 'X-ClientId: {client_id}' \
  -H 'Accept-Version: v4.0' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access_token}' \

{
  "tags": [
    {
      "id": "92b7b0dac4",
      "user_id": "wroeiu2304hfwf",
      "merchant_id": "weroif",
      "key": "allergens",
      "values": ["gluten", "soy", "dairy"]
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "total_pages": 1
  }
}
Scope required: tags.read
This endpoint returns paginated tags for the specified users.

​
Parameters

​
merchant_id
string
required
Filter tags by Merchant ID
​
user_ids
array<string>
required
Filter tags by User IDs
​
key
string
Optionally filter tags by key
​
page
integer
The current page of paginated resources.
  • Default: 1.
​
per_page
integer
Number of records to be returned per API request.
  • Default: 10
  • Minimum: 1
  • Maximum: 100

​
Response

​
id
string
Tag ID
​
user_id
string
User ID
​
merchant_id
string
Merchant ID
​
key
string
Tag key
​
values
array(string)
Array of attribute tags. Currently, only string tags are supported.
​
pagination
hash
Pagination information
curl https://api.thanxsandbox.com/partner/tags \
  -X GET \
  -H 'X-ClientId: {client_id}' \
  -H 'Accept-Version: v4.0' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access_token}' \

{
  "tags": [
    {
      "id": "92b7b0dac4",
      "user_id": "wroeiu2304hfwf",
      "merchant_id": "weroif",
      "key": "allergens",
      "values": ["gluten", "soy", "dairy"]
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "total_pages": 1
  }
}