Tag APIs

Overview

Manage workspace tags and bulk tag updates.

Tag properties

Property	Type	Description
`workspaceId`	`number`	The workspace ID.
`id`	`string`	The tag ID.
`tag`	`string`	The tag value.
`type`	`TagType`	The tag type, it can be 'common', 'client', 'message', 'conversation', 'clientStage' or 'convStage'.
`order`	`number`	The tag order.
`description`	`string`	The tag description.
`createdAt`	`DateTime`	The created timestamp.

Tags API

Get tags.

Attribute	Type	Description
`workspaceId`	`number`	Required. The workspace ID.
`tag`	`string`	Tag filter.
`type`	`TagType`	Tag type filter.

Request & Response

POST https://gateway.bcrumbs.net/core/gq

query tags($input: TagsInput!) {
  tags(input: $input) {
    nodes {
      id
      tag
      type
      createdAt
    }
  }
}
 
input TagsInput {
  workspaceId: Int! # Workspace ID.
  tag: String # Tag filter.
  type: TagType # Tag type filter.
}

The query above returns JSON structured like this:

{
  "data": {
    "tags": {
      "nodes": [
        {
          "id": "id_123",
          "tag": "sample",
          "type": "conv",
          "createdAt": "2026-03-16T00:00:00.000Z"
        }
      ]
    }
  }
}

You can check our playground to explore and interact with GraphQL APIs easily and intuitively with real-time documentation.

Programming language examples

curl -X POST 'https://gateway.bcrumbs.net/core/gq' \
  -H 'authorization: API-KEY' \
  -H 'content-type: application/json' \
  -d '{"operationName":"tags","variables":{"input":{"workspaceId":12,"tag":"sample","type":"VALUE"}},"query":"query tags($input: TagsInput!) {\\n  tags(input: $input) {\\n    nodes {\\n      id\\n      tag\\n      type\\n      createdAt\\n    }\\n  }\\n}"}'

Create Tag API

Create a tag.

Attribute	Type	Description
`workspaceId`	`number`	Required. The workspace ID.
`type`	`TagType!`	Required. Tag type.
`tag`	`string`	Required. Tag value.
`order`	`number`	Tag order.
`description`	`string`	Tag description.

Request & Response

POST https://gateway.bcrumbs.net/core/gq

mutation createTag($input: TagCreateInput!) {
  createTag(input: $input) {
    id
    tag
    type
    createdAt
  }
}
 
input TagCreateInput {
  workspaceId: Int! # Workspace ID.
  type: TagType! # Tag type.
  tag: String! # Tag value.
  order: Int # Tag order.
  description: String # Tag description.
}

The mutation above returns JSON structured like this:

{
  "data": {
    "createTag": {
      "id": "id_123",
      "tag": "sample",
      "type": "conv",
      "createdAt": "2026-03-16T00:00:00.000Z"
    }
  }
}

You can check our playground to explore and interact with GraphQL APIs easily and intuitively with real-time documentation.

Programming language examples

curl -X POST 'https://gateway.bcrumbs.net/core/gq' \
  -H 'authorization: API-KEY' \
  -H 'content-type: application/json' \
  -d '{"operationName":"createTag","variables":{"input":{"workspaceId":12,"type":"VALUE","tag":"sample","order":1,"description":"sample"}},"query":"mutation createTag($input: TagCreateInput!) {\\n  createTag(input: $input) {\\n    id\\n    tag\\n    type\\n    createdAt\\n  }\\n}"}'

Bulk Patch Tags API

Bulk patch tags.

Attribute	Type	Description
`workspaceId`	`number`	Required. The workspace ID.
`patches`	`json`	Required. List of tag patch items, it's explained in the next section.

patches fields

Attribute	Type	Description
`id`	`string`	Required. The ID of the tag to patch.
`order`	`number`	Optional. The new order of the tag.
`description`	`string`	Optional. The new description of the tag.

Request & Response

POST https://gateway.bcrumbs.net/core/gq

mutation bulkPatchTags($input: TagBulkPatchInput!) {
  bulkPatchTags(input: $input)
}
 
input TagBulkPatchInput {
  workspaceId: Int! # Workspace ID.
  patches: [TagBulkPatchItemInput!]! # List of tag patch items.
}

The mutation above returns JSON structured like this:

{
  "data": {
    "bulkPatchTags": true
  }
}

You can check our playground to explore and interact with GraphQL APIs easily and intuitively with real-time documentation.

Programming language examples

curl -X POST 'https://gateway.bcrumbs.net/core/gq' \
  -H 'authorization: API-KEY' \
  -H 'content-type: application/json' \
  -d '{"operationName":"bulkPatchTags","variables":{"input":{"workspaceId":12,"patches":[{"id":"item_1"}]}},"query":"mutation bulkPatchTags($input: TagBulkPatchInput!) {\\n  bulkPatchTags(input: $input)\\n}"}'

Workspace Settings Pagination