Skip to main content
POST
/
api
/
tags
/
list
List tags
curl --request POST \
  --url https://api.mentionlab.io/api/tags/list \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "name": "branding",
  "with_queries_count": true,
  "sort": [
    {
      "field": "name",
      "direction": "ASC"
    }
  ]
}
'
{
  "page": {
    "totalRecords": 123,
    "limit": 123,
    "currentPage": 123,
    "totalPages": 123,
    "nextPage": 123,
    "prevPage": 123
  },
  "results": [
    {
      "id": 1,
      "project": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
      "name": "feature",
      "color": "#3B82F6",
      "queryCount": 5
    }
  ]
}

Headers

x-project-id
string
required

Project ID to specify the project context

Query Parameters

limit
integer
default:50
Required range: 1 <= x <= 1000
page
integer
default:1
Required range: x >= 1

Body

application/json
name
string

Filter tags by name using a case-insensitive partial match.

Example:

"branding"

with_queries_count
boolean

Include the count of queries associated with each tag

Example:

true

sort
object[]

Sorting options for the tag list. Currently only the "name" field is sortable. Defaults to ascending order by name.

Example:
[{ "field": "name", "direction": "ASC" }]

Response

page
object
required
results
object[]