Skip to main content

Tag

A label that can be added to any conversation. Tags can be used in folder definitions to create 'smart' folders, in Inbox to search for specific conversations, and in Reporting to monitor trends.

To fetch all tags in the account:

query Tags {
  tags {
    nodes {
      color
      conversationCount
      createdAt
      creator {
        id
      }
      id
      lastUsedAt
      name
      updatedAt
    }
    pageInfo {
      hasNextPage
    }
  }
}

To fetch all tags applied to a specific conversation:

%(query Conversation {
  node(id: $conversationId) {
    ... on Conversation {
      id
      number
      tags {
        nodes {
          color
          conversationCount
          createdAt
          creator {
            id
          }
          id
          lastUsedAt
          name
          updatedAt
        }
        pageInfo {
          hasNextPage
        }
      }
    }
  }
}

To fetch a single tag:

query Node($tagId: ID!) {
  node(id: $tagId) {
    ... on Tag {
      id
      name
    }
  }
}
type Tag implements Node, Timestamped {
  color: String
  conversationCount(
  filter: ConversationCountFilter
): Int!
  createdAt: DateTime!
  creator: Agent
  id: ID!
  lastUsedAt: DateTime
  name: String!
  updatedAt: DateTime!
}

Fields​

Tag.color ● String scalar common​

The display color of the tag.

Tag.conversationCount ● Int! non-null scalar common​

The number of conversations that the tag is applied to.

Tag.conversationCount.filter ● ConversationCountFilter input common​

Filter conversation counts.

Tag.createdAt ● DateTime! non-null scalar common​

The date and time that the object was created.

Tag.creator ● Agent object common​

The agent that created the tag.

Tag.id ● ID! non-null scalar common​

Tag.lastUsedAt ● DateTime scalar common​

The date and time that the tag was last used.

Tag.name ● String! non-null scalar common​

The name of the tag.

Tag.updatedAt ● DateTime! non-null scalar common​

The date and time that the object was last updated.

Interfaces​

Node interface common​

An object with an ID.

Timestamped interface common​

An object with timestamp fields for when it was created and last updated.

Member of​

TagConnection object ● TagCreatePayload object ● TagEdge object ● Tagged object ● TagUpdatePayload object ● Untagged object