# Listar Compradores

## Lista buyers

> Retorna uma lista de buyers com base nos parâmetros de consulta fornecidos.

```json
{"openapi":"3.0.3","info":{"title":"API de Buyers","version":"2.0.0"},"servers":[{"url":"https://api.barte.com","description":"Servidor de Produção"},{"url":"https://sandbox-api.barte.com","description":"Servidor de Sandbox"}],"security":[{"X-Token-Api":[]}],"components":{"securitySchemes":{"X-Token-Api":{"type":"apiKey","name":"X-Token-Api","in":"header"}},"schemas":{"BuyerV2Response":{"type":"object","properties":{"uuid":{"type":"string"},"document":{"type":"string"},"name":{"type":"string"},"countryCode":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"},"alternativeEmail":{"type":"string"}}},"ErrorResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}},"metadata":{"$ref":"#/components/schemas/Metadata"}}},"ErrorDetail":{"type":"object","properties":{"status":{"type":"string"},"code":{"type":"string","enum":["PAYMENT-0000","PAYMENT-0500","PAYMENT-9999","BAR-7001","BAD_REQUEST","FORBIDDEN","METHOD_NOT_ALLOWED","NOT_ACCEPTABLE","UNSUPPORTED_MEDIA_TYPE"]},"title":{"type":"string","enum":["BUSINESS_SELLER","BUSINESS_CHECKOUT","BUSINESS_COMMON","BUSINESS_SECURITY","BUSINESS_SUBSCRIPTION","INVALID_REQUEST_PARAM","BUSINESS_METRIC","BUSINESS_ACCOUNTANCY","BUSINESS_NOTIFICATION","BUSINESS_BARTE","BUSINESS_COMPANY","BUSINESS_INVOICE","BUSINESS_TRANSFER","BUSINESS_CARD","BUSINESS_ORDER","card_not_supported"]},"description":{"type":"string"},"action":{"type":"string"},"additionalInfo":{"type":"object","additionalProperties":{"type":"object"}}}},"Metadata":{"type":"object","properties":{"totalRecords":{"type":"integer"},"totalPages":{"type":"integer"},"requestDatetime":{"type":"string","format":"date-time"}}}}},"paths":{"/v2/buyers":{"get":{"tags":["API v2 para criação de buyers"],"summary":"Lista buyers","description":"Retorna uma lista de buyers com base nos parâmetros de consulta fornecidos.","operationId":"listBuyers","parameters":[{"name":"document","in":"query","description":"Documento do buyer","schema":{"type":"string"}},{"name":"email","in":"query","description":"Email do buyer","schema":{"type":"string"}},{"name":"name","in":"query","description":"Nome do buyer","schema":{"type":"string"}},{"name":"page","in":"query","description":"Número da página para paginação","schema":{"type":"integer","default":0}},{"name":"size","in":"query","description":"Tamanho da página para paginação","schema":{"type":"integer","default":20}}],"responses":{"200":{"description":"Lista de buyers recuperada com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/BuyerV2Response"}},"totalElements":{"type":"integer"},"totalPages":{"type":"integer"},"page":{"type":"integer"},"size":{"type":"integer"}}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Acesso proibido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Erro interno do servidor","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.barte.com/api-reference/compradores/listar-compradores.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.