> ## 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 Assets By Tag

> Filter the workspace's assets by tag, newest first.

``tagKeyIds`` matches the key whatever its value (and matches plain keys);
``tagValueIds`` matches one specific value. Both are repeatable.

``tagMatch=any`` (default) returns assets carrying ANY of the selection.
``tagMatch=all`` requires every selected key, and — in the value dimension —
at least one selected value per key, so two values of the same key union
rather than forming a filter nothing can satisfy.

At least one of ``tagKeyIds`` / ``tagValueIds`` is required: this is a filter
endpoint, and treating a missing filter as "every asset in the workspace"
would be a surprising and expensive answer to a dropped parameter.

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

Raises:
    400: If neither tagKeyIds nor tagValueIds is supplied
    401: If API key missing or invalid



## OpenAPI

````yaml /openapi.json get /api/assets
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/assets:
    get:
      summary: List Assets By Tag
      description: >-
        Filter the workspace's assets by tag, newest first.


        ``tagKeyIds`` matches the key whatever its value (and matches plain
        keys);

        ``tagValueIds`` matches one specific value. Both are repeatable.


        ``tagMatch=any`` (default) returns assets carrying ANY of the selection.

        ``tagMatch=all`` requires every selected key, and — in the value
        dimension —

        at least one selected value per key, so two values of the same key union

        rather than forming a filter nothing can satisfy.


        At least one of ``tagKeyIds`` / ``tagValueIds`` is required: this is a
        filter

        endpoint, and treating a missing filter as "every asset in the
        workspace"

        would be a surprising and expensive answer to a dropped parameter.


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


        Raises:
            400: If neither tagKeyIds nor tagValueIds is supplied
            401: If API key missing or invalid
      operationId: list_assets_by_tag_api_assets_get
      parameters:
        - name: tagKeyIds
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              format: uuid
            title: Tagkeyids
        - name: tagValueIds
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              format: uuid
            title: Tagvalueids
        - name: tagMatch
          in: query
          required: false
          schema:
            type: string
            pattern: ^(any|all)$
            default: any
            title: Tagmatch
        - 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
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_AssetResultResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - apiKey: []
components:
  schemas:
    PaginatedResponse_AssetResultResponse_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/AssetResultResponse'
          type: array
          title: Data
        pagination:
          $ref: '#/components/schemas/PaginationMeta'
      type: object
      required:
        - data
        - pagination
      title: PaginatedResponse[AssetResultResponse]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AssetResultResponse:
      properties:
        assetId:
          type: string
          format: uuid
          title: Assetid
          description: Asset ID
        submissionId:
          type: string
          format: uuid
          title: Submissionid
          description: Parent submission ID
        filename:
          type: string
          title: Filename
          description: Original filename
        mimeType:
          anyOf:
            - type: string
            - type: 'null'
          title: Mimetype
          description: MIME type
        status:
          $ref: '#/components/schemas/SubmissionStatus'
          description: Submission status
        issueCount:
          anyOf:
            - type: integer
            - type: 'null'
          title: Issuecount
          description: Total issues found
        versionNumber:
          type: integer
          title: Versionnumber
          description: Version number
          default: 1
        versionGroupId:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Versiongroupid
          description: Version group ID
        tags:
          items:
            $ref: '#/components/schemas/TagSchema'
          type: array
          title: Tags
          description: Tags applied to this asset.
        contextItems:
          items:
            $ref: '#/components/schemas/ContextItemSchema'
          type: array
          title: Contextitems
          description: Supporting files/links attached to this asset.
        startedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Startedat
          description: >-
            When this asset actually entered review; null while still queued.
            Reflects the latest attempt on a retried asset.
        completedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Completedat
          description: >-
            When this asset left review, for ANY outcome (a failure time on a
            failed asset). With startedAt this gives the actual processing
            duration.
      type: object
      required:
        - assetId
        - submissionId
        - filename
        - status
      title: AssetResultResponse
      description: |-
        Asset metadata for a single asset: filename, MIME type, tags, context.

        Issues are served by the dedicated ``/assets/{asset_id}/issues`` and
        ``/assets/{asset_id}/topics`` endpoints, which carry the full enriched
        detail (contributors, anchors, resolution requirements).
    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
    SubmissionStatus:
      type: string
      enum:
        - uploading
        - submitted
        - queued
        - processing
        - complete
        - failed
        - partial
      title: SubmissionStatus
    TagSchema:
      properties:
        key:
          type: string
          title: Key
          description: Tag key/namespace, e.g. 'Campaign'.
        value:
          type: string
          title: Value
          description: Tag value/label, e.g. 'Summer'.
        isPlain:
          type: boolean
          title: Isplain
          description: >-
            True for a plain tag (a key that takes no value, valuePolicy
            'none'), which echoes its key name back as the value. Do not infer
            this from key == value: a parametrized tag whose value equals its
            key name (CarMake=CarMake) is not plain.
      type: object
      required:
        - key
        - value
        - isPlain
      title: TagSchema
      description: A tag applied to an asset, as key/value.
    ContextItemSchema:
      properties:
        kind:
          type: string
          title: Kind
          description: '''file'', ''link'', or ''text''.'
        contextType:
          type: string
          title: Contexttype
          description: Semantic role, e.g. 'substantiation'.
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: Filename (file kind).
        mimeType:
          anyOf:
            - type: string
            - type: 'null'
          title: Mimetype
          description: MIME type (file kind).
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
          description: URL (link kind).
        linkName:
          anyOf:
            - type: string
            - type: 'null'
          title: Linkname
          description: Display name (link kind).
        content:
          anyOf:
            - type: string
            - type: 'null'
          title: Content
          description: Inline text content (text kind).
      type: object
      required:
        - kind
        - contextType
      title: ContextItemSchema
      description: A supporting file, link, or text block attached to an asset.
  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.