> ## Documentation Index
> Fetch the complete documentation index at: https://docs.enginy.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get inbox tag

> Retrieve one inbox tag by ID.

Required parameters:
- tagId: tag ID path parameter.

Optional query parameters:
- senderIdentityId: scope the returned count to one sender identity
- archived: set to true to count archived threads instead of active ones. Defaults to false.

    > **Required scope:** `MESSAGING_READ`
    >
    > **Rate limit:** 100 requests per minute



## OpenAPI

````yaml https://openapi.enginy.ai/definitions.json get /v1/inbox/tags/:tagId
openapi: 3.1.0
info:
  title: Enginy API
  version: 1.0.0
  description: Public API for Enginy platform
servers:
  - url: https://openapi.enginy.ai
    description: Configured server
security: []
tags:
  - name: AI Variables
    description: >-
      Manage AI variables and discover the entity fields you can reference in
      prompts and entity requests.
  - name: Inbox
    description: >-
      Inbox endpoints for listing contact threads, reading thread messages,
      managing tags, and sending manual replies.
  - name: Workflows
    description: >-
      Build, validate, publish, run, and inspect advanced (graph) workflows,
      plus the block/condition catalog needed to author a workflow plan.
paths:
  /v1/inbox/tags/:tagId:
    get:
      tags:
        - Inbox
      summary: Get inbox tag
      description: >-
        Retrieve one inbox tag by ID.


        Required parameters:

        - tagId: tag ID path parameter.


        Optional query parameters:

        - senderIdentityId: scope the returned count to one sender identity

        - archived: set to true to count archived threads instead of active
        ones. Defaults to false.

            > **Required scope:** `MESSAGING_READ`
            >
            > **Rate limit:** 100 requests per minute
      parameters:
        - schema:
            type: string
            description: Inbox tag ID
            example: '5'
          required: true
          description: Inbox tag ID
          name: tagId
          in: path
        - schema:
            type: integer
            exclusiveMinimum: 0
            description: Scope tag counts to the threads visible for one sender identity.
            example: 14
          required: false
          description: Scope tag counts to the threads visible for one sender identity.
          name: senderIdentityId
          in: query
        - schema:
            type: boolean
            description: Count archived threads instead of active ones. Defaults to false.
            example: false
          required: false
          description: Count archived threads instead of active ones. Defaults to false.
          name: archived
          in: query
      responses:
        '200':
          description: Inbox tag retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - success
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      id:
                        type: number
                        description: Unique identifier for the inbox tag
                      name:
                        type: string
                        description: Tag name
                      color:
                        type: string
                        description: Tag color
                      count:
                        type: number
                        description: >-
                          Number of visible contact threads that currently have
                          this tag
                      isPromptActive:
                        type: boolean
                        description: >-
                          Whether the tag is enabled for prompt-based
                          auto-tagging
                      isEditable:
                        type: boolean
                        description: Whether the tag can be edited manually
                    required:
                      - id
                      - name
                      - color
                      - count
                      - isPromptActive
                      - isEditable
                required:
                  - status
                  - message
                  - data
              examples:
                default:
                  summary: Single inbox tag
                  value:
                    status: success
                    message: Inbox tag retrieved successfully
                    data:
                      id: 5
                      name: Hot lead
                      color: '#F97316'
                      count: 18
                      isPromptActive: false
                      isEditable: true
        '400':
          description: Invalid tag ID
        '404':
          description: Inbox tag or sender identity not found
      security:
        - apiKey: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key

````