---
title: "Histórico de consultas CNPJ - Listar."
url: "https://devcenter.stone.com.br/apis/stone-tax/versions/206fd1c1-6382-4ada-8612-c67fdc65e050/paths/api-v1-RecursosAdicionais-Cnpj-HistoricoConsulta-Listar/get"
---

> Full API specification: https://devcenter.stone.com.br/apis/stone-tax/versions/206fd1c1-6382-4ada-8612-c67fdc65e050.md

# Histórico de consultas CNPJ - Listar.

`GET` `/api/v1/RecursosAdicionais/Cnpj/HistoricoConsulta/Listar`

Permite <strong>listar</strong> consultas de CNPJ realizadas. O recurso retorna uma relação resumida das consultas, possibilitando a identificação de quais CNPJs foram consultados em um determinado período. 📋 **PAGINAÇÃO**: A listagem utiliza o padrão de <strong>offset e limit</strong>. É recomendável parametrizar o tamanho da página para otimizar o tempo de resposta e o tráfego de dados. 🔍 **FILTROS**: É possível refinar os resultados utilizando intervalos de datas ou filtro para localizar registros específicos no histórico.

## Query parameters

- `filtro` (string, optional) - Filtrar pelo filtro utilizado na consulta.
- `dataConsultaInicial` (string, date-time, optional) - Filtrar pela data de consulta "a partir de".
- `dataConsultaFinal` (string, date-time, optional) - Filtrar pela data de consulta "até".
- `offset` (integer, int32, optional) - Quantidade de registros a serem pulados.
- `limit` (integer, int32, optional) - Limite máximo de registros por página.

## Header parameters

- `DocumentoEmissor` (string, optional) - Documento do emissor.

## Responses

- `200` - OK
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `500` - Internal Server Error

## OpenAPI definition

```yaml
openapi: 3.0.4
info:
  title: Stone Tax API
  version: 1.0.0
servers:
  - url: https://stone-tax-sdx.stone.com.br
    description: Ambiente de Desenvolvimento
  - url: https://stone-tax.stone.com.br
    description: Ambiente de Produção
paths:
  /api/v1/RecursosAdicionais/Cnpj/HistoricoConsulta/Listar:
    get:
      tags:
        - RecursosAdicionais
      summary: Histórico de consultas CNPJ - Listar.
      description: >-
        Permite <strong>listar</strong> consultas de CNPJ realizadas. O recurso
        retorna uma relação resumida das consultas, possibilitando a
        identificação de quais CNPJs foram consultados em um determinado
        período.


        📋 **PAGINAÇÃO**: A listagem utiliza o padrão de <strong>offset e
        limit</strong>. É recomendável parametrizar o tamanho da página para
        otimizar o tempo de resposta e o tráfego de dados.


        🔍 **FILTROS**: É possível refinar os resultados utilizando intervalos
        de datas ou filtro para localizar registros específicos no histórico.
      parameters:
        - name: filtro
          in: query
          description: Filtrar pelo filtro utilizado na consulta.
          schema:
            type: string
        - name: dataConsultaInicial
          in: query
          description: Filtrar pela data de consulta "a partir de".
          schema:
            type: string
            format: date-time
        - name: dataConsultaFinal
          in: query
          description: Filtrar pela data de consulta "até".
          schema:
            type: string
            format: date-time
        - name: offset
          in: query
          description: Quantidade de registros a serem pulados.
          schema:
            type: integer
            format: int32
            default: 1
        - name: limit
          in: query
          description: Limite máximo de registros por página.
          schema:
            type: integer
            format: int32
            default: 10
        - name: DocumentoEmissor
          in: header
          description: Documento do emissor.
          schema:
            type: string
      responses:
        "200":
          description: OK
          content:
            text/plain:
              schema:
                $ref: "#/components/schemas/ListarConsultasCnpjAplicacaoViewModelListPagination\
                  Response"
            application/json:
              schema:
                $ref: "#/components/schemas/ListarConsultasCnpjAplicacaoViewModelListPagination\
                  Response"
            text/json:
              schema:
                $ref: "#/components/schemas/ListarConsultasCnpjAplicacaoViewModelListPagination\
                  Response"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
      security:
        - BearerAuth: []
security:
  - BearerAuth: []
components:
  schemas:
    ListarConsultasCnpjAplicacaoViewModelListPaginationResponse:
      type: object
      properties:
        offset:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
        total:
          type: integer
          format: int32
        data:
          type: array
          items:
            $ref: "#/components/schemas/ListarConsultasCnpjAplicacaoViewModel"
          nullable: true
      additionalProperties: false
    ResponseErrorResult:
      type: object
      properties:
        status:
          type: integer
          format: int32
        titulo:
          type: string
          nullable: true
        erros:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          nullable: true
      additionalProperties: false
    ListarConsultasCnpjAplicacaoViewModel:
      type: object
      properties:
        id:
          type: string
          description: Identificador único da consulta.
          format: uuid
        filtro:
          type: string
          description: Filtro utilizado na consulta (CNPJ).
          nullable: true
        statusConsulta:
          $ref: "#/components/schemas/StatusHistoricoConsultaCnpjModelEnum"
        dataConsulta:
          type: string
          description: Data e hora em que a consulta foi registrada.
          format: date-time
      additionalProperties: false
      description: Dados para listagem do histórico de consultas do CNPJ.
    StatusHistoricoConsultaCnpjModelEnum:
      enum:
        - Sucesso
        - NaoEncontrado
        - Falha
      type: string
      description: Status da consulta de CNPJ.
  securitySchemes:
    BearerAuth:
      type: http
      description: Autenticação via token JWT. Obtenha o token através do endpoint
        /Autenticacao/ObterToken usando Basic Auth. O token expira em 1 hora.
      scheme: bearer
      bearerFormat: JWT
```