Get entities with a tag

GET /api/v1/tags/{tag_id}/entities/{model_type}

Retrieve all entities of a specific type that have a particular tag

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

tag_id string required
model_type 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: TaggedEntitiesResponse

tag_id string required

UUID of the tag

tag_name string required

Name of the tag

model_type string required

Type of entities

entity_ids array · string

List of entity UUIDs with this tag

count integer required

Total number of entities with this tag

400 Bad Request - Invalid input

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

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