client.table_tags.list

A method of the Table Tags endpoint.

list(*, name: str = None, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None) → ListResponse | PaginatedResponse

List Table Tags

API URL: GET /table_tags

import civis
client = civis.APIClient()
response = client.table_tags.list(...)

Parameters:

namestr, optional: Name of the tag. If it is provided, the results will be filtered by name
limitint, optional: Number of results to return. Defaults to 50. Maximum allowed is 1000.
page_numint, optional: Page number of the results to return. Defaults to the first page, 1.
orderstr, optional: The field on which to order the result set. Defaults to name. Must be one of: name, user, table_count.
order_dirstr, optional: Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.
iteratorbool, optional: If True, return a generator (specifically, a civis.PaginatedResponse object) to iterate over all responses. Use it when more results than the maximum allowed by ‘limit’ are needed. When True, ‘page_num’ is ignored. If False, return a civis.ListResponse object (= a list of civis.Response objects), whose size is determined by ‘limit’. Defaults to False.

Returns:

civis.ListResponse | civis.PaginatedResponse