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

# List tags

> Returns all tags visible to the user's organization, with the number of documents associated with each tag. Use the optional `prefix` query parameter to return only tags whose names start with that string (for example `broker:`, `from:`, or `to:`). Tags are created automatically from ingested content (e.g., `from:user@email.com` / `to:user@email.com` for email, or `broker:Broker Name` for documents onboarded via investment research connectors).



## OpenAPI

````yaml /api-rest/openapi/openapi_content_data.json get /contents/v1/tags
openapi: 3.1.0
info:
  title: Bigdata Content API
  description: API for managing and accessing private content documents uploaded by users.
  version: 1.0.0
servers:
  - url: https://api.bigdata.com/
security:
  - ApiKeyAuth: []
paths:
  /contents/v1/tags:
    get:
      tags:
        - Tags
      summary: List tags
      description: >-
        Returns all tags visible to the user's organization, with the number of
        documents associated with each tag. Use the optional `prefix` query
        parameter to return only tags whose names start with that string (for
        example `broker:`, `from:`, or `to:`). Tags are created automatically
        from ingested content (e.g., `from:user@email.com` / `to:user@email.com`
        for email, or `broker:Broker Name` for documents onboarded via
        investment research connectors).
      parameters:
        - name: prefix
          in: query
          required: false
          description: >-
            Return only tags whose name starts with this prefix. Useful to
            narrow results: `broker:`, `from:`, or `to:`.
          schema:
            type: string
      responses:
        '200':
          description: >-
            List of tag objects in a results array. Each tag includes id, name,
            and file_count. When `prefix` is set, only tags matching that prefix
            are included. Use the tag name in the tags query parameter of Search
            Service or Research Agent to filter by that tag.
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    description: >-
                      Tags with their document counts. Use name when filtering
                      documents.
                    items:
                      $ref: '#/components/schemas/TagDetails'
                required:
                  - results
              example:
                results:
                  - id: 019a48b4-e573-7203-945a-2e7c4c164217
                    name: from:user@email.com
                    created_at: '2025-11-03T07:53:26.150858Z'
                    updated_at: '2025-11-03T07:53:26.150859Z'
                    file_count: 40
                  - id: 019a3a11-8e6a-7296-afe0-bdfe4779982e
                    name: to:user@email.com
                    created_at: '2025-10-31T11:40:20.480070Z'
                    updated_at: '2025-10-31T11:40:20.480074Z'
                    file_count: 26
                  - id: 019b2c22-9f7b-83a7-bfc1-cef58810933f
                    name: broker:Broker Name
                    created_at: '2026-04-07T09:30:00.000000Z'
                    updated_at: '2026-04-07T09:30:00.000000Z'
                    file_count: 10
        '401':
          description: Unauthorized - Invalid or missing API key.
components:
  schemas:
    TagDetails:
      type: object
      description: Detailed information about a tag.
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the tag.
          example: 019a48b4-e573-7203-945a-2e7c4c164217
        name:
          type: string
          description: >-
            Name of the tag (e.g. `from:user@email.com`, `to:user@email.com`,
            `broker:Broker Name` or a custom one provided by the user).
          example: from:user@email.com
        created_at:
          type: string
          format: date-time
          description: Timestamp when the tag was created.
          example: '2025-11-03T07:53:26.150858Z'
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the tag was last updated.
          example: '2025-11-03T07:53:26.150859Z'
        file_count:
          type: integer
          description: Number of files associated with this tag.
          example: 40
      required:
        - id
        - name
        - created_at
        - updated_at
        - file_count
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: >-
        Your API key. Include it in every request as the X-API-KEY header.
        Create and manage keys in the Developer Platform.

````