Skip to main content
GET
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