Skip to main content

​
Introduction

Tags allow you to organize and categorize listings within your workspace. You can create custom tags, apply them to listings, and use them to filter search results.

​
Creating a Tag

Create a tag by providing a name and an optional description: 
POST /api/v1/tags

{
  "name": "Beachfront",
  "description": "Properties located directly on the beach"
}
Tag names can be up to 100 characters, and descriptions up to 500 characters.

​
Applying Tags to Listings

Once a tag is created, you can apply it to one or more listings: 
POST /api/v1/tags/{tagId}/listings

{
  "listingIds": [
    "listing-uuid-1",
    "listing-uuid-2",
    "listing-uuid-3"
  ]
}
If a listing already has the tag applied, it is skipped automatically. You can also apply tags to all listings under an integration account using the integration account’s apply-tags endpoint: 
POST /api/v1/integration-account/{integrationAccountId}/apply-tags

{
  "tagIDs": ["tag-uuid-1", "tag-uuid-2"],
  "requireListingApproval": false
}

​
Listing Tags

To view all tags in your workspace: 
GET /api/v1/tags
Use the includeListings query parameter to include the associated listing IDs in the response: 
GET /api/v1/tags?includeListings=true

​
Updating a Tag

Update a tag’s name or description: 
PATCH /api/v1/tags/{tagId}

{
  "name": "Oceanfront",
  "description": "Properties with direct ocean access"
}
Tags can be used as a filter when searching for listings. Pass tag IDs in the tags query parameter to return only listings that have any of the specified tags: 
GET /api/v1/search?tags=tag-uuid-1,tag-uuid-2
See the Search guide for more details on search parameters.

​
API Reference

For detailed API documentation, refer to the following endpoints: