GET
/
partner
/
tags
curl https://api.thanxsandbox.com/partner/tags \
  -X GET \
  $AUTH_HEADERS

{
  "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 \
  $AUTH_HEADERS

{
  "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
  }
}