Skip to main content
GET
/
api
/
v1
/
tags
Get all tags for the workspace
curl --request GET \
  --url https://api.example.com/api/v1/tags
[
  {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "workspaceID": "<string>",
    "listingIds": [
      [
        "<string>"
      ]
    ],
    "description": "<string>"
  }
]

Query Parameters

​
includeListings
boolean

Whether to include listings attached to each tag

Response

List of tags retrieved successfully

​
id
string
required

Unique identifier of the entity

​
createdAt
string<date-time>
required

Date and time when the entity was created

​
updatedAt
string<date-time>
required

Date and time when the entity was last updated

​
name
string
required

Name of the tag

​
workspaceID
string
required

ID of the workspace the tag belongs to

​
listingIds
string[][]
required

Listings associated with this tag

​
description
string

Optional description of the tag