List

tags.list() -> SyncTagsCursor[TagListResponse]

GET/tags

List all tags in use for the given projectId

ParametersExpand Collapse

page_size: Optional[int]

The number of items to return in the response. The default value is 50, maximum value is 100, minimum value is 1

minimum1

maximum100

pagination_token: Optional[str]

A token you received in a previous request to query the next page of items

project_id: Optional[str]

The projectId used for ownership resource management. Either to assert ownership or to set the owner of the resource(s)

ReturnsExpand Collapse

class TagListResponse: …

created_at: str

The tag creation date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

item_count: float

The number of items that have this tag

owner_id: str

The owner ID (example: “dcf121faaa1a0a0bbbd9ca1b73d62aea”)

tag_name: str

The tag name

updated_at: str

The tag last update date as an ISO string (example: “2023-02-03T11:19:41.579Z”)

List

import os
from scenario_sdk import Scenario

client = Scenario(
    api_key=os.environ.get("SCENARIO_SDK_API_KEY"),  # This is the default and can be omitted
    api_secret=os.environ.get("SCENARIO_SDK_API_SECRET"),  # This is the default and can be omitted
)
page = client.tags.list()
page = page.tags[0]
print(page.created_at)

{
  "tags": [
    {
      "createdAt": "createdAt",
      "itemCount": 0,
      "ownerId": "ownerId",
      "tagName": "tagName",
      "updatedAt": "updatedAt"
    }
  ],
  "nextPaginationToken": "nextPaginationToken"
}

Returns Examples

{
  "tags": [
    {
      "createdAt": "createdAt",
      "itemCount": 0,
      "ownerId": "ownerId",
      "tagName": "tagName",
      "updatedAt": "updatedAt"
    }
  ],
  "nextPaginationToken": "nextPaginationToken"
}