Find Entities By Tag

View as Markdown

Headers

{{tenant_key_name}}stringOptional

Query parameters

entity_typestringOptional

Required: Entity type key - in: customer|customer_location|work_order|equipment|lead|opportunity

tag_type_ids[]stringOptional

Required: Tag type UUIDs - array - min 1 - one query param per UUID

matchstringOptional

Optional: Match mode - in: any|all - any = entity has ANY of the tags, all = entity has ALL of the tags - default any

include_entityintegerOptional

Optional: Include the full entity payload in the response - boolean - default false

per_pageintegerOptional

Optional: Results per page - integer 1-200 (configurable via TAGS_REPORT_MAX_PER_PAGE env) - default 50

Response

Successful response