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

# List Tag Keys

> List the workspace's tag keys, most-used first.

``search`` is a prefix match on the key slug. Archived keys are omitted —
pushing to one is refused anyway, so there is no reason to advertise it.

Authentication: Requires X-API-Key header with valid API key.



## OpenAPI

````yaml /openapi.json get /api/tags/keys
openapi: 3.1.0
info:
  title: iClear Integrations API
  description: An API for iClear integrations.
  version: 1.0.0
servers:
  - url: https://api.northell.io/nhl/prod/mediamagic-verify-integrations
    description: prod
security: []
paths:
  /api/tags/keys:
    get:
      summary: List Tag Keys
      description: >-
        List the workspace's tag keys, most-used first.


        ``search`` is a prefix match on the key slug. Archived keys are omitted
        —

        pushing to one is refused anyway, so there is no reason to advertise it.


        Authentication: Requires X-API-Key header with valid API key.
      operationId: list_tag_keys_api_tags_keys_get
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
            title: Page
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 10
            title: Pagesize
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 200
              - type: 'null'
            title: Search
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_TagKeySchema_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - apiKey: []
components:
  schemas:
    PaginatedResponse_TagKeySchema_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/TagKeySchema'
          type: array
          title: Data
        pagination:
          $ref: '#/components/schemas/PaginationMeta'
      type: object
      required:
        - data
        - pagination
      title: PaginatedResponse[TagKeySchema]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    TagKeySchema:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: Tag key id — pass as tagKeyIds to filter assets.
        name:
          type: string
          title: Name
          description: Canonical key slug, e.g. 'Campaign'.
        displayName:
          anyOf:
            - type: string
            - type: 'null'
          title: Displayname
          description: Human-facing label when it differs from the slug.
        valuePolicy:
          $ref: '#/components/schemas/ValuePolicy'
          description: >-
            'open' — you may push any value, unknown values are created.
            'controlled' — only values already curated on this key are accepted.
            'none' — a plain key that takes no value at all.
        allowMultipleValues:
          type: boolean
          title: Allowmultiplevalues
          description: Whether one asset may carry several values of this key.
        assignmentCount:
          type: integer
          title: Assignmentcount
          description: How many distinct assets in the workspace carry this key.
      type: object
      required:
        - id
        - name
        - valuePolicy
        - allowMultipleValues
        - assignmentCount
      title: TagKeySchema
      description: 'A tag key (the ''data type'': Campaign, Region, CarMake…).'
    PaginationMeta:
      properties:
        page:
          type: integer
          title: Page
        pageSize:
          type: integer
          title: Pagesize
        total:
          type: integer
          title: Total
        totalPages:
          type: integer
          title: Totalpages
      type: object
      required:
        - page
        - pageSize
        - total
        - totalPages
      title: PaginationMeta
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    ValuePolicy:
      type: string
      enum:
        - open
        - controlled
        - none
      title: ValuePolicy
      description: Per-key value typing. 'none' = plain (value-less) tag. (spec §0 Q4)
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'Workspace-scoped API key. Format: sk_live_{64 hex chars}'
      x-default: sk_live_your_api_key_here

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.