List tags

GET /api/v1/tags

Retrieve all tags for the current business, optionally filtered by tag group or fuzzy name search

Operation ID: list_tags_api_v1_tags_get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

tag_group_id string: Filter tags by tag group ID
search string: Fuzzy search tags by name (trigram similarity)
cursor string: Cursor for pagination
limit integer: Pagination limit
direction string default: next: Pagination direction: 'next' or 'prev'
include_total_count boolean default: False: Whether to include total count (expensive - avoid if possible)
sort_by string: Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.
descending boolean default: True: Sort direction: true for descending (newest/largest first), false for ascending

Responses

200 Successful Response

Schema: TagListResponse

tags array · TagResponse TagResponse

List of tags

8 fields

name string required: Name of the tag
description string: Description of the tag
id string required: Unique identifier for the tag
tag_group_id string: Tag group this tag belongs to
tag_group_name string: Name of the tag group (if any)
usage_count integer: Number of entities using this tag
created_at string · date-time required: Timestamp when the tag was created
updated_at string · date-time required: Timestamp when the tag was last updated

count integer required

Total number of tags

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

GET /api/v1/tags

bash

curl -X GET 'https://api.ondayzero.com/api/v1/tags' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/tags', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.get("https://api.ondayzero.com/api/v1/tags", headers=headers)
data = response.json()