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

# Listar arquivos

> Operação sobre arquivos da conta.

Retorna uma lista paginada, da criação mais recente para a mais antiga. Consulte os filtros abaixo e mantenha-os ao percorrer as páginas.

Requer `assets:read` ou `read`. Veja [campos, relacionamentos e eventos](https://docs.hubfy.io/api-reference/assets/object.md).


## OpenAPI

````yaml api/v1/openapi.yaml GET /v1/assets
openapi: 3.1.0
info:
  title: Hubfy API
  version: 1.0.0
  description: >-
    API pública da Hubfy para produtos, preços, arquivos, clientes, pedidos e
    links de pagamento. Autenticação por chave da conta. GET consulta; POST
    cria, atualiza ou executa ações; DELETE remove ou desativa. O ambiente usa
    dados reais, sem sandbox separado. Consulte os fundamentos, os objetos e os
    eventos em https://docs.hubfy.io/api-reference/introduction.
servers:
  - url: https://api.hubfy.io
security:
  - apiKeyAuth: []
tags:
  - name: Produtos
    description: Objeto Product. Campos e relacionamentos na visão geral.
  - name: Preços
    description: Objeto Price. Campos e relacionamentos na visão geral.
  - name: Arquivos
    description: Objeto Asset. Campos e relacionamentos na visão geral.
  - name: Clientes
    description: Objeto Customer. Campos e relacionamentos na visão geral.
  - name: Pedidos
    description: Objeto Order. Campos e relacionamentos na visão geral.
  - name: Links de pagamento
    description: Objeto PaymentLink. Campos e relacionamentos na visão geral.
  - name: Fundamentos da API
    description: Conexão e identificação da API.
paths:
  /v1/assets:
    get:
      tags:
        - Arquivos
      summary: Listar arquivos
      description: >-
        Lista os registros da conta, com paginação por cursor.


        Permissão: `assets:read` ou `read`. Consulte a [visão
        geral](/api-reference/assets/object) para campos e relacionamentos.
      operationId: listAsset
      parameters:
        - name: ending_before
          in: query
          schema:
            type: string
          description: >-
            ID para percorrer a lista na direção anterior. Não combine com
            starting_after.
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
          description: Número de itens, de 1 a 100; padrão 50.
        - name: starting_after
          in: query
          schema:
            type: string
          description: ID do último item da página anterior. Não combine com ending_before.
        - name: status
          in: query
          description: Filtra por igualdade; deve ser mantido ao usar um cursor.
          schema:
            type: string
        - name: type
          in: query
          description: Filtra por igualdade; deve ser mantido ao usar um cursor.
          schema:
            type: string
      responses:
        '200':
          description: Operação concluída
          headers:
            X-Request-Id:
              description: Identifier of this HTTP request
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - data
                  - has_more
                  - object
                  - url
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Asset'
                  has_more:
                    type: boolean
                  object:
                    type: string
                    const: list
                  url:
                    type: string
              example:
                data:
                  - id: ast_1234567890abcdef
                    created_at: '2030-01-01T00:00:00.000Z'
                    description: null
                    file:
                      checksum: null
                      filename: material.pdf
                    metadata: {}
                    mime_type: application/pdf
                    object: asset
                    size_bytes: null
                    status: uploading
                    title: Material de apoio
                    type: file
                    updated_at: '2030-01-01T00:00:00.000Z'
                    video: null
                has_more: false
                object: list
                url: /v1/assets
        '400':
          $ref: '#/components/responses/ApiFailure'
        '401':
          $ref: '#/components/responses/ApiFailure'
        '403':
          $ref: '#/components/responses/ApiFailure'
        '404':
          $ref: '#/components/responses/ApiFailure'
        '409':
          $ref: '#/components/responses/ApiFailure'
        '429':
          $ref: '#/components/responses/ApiFailure'
        '500':
          $ref: '#/components/responses/ApiFailure'
        '502':
          $ref: '#/components/responses/ApiFailure'
        '503':
          $ref: '#/components/responses/ApiFailure'
      security:
        - apiKeyAuth: []
components:
  schemas:
    Asset:
      type: object
      additionalProperties: false
      required:
        - id
        - created_at
        - description
        - file
        - metadata
        - mime_type
        - object
        - size_bytes
        - status
        - title
        - type
        - updated_at
        - video
      properties:
        id:
          type: string
          pattern: ^ast_[a-z0-9]{16}$
          description: >-
            Identificador público estável. Use o valor retornado pela API nas
            consultas e relacionamentos; não derive IDs de nomes.
        created_at:
          type: string
          format: date-time
          description: >-
            Data e hora da criação, em ISO 8601 com fuso horário. Somente
            leitura.
        description:
          type:
            - string
            - 'null'
          description: Descrição do item. Pode ser null; envie null para limpar.
        file:
          oneOf:
            - type: object
              additionalProperties: false
              required:
                - checksum
                - filename
              properties:
                checksum:
                  type:
                    - string
                    - 'null'
                  description: >-
                    Checksum do arquivo, quando disponível; null quando não
                    informado.
                filename:
                  type: string
                  description: Nome original do arquivo, incluindo a extensão.
            - type: 'null'
          description: >-
            Detalhes do arquivo quando type é file. Null para vídeos. Somente
            leitura.
        metadata:
          type: object
          additionalProperties: true
          description: >-
            Objeto JSON livre para referências da integração, limitado a 16 KB.
            Ao enviar, substitui todo o metadata anterior; use {} para limpar.
            Não aceita null.
        mime_type:
          type:
            - string
            - 'null'
          description: >-
            Tipo MIME do arquivo, como application/pdf. Pode ser null. Informado
            no início do upload de arquivo; não é editável depois.
        object:
          const: asset
          type: string
          description: Tipo do objeto retornado. O valor é fixo para este recurso.
        size_bytes:
          type:
            - integer
            - 'null'
          description: >-
            Tamanho do conteúdo em bytes, preenchido pela
            verificação/processamento. Pode ser null enquanto desconhecido.
            Somente leitura.
        status:
          type: string
          enum:
            - uploading
            - processing
            - ready
            - failed
            - deleted
          description: >-
            Estado do envio: uploading, processing, ready ou failed. deleted
            indica exclusão; itens excluídos não aparecem nas consultas normais.
            Somente leitura.
        title:
          type: string
          description: >-
            Título do item na biblioteca. Obrigatório na criação, não vazio e
            com até 300 caracteres no início do upload.
        type:
          type: string
          enum:
            - file
            - video
          description: >-
            Variante do conteúdo: file ou video. Definida pela operação de
            criação e não editável.
        updated_at:
          type: string
          format: date-time
          description: >-
            Data e hora da última alteração, em ISO 8601 com fuso horário.
            Somente leitura.
        video:
          oneOf:
            - type: object
              additionalProperties: false
              required:
                - duration_seconds
                - height
                - progress
                - width
              properties:
                duration_seconds:
                  type:
                    - integer
                    - 'null'
                  description: Duração do vídeo em segundos; null enquanto desconhecida.
                height:
                  type:
                    - integer
                    - 'null'
                  description: Altura do vídeo em pixels; null enquanto desconhecida.
                progress:
                  type:
                    - number
                    - 'null'
                  description: >-
                    Percentual de processamento informado, de 0 a 100; pode ser
                    null.
                width:
                  type:
                    - integer
                    - 'null'
                  description: Largura do vídeo em pixels; null enquanto desconhecida.
            - type: 'null'
          description: >-
            Detalhes do vídeo quando type é video. Null para arquivos. Somente
            leitura.
      example:
        id: ast_1234567890abcdef
        created_at: '2030-01-01T00:00:00.000Z'
        description: null
        file:
          checksum: null
          filename: material.pdf
        metadata: {}
        mime_type: application/pdf
        object: asset
        size_bytes: null
        status: uploading
        title: Material de apoio
        type: file
        updated_at: '2030-01-01T00:00:00.000Z'
        video: null
    ApiError:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
            - doc_url
            - message
            - param
            - type
          properties:
            code:
              type: string
            doc_url:
              type:
                - string
                - 'null'
            message:
              type: string
            param:
              type:
                - string
                - 'null'
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - rate_limit_error
                - api_error
      example:
        error:
          code: invalid_parameter
          doc_url: null
          message: The request contains invalid parameters
          param: null
          type: invalid_request_error
  responses:
    ApiFailure:
      description: A operação não foi concluída
      headers:
        X-Request-Id:
          description: Identifier of this HTTP request
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            error:
              code: invalid_parameter
              doc_url: null
              message: The request contains invalid parameters
              param: null
              type: invalid_request_error
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API key

````

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