Get tags for an entity

GET /api/v1/entity-tags/{model_type}/{model_id}

Retrieve all tags attached to a specific entity with cursor-based pagination

Operation ID: get_entity_tags_api_v1_entity_tags__model_type___model_id__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

Path

model_type string required
model_id string required

Query

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: EntityTagListResponse

entity_tags array · EntityTagResponse EntityTagResponse

List of entity tags

7 fields
id string required

Unique identifier for the entity tag

tag_id string required

UUID of the tag

tag_name string required

Name of the tag

tag_group_name string

Name of the tag group (if any)

model_type string required

Type of entity this tag is attached to

model_id string required

UUID of the entity

created_at string · date-time required

Timestamp when the tag was attached

count integer required

Total number of entity tags

400 Bad Request - Invalid input

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