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

# List

> List the workspace's assets, with filters and cursor pagination

CLI: `adside assets list`



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/workspaces/{workspaceId}/assets
openapi: 3.1.0
info:
  title: Adside API
  version: 1.0.0
  description: >-
    Campaigns, creatives, assets and reporting across your ad accounts. Call it
    with a personal API key as a bearer token, or with the `adside` CLI: each
    page names its command.
servers:
  - url: https://api.adside.ai
    description: Production
security:
  - userAccess: []
tags:
  - name: Account
  - name: Reporting
  - name: Meta
  - name: Google Ads
  - name: LinkedIn
  - name: TikTok
  - name: Reddit
  - name: Snapchat
  - name: X
  - name: Google Tag Manager
  - name: Creatives
  - name: Creative styles
  - name: Media
  - name: Characters
  - name: Assets
  - name: Brands
  - name: Brain
  - name: Research
  - name: Boards
  - name: Artifacts
  - name: Audiences
  - name: Ad comments
  - name: Publications
  - name: Routines
  - name: Skills
  - name: To-dos
  - name: Audit
  - name: Credits
paths:
  /v1/workspaces/{workspaceId}/assets:
    get:
      tags:
        - Assets
      summary: List
      description: |-
        List the workspace's assets, with filters and cursor pagination

        CLI: `adside assets list`
      operationId: assets.list
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: search
          in: query
          required: false
          schema:
            type: string
            maxLength: 200
          style: form
          explode: true
        - name: sourceType
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - SCRAPED
                - UPLOADED
                - GENERATED
                - DERIVED
                - GOOGLE_DRIVE
                - CANVA
                - FIGMA
                - META_AD
                - PLATFORM_IMPORT
                - SLACK
          style: form
          explode: true
        - name: category
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - UNKNOWN
                - LOGO
                - PRODUCT
                - LIFESTYLE
                - BANNER
                - ICON
                - BACKGROUND
                - SCREENSHOT
                - AD_CREATIVE
                - OTHER
          style: form
          explode: true
        - name: tags
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              minLength: 1
          style: form
          explode: true
        - name: mediaType
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - image
                - video
          style: form
          explode: true
        - name: dateAddedFrom
          in: query
          required: false
          schema:
            type: string
            format: date-time
            pattern: >-
              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
          style: form
          explode: true
        - name: dateAddedTo
          in: query
          required: false
          schema:
            type: string
            format: date-time
            pattern: >-
              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
          style: form
          explode: true
        - name: minSizeBytes
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            maximum: 9007199254740991
          style: form
          explode: true
        - name: maxSizeBytes
          in: query
          required: false
          schema:
            type: integer
            exclusiveMinimum: 0
            maximum: 9007199254740991
          style: form
          explode: true
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - PENDING
              - PROCESSING
              - READY
              - FAILED
              - ARCHIVED
              - PENDING_DELETION
          style: form
          explode: true
        - name: limit
          in: query
          required: false
          schema:
            default: 50
            type: integer
            minimum: 1
            maximum: 100
          style: form
          explode: true
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          style: form
          explode: true
        - name: sortBy
          in: query
          required: false
          schema:
            default: createdAt
            type: string
            enum:
              - createdAt
              - name
              - fileSize
          style: form
          explode: true
        - name: sortOrder
          in: query
          required: false
          schema:
            default: desc
            type: string
            enum:
              - asc
              - desc
          style: form
          explode: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  assets:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          anyOf:
                            - type: string
                            - type: 'null'
                        description:
                          anyOf:
                            - type: string
                            - type: 'null'
                        url:
                          anyOf:
                            - type: string
                            - type: 'null'
                        mimeType:
                          type: string
                        fileSize:
                          type: number
                        width:
                          anyOf:
                            - type: number
                            - type: 'null'
                        height:
                          anyOf:
                            - type: number
                            - type: 'null'
                        status:
                          type: string
                          enum:
                            - PENDING
                            - PROCESSING
                            - READY
                            - FAILED
                            - ARCHIVED
                            - PENDING_DELETION
                        sourceType:
                          type: string
                          enum:
                            - SCRAPED
                            - UPLOADED
                            - GENERATED
                            - DERIVED
                            - GOOGLE_DRIVE
                            - CANVA
                            - FIGMA
                            - META_AD
                            - PLATFORM_IMPORT
                            - SLACK
                        category:
                          type: string
                          enum:
                            - UNKNOWN
                            - LOGO
                            - PRODUCT
                            - LIFESTYLE
                            - BANNER
                            - ICON
                            - BACKGROUND
                            - SCREENSHOT
                            - AD_CREATIVE
                            - OTHER
                        tags:
                          type: array
                          items:
                            type: string
                        createdAt:
                          type: string
                          format: date-time
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                        workspaceId:
                          type: string
                        sourceMetadata:
                          anyOf:
                            - {}
                            - type: 'null'
                        derivedFromId:
                          anyOf:
                            - type: string
                            - type: 'null'
                        createdById:
                          anyOf:
                            - type: string
                            - type: 'null'
                        updatedAt:
                          type: string
                          format: date-time
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                        platformAssetReferences:
                          default: []
                          type: array
                          items:
                            type: object
                            properties:
                              platform:
                                type: string
                              externalAccountId:
                                type: string
                              externalAssetId:
                                type: string
                              externalName:
                                anyOf:
                                  - type: string
                                  - type: 'null'
                            required:
                              - platform
                              - externalAccountId
                              - externalAssetId
                              - externalName
                            additionalProperties: false
                      required:
                        - id
                        - name
                        - description
                        - url
                        - mimeType
                        - fileSize
                        - width
                        - height
                        - status
                        - sourceType
                        - category
                        - tags
                        - createdAt
                        - workspaceId
                        - sourceMetadata
                        - derivedFromId
                        - createdById
                        - updatedAt
                        - platformAssetReferences
                      additionalProperties: false
                  nextCursor:
                    type: string
                  total:
                    type: number
                  totalUnfiltered:
                    type: number
                required:
                  - assets
                  - total
                  - totalUnfiltered
                additionalProperties: false
      security:
        - userAccess: []
components:
  securitySchemes:
    userAccess:
      type: http
      scheme: bearer
      description: >-
        A personal API key (`adside_pat_…`) or a token from `adside login`.
        Either carries the permissions of the person it belongs to.

````

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