Get Tag

Fetch one tag by id or name.

MethodGET

/api/v2/tags/:tag

Request Examples

import { Lumail } from "lumail";

const lumail = new Lumail({ apiKey: process.env.LUMAIL_API_KEY });
const { data, error } = await lumail.tags.get("customer");
if (error) {
  throw error;
}
console.log(data.id, data.subscribersCount);

Response Examples

{
  "id": "tag_abc123",
  "name": "customer",
  "subscribersCount": 12
}

Returns one tag by id or name. Permission: audience.

Path Parameters

Name	Type	Description
`tag`	string	Required. Tag id or name.

Response Fields

Field	Type	Description
`id`	string	Tag id.
`name`	string	Tag name.
`subscribersCount`	integer	Contacts with this tag.

Errors

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

Update Tag
List Tags
SDK: lumail.tags.get

PreviousCreate Tag NextUpdate Tag

Path Parameters

Response Fields

Errors

Related