List Tags

List audience tags.

MethodGET

/api/v2/tags

Request Examples

import { Lumail } from "lumail";

const lumail = new Lumail({ apiKey: process.env.LUMAIL_API_KEY });
const { data, error } = await lumail.tags.list();
if (error) {
  throw error;
}

for (const tag of data.data) {
  console.log(tag.id, tag.name);
}

Response Examples

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "id": "tag_abc123",
      "name": "customer",
      "subscriberCount": 12
    }
  ]
}

Lists audience tags. Permission: audience.

SDK tags.list() takes no args. HTTP accepts optional ?limit= to slice the list.

Query Parameters

Name	Type	Description
`limit`	integer	Optional slice. When the org has more tags than `limit`, `has_more` is `true`.

Response Fields

Field	Type	Description
`object`	`"list"`	Discriminator. Always `list`.
`has_more`	boolean	`true` when `limit` truncated the list.
`data`	array	Tag objects: `id`, `name`, `subscriberCount`.

Errors

Status	`name`	When
401	`missing_api_key`	Missing or invalid bearer token
403	`missing_permission`	Token lacks the `audience` permission

PreviousTags NextCreate Tag

Query Parameters

Response Fields

Errors

Related