> ## 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 produtos > Operação sobre produtos 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 `products:read` ou `read`. Veja [campos, relacionamentos e eventos](https://docs.hubfy.io/api-reference/products/object.md). ## OpenAPI ````yaml api/v1/openapi.yaml GET /v1/products 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/products: get: tags: - Produtos summary: Listar produtos description: >- Lista os registros da conta, com paginação por cursor. Permissão: `products:read` ou `read`. Consulte a [visão geral](/api-reference/products/object) para campos e relacionamentos. operationId: listProduct parameters: - name: benefit in: query description: Filtra por igualdade; deve ser mantido ao usar um cursor. schema: type: string - 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 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/Product' has_more: type: boolean object: type: string const: list url: type: string example: data: - id: pro_1234567890abcdef benefit: null cover_url: null created_at: '2030-01-01T00:00:00.000Z' description: null metadata: {} name: Curso de exemplo object: product prices: - prc_1234567890abcdef status: draft updated_at: '2030-01-01T00:00:00.000Z' has_more: false object: list url: /v1/products '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: Product: type: object additionalProperties: false required: - id - benefit - cover_url - created_at - description - metadata - name - object - prices - status - updated_at properties: id: type: string pattern: ^pro_[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. benefit: type: - string - 'null' enum: - files - courses - links - null description: >- Tipo de conteúdo entregue: files (arquivos), courses (cursos) ou links (links). Pode ser null. Definir o tipo não vincula conteúdos ao produto. cover_url: type: - string - 'null' description: >- URL pública da capa do produto; null quando ausente. Somente leitura, definida no painel. 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 produto; null quando não informada. Envie null para limpar. 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. name: type: string description: Nome do produto. Obrigatório e não vazio na criação. object: const: product type: string description: Tipo do objeto retornado. O valor é fixo para este recurso. prices: type: array items: type: string pattern: ^prc_[a-z0-9]{16}$ description: >- IDs dos preços vinculados, ordenados por criação e ID. Consulte cada preço em /v1/prices/{id}. Somente leitura. status: type: string enum: - draft - published - archived description: >- Estado do produto: draft (rascunho), published (publicado) ou archived (arquivado). updated_at: type: string format: date-time description: >- Data e hora da última alteração, em ISO 8601 com fuso horário. Somente leitura. example: id: pro_1234567890abcdef benefit: null cover_url: null created_at: '2030-01-01T00:00:00.000Z' description: null metadata: {} name: Curso de exemplo object: product prices: - prc_1234567890abcdef status: draft updated_at: '2030-01-01T00:00:00.000Z' 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.