# Tags

[Tags in the product knowledge base](https://alteg.io/en/support/knowledge-base/4861319864861-client-categories/)


Custom tags for clients, appointments, and events.


## List Tags (v2)

 - [GET /v2/companies/{company_id}/tags](https://developer.alteg.io/en/tags/list_tags_v2.md): Returns all tags for the specified company, optionally filtered by entity type.

Response uses JSON:API format where type: "tag" is the resource type name (not to be confused with entity_type attribute).

Entity types:
- common (0) - General tags
- client (1) - Client tags
- record (2) - Appointment/record tags
- activity (3) - Activity/event tags

Use the entity query parameter to filter by type. Accepts both string aliases and numeric values.

## Create Tag (v2)

 - [POST /v2/companies/{company_id}/tags](https://developer.alteg.io/en/tags/create_tag_v2.md): Creates a new tag for the specified company.

## Get Tag (v2)

 - [GET /v2/companies/{company_id}/tags/{tag_id}](https://developer.alteg.io/en/tags/get_tag_v2.md): Returns detailed information about a specific tag.

Response uses JSON:API format where type: "tag" is the resource type name.

## Update Tag (v2)

 - [PUT /v2/companies/{company_id}/tags/{tag_id}](https://developer.alteg.io/en/tags/update_tag_v2.md): Updates an existing tag.

## Delete Tag (v2)

 - [DELETE /v2/companies/{company_id}/tags/{tag_id}](https://developer.alteg.io/en/tags/delete_tag_v2.md): Deletes a tag (soft delete - marks as deleted).

## Create a Tag (Deprecated) (deprecated)

 - [POST /v1/labels/{location_id}](https://developer.alteg.io/en/tags/create_tag.md): Deprecated: Use POST /api/v2/companies/{company_id}/tags instead.

Creates a new tag for the specified location.

## Get location tags (Deprecated) (deprecated)

 - [GET /v1/labels/{location_id}/{entity}](https://developer.alteg.io/en/tags/get_tag_list_by_entity.md): Deprecated: Use GET /api/v2/companies/{company_id}/tags?entity={entity} instead.
Returns tags for the specified entity type.

The entity parameter accepts string aliases:
- common - common tags
- client - client tags
- record - appointment/record tags
- activity - activity/event tags

> Legacy support: Numeric values (0, 1, 2, 3) are also accepted but string aliases are preferred.

## Update Tag (Deprecated) (deprecated)

 - [PUT /v1/labels/{location_id}/{tag_id}](https://developer.alteg.io/en/tags/update_tag_by_tag_id.md): Deprecated: Use PUT /api/v2/companies/{company_id}/tags/{tag_id} instead.

## Delete location tag (Deprecated) (deprecated)

 - [DELETE /v1/labels/{location_id}/{tag_id}](https://developer.alteg.io/en/tags/delete_tag_by_tag_id.md): Deprecated: Use DELETE /api/v2/companies/{company_id}/tags/{tag_id} instead.