Tags API

Tags are free-form labels you hang on records — tickets, clients, contacts, assets, and more. This API has two halves: the tag definitions themselves (text and colors), and the links between a tag and the entities it's applied to.

Define a tag

POST /tags takes a tag_text and optional color and background_color. Rename one later with PUT /tags/{id}/text or recolor it with PUT /tags/{id}/colors without touching anything it's attached to.

curl https://algapsa.com/api/v1/tags \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tag_text": "vip",
    "color": "#ffffff",
    "background_color": "#b91c1c"
  }'

Attach and detach

Applying a tag is keyed on the target record. List what's on a record with GET /tags/entity/{entityType}/{entityId}, add tags with the matching POST, and strip them with the DELETE. To label many records at once, use POST /tags/bulk/tag and DELETE /tags/bulk/untag; POST /tags/bulk/merge folds duplicate tags into one.

See what's in use

GET /tags/cloud returns tags weighted by usage, and GET /tags/analytics breaks down how they're spread across your data.

Endpoints

Every endpoint links through to its full parameters, request and response schemas, and code samples.