Skip to main content
GET
/
contents
/
v1
/
tags
List tags
curl --request GET \
  --url https://api.bigdata.com/contents/v1/tags \
  --header 'X-API-KEY: <api-key>'
{
  "results": [
    {
      "id": "019a48b4-e573-7203-945a-2e7c4c164217",
      "name": "from:user@email.com",
      "created_at": "2025-11-03T07:53:26.150858Z",
      "updated_at": "2025-11-03T07:53:26.150859Z",
      "file_count": 40
    },
    {
      "id": "019a3a11-8e6a-7296-afe0-bdfe4779982e",
      "name": "to:user@email.com",
      "created_at": "2025-10-31T11:40:20.480070Z",
      "updated_at": "2025-10-31T11:40:20.480074Z",
      "file_count": 26
    },
    {
      "id": "019b2c22-9f7b-83a7-bfc1-cef58810933f",
      "name": "broker:Broker Name",
      "created_at": "2026-04-07T09:30:00.000000Z",
      "updated_at": "2026-04-07T09:30:00.000000Z",
      "file_count": 10
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Your API key. Include it in every request as the X-API-KEY header. Create and manage keys in the Developer Platform.

Query Parameters

​
prefix
string

Return only tags whose name starts with this prefix. Useful to narrow results: broker:, from:, or to:.

Response

List of tag objects in a results array. Each tag includes id, name, and file_count. When prefix is set, only tags matching that prefix are included. Use the tag name in the tags query parameter of Search Service or Research Agent to filter by that tag.

​
results
object[]
required

Tags with their document counts. Use name when filtering documents.