List Tag Assignments

View as Markdown

Headers

{{tenant_key_name}}stringOptional

Query parameters

entity_typestringOptional

Optional: Filter by entity type - must be a key in config(‘tags.entity_mapping’) - e.g. customer|customer_location|work_order|equipment|lead|opportunity

entity_idstringOptional

Optional: Filter by entity UUID - resolved via entity_uuid_fields

tag_type_idstringOptional

Optional: Filter by tag type UUID

source_typestringOptional

Optional: Filter by source - in: manual|automation|integration|system

date_fromstringOptional

Optional: Filter by created_at >= - date format YYYY-MM-DD

date_tostringOptional

Optional: Filter by created_at <= - date format YYYY-MM-DD

scopestringOptional

Optional: Result scope - in: direct|effective|dispatch - default direct

sort_bystringOptional

Optional: Sort field - in: created_at|updated_at

sort_directionstringOptional

Optional: Sort direction - asc|desc

per_pageintegerOptional

Optional: Results per page - integer 1-100 - default 25

Response

Successful response