List User Tags

List all User Tags within an Organization

POST

/

public

/

v1

/

query

/

list_user_tags

Authorizations

API Key

X-Stamp

string

header

required

Body

organizationId · string · required

Unique identifier for a given Organization.

Response

A successful response returns the following fields:

userTags · array · required

A list of User Tags

Show userTags details

userTags.tagId

string

required

Unique identifier for a given Tag.

userTags.tagName

string

required

Human-readable name for a Tag.

userTags.tagType

enum

required

tagType field

Enum options: TAG_TYPE_USER, TAG_TYPE_PRIVATE_KEY

userTags.createdAt

object

required

createdAt field

Show createdAt details

userTags.createdAt.seconds

string

required

seconds field

userTags.createdAt.nanos

string

required

nanos field

userTags.updatedAt

object

required

updatedAt field

Show updatedAt details

userTags.updatedAt.seconds

string

required

seconds field

userTags.updatedAt.nanos

string

required

nanos field

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/list_user_tags \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "organizationId": "<string>"
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_UNKNOWN_V1",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "userTags": [
        {
          "tagId": "<string>",
          "tagName": "<string>",
          "tagType": "<TAG_TYPE_USER>",
          "createdAt": {
            "seconds": "<string>",
            "nanos": "<string>"
          },
          "updatedAt": {
            "seconds": "<string>",
            "nanos": "<string>"
          }
        }
      ]
    }
  }
}