listTagValues

Get a bot tag values

GET /v1/chat/tags/{key}/values

Try it

cURL

cURL

curl --request GET \
  --url https://api.botpress.cloud/v1/chat/tags/{key}/values \
  --header 'Authorization: Bearer <token>' \
  --header 'x-bot-id: <x-bot-id>'

200

{
  "tags": [
    {
      "value": "<string>"
    }
  ],
  "meta": {
    "nextToken": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-bot-id · string · required

Bot id

x-integration-id · string

Integration id

x-integration-alias · string

Integration alias

Path Parameters

key · string · required

Tag key

Query Parameters

nextToken · string

Provide the meta.nextToken value provided in the last API response to retrieve the next page of results

type · enum<string> · required

Tag type

Available options: user, conversation, message

Response

200

application/json

Empty response

tags · object[] · required

Show child attributes

tags. value · string · required

meta · object · required

Show child attributes

meta. nextToken · string

The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.