Skip to main content

Tags API

Tags are labels you can attach to bookings to organize, categorize, and filter them.

What is a Tag?โ€‹

Tags are simple labels that help you:

  • Categorize bookings: Mark bookings as "VIP", "Corporate", "Wedding", etc.
  • Track workflows: Use tags like "Needs Follow-up", "Special Request"
  • Filter and report: Find all bookings with specific tags
  • Trigger automations: Use tags with webhooks for custom workflows

Tag Structureโ€‹

Tag
โ”œโ”€โ”€ id
โ”œโ”€โ”€ name (unique per supplier)
โ”œโ”€โ”€ created_at
โ””โ”€โ”€ updated_at

Tags are simple by design - just a name that can be attached to bookings.

How Tags Connect to Bookingsโ€‹

A booking can have multiple tags, and a tag can be attached to multiple bookings:

Booking A โ”€โ”€โ”ฌโ”€โ”€ VIP
โ””โ”€โ”€ Corporate

Booking B โ”€โ”€โ”ฌโ”€โ”€ VIP
โ””โ”€โ”€ Wedding

Booking C โ”€โ”€โ”€โ”€ Corporate

API Endpointsโ€‹

MethodEndpointDescriptionScope Required
GET/v1/tagsList all tagsbookings:read
GET/v1/tags/{id}Get a single tagbookings:read
POST/v1/tagsCreate a new tagbookings:write
PATCH/v1/tags/{id}Update a tag namebookings:write
DELETE/v1/tags/{id}Delete a tagbookings:write

Common Use Casesโ€‹

Creating Standard Tagsโ€‹

Set up your standard tag library:

curl -X POST "https://app.equipdash.com/api/v1/tags" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "VIP"}'

Listing Available Tagsโ€‹

Fetch tags to show in your booking interface:

curl "https://app.equipdash.com/api/v1/tags" \
-H "Authorization: Bearer YOUR_API_KEY"

Filtering Bookings by Tagโ€‹

Use tags when listing bookings:

curl "https://app.equipdash.com/api/v1/bookings?tag=VIP" \
-H "Authorization: Bearer YOUR_API_KEY"

Example Tagsโ€‹

TagPurpose
VIPHigh-value or repeat customers
CorporateBusiness/corporate bookings
WeddingWedding party rentals
LocalLocal resident discount applied
GroupLarge group bookings
Needs Follow-upStaff needs to contact customer
Special RequestCustom requirements noted
  • Bookings - Tags are attached to bookings