v1

latestOpenAPI 3.0.1Apache 2.02026-07-26131220353.8 KB
tag-groups

Retrieve the tag groups for a company or an organisation in aggregated format

        ⚠️ Attention: either the `company_id` or the `organization_id` query parameter MUST be provided. 
        If you supply both, the `company_id` will be used. If you supply neither, the request will fail. 
        If you supply the `company_id`, the response will contain only the tag groups for that company.
        If you supply the `organization_id`, the response will contain the tag groups for all companies in the organization.
        If you supply the `company_id` and the `organization_id`, the response will contain only the tag groups for the company. 
        If you supply the `tag_group_ids` query parameter, the response will contain only the tag groups with the given ids, including archived ones.
        
get/v0/aggregations/tag-groups

Query parameters

company_idstring uuid

Enter the company ID whose tag groups you are searching for. Required if organization_id is not provided. If you enter both company_id and organization_id, the company_id is used to filter the tag groups.

organization_idstring uuid

Enter the organization ID whose tag groups you are searching for. Required if company_id is not provided. If you enter both company_id and organization_id, the company_id is used to filter the tag groups.

tag_group_idsstring[]

Enter the list of tag groups IDs that you are searching for.

Response

default response