Skip to main content
GET
/
tagsets
/
{id}
JavaScript
import Moonbase from '@moonbaseai/sdk';

const client = new Moonbase({
  apiKey: process.env['MOONBASE_API_KEY'], // This is the default and can be omitted
});

const tagset = await client.tagsets.retrieve('id');

console.log(tagset.id);
{
  "id": "1CLJt2v17V1yuCdrUwA4PW",
  "type": "tagset",
  "name": "Support",
  "description": "Tags for our support inbox",
  "tags": [
    {
      "id": "1CLJt2v1MsDbov8DBEEeWH",
      "type": "tag",
      "name": "Requires Action"
    },
    {
      "id": "1CLJt2v1cFRDidcZsXKEd4",
      "type": "tag",
      "name": "UX"
    },
    {
      "id": "1CLJt2v1rdcqdM6vZpPpjq",
      "type": "tag",
      "name": "Bug"
    },
    {
      "id": "1CLJt2v271pTY4bHG7UQrc",
      "type": "tag",
      "name": "Billing"
    },
    {
      "id": "1CLJt2v2MQ25Sn5dxQYzyP",
      "type": "tag",
      "name": "QBR"
    },
    {
      "id": "1CLJt2v2bnDhMVZzehdb6A",
      "type": "tag",
      "name": "Feature Request"
    },
    {
      "id": "1CLJt2v2rARKGD4MLziBCw",
      "type": "tag",
      "name": "Login Issue"
    },
    {
      "id": "1CLJt2v36YcwAvYi3HnmKi",
      "type": "tag",
      "name": "Refund"
    },
    {
      "id": "1CLJt2v3LvpZ5e34jasMSV",
      "type": "tag",
      "name": "Pricing"
    },
    {
      "id": "1CLJt2v3bK2AzMXRRswwZG",
      "type": "tag",
      "name": "Meeting"
    },
    {
      "id": "1CLJt2v3qhDnu51n8B2Xg3",
      "type": "tag",
      "name": "VIP"
    }
  ],
  "created_at": "2025-02-17T16:00:00.000Z",
  "updated_at": "2025-02-17T16:00:00.000Z"
}

Authorizations

Authorization
string
header
required

Your Moonbase API key.

Path Parameters

id
string
required

The ID of the tagset to retrieve.

Response

Successful response.

A Tagset is a collection of Tag objects that can be applied within a specific Inbox.

type
string
required

String representing the object’s type. Always tagset for this object.

Allowed value: "tagset"
id
string
required

Unique identifier for the object.

name
string
required

The name of the tagset.

tags
Tag · object[]
required

A list of Tag objects belonging to this tagset.

created_at
string<date-time>
required

Time at which the object was created, as an ISO 8601 timestamp in UTC.

updated_at
string<date-time>
required

Time at which the object was last updated, as an ISO 8601 timestamp in UTC.

description
string

An optional description of the tagset's purpose.