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โ
| Method | Endpoint | Description | Scope Required |
|---|---|---|---|
GET | /v1/tags | List all tags | bookings:read |
GET | /v1/tags/{id} | Get a single tag | bookings:read |
POST | /v1/tags | Create a new tag | bookings:write |
PATCH | /v1/tags/{id} | Update a tag name | bookings:write |
DELETE | /v1/tags/{id} | Delete a tag | bookings: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โ
| Tag | Purpose |
|---|---|
| VIP | High-value or repeat customers |
| Corporate | Business/corporate bookings |
| Wedding | Wedding party rentals |
| Local | Local resident discount applied |
| Group | Large group bookings |
| Needs Follow-up | Staff needs to contact customer |
| Special Request | Custom requirements noted |
Related Resourcesโ
- Bookings - Tags are attached to bookings