# Get buyers

# OpenAPI definition
```json
{
  "openapi": "3.0.0",
  "paths": {
    "/v2/buyers": {
      "get": {
        "description": "Gets all buyers associated with a seller.",
        "operationId": "BuyersController_getBuyers",
        "parameters": [
          {
            "name": "taxId",
            "required": false,
            "in": "query",
            "description": "CNPJ do comprador.",
            "schema": {
              "example": "56596567000127",
              "type": "string"
            }
          },
          {
            "name": "page",
            "required": false,
            "in": "query",
            "description": "Qual página retornar da lista de compradores. Começa em 1.",
            "schema": {
              "minimum": 1,
              "default": 1,
              "type": "number"
            }
          },
          {
            "name": "take",
            "required": false,
            "in": "query",
            "description": "Limite de compradores a serem retornados.",
            "schema": {
              "minimum": 1,
              "maximum": 100,
              "default": 20,
              "type": "number"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "description": "Lista de compradores.",
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "ID do comprador. (UUID)",
                            "example": "a0eebc4b-1f3d-4b2a-8c5f-7e6d5f8e9b2f"
                          },
                          "taxId": {
                            "type": "string",
                            "description": "CNPJ do comprador.",
                            "example": "56596567000127"
                          },
                          "availableCreditLimitAmountCents": {
                            "type": "number",
                            "description": "Limite de crédito disponível do comprador em centavos.",
                            "example": 100000
                          },
                          "creditLimitAmountCents": {
                            "type": "number",
                            "description": "Limite de crédito do comprador em centavos.",
                            "example": 100000
                          },
                          "eligible": {
                            "type": "boolean",
                            "description": "Se o comprador é elegível ou não para crédito.",
                            "example": true
                          },
                          "inactive": {
                            "type": "boolean",
                            "description": "Se o comprador está marcado como inativo.",
                            "example": false
                          },
                          "maxPaymentTermDays": {
                            "type": "number",
                            "description": "O prazo máximo de pagamento em dias."
                          },
                          "name": {
                            "type": "string",
                            "description": "Nome da empresa do comprador.",
                            "example": "Comprador Inexistente LTDA"
                          },
                          "onboarded": {
                            "type": "boolean",
                            "description": "Se o comprador completou ou não o processo de onboarding.",
                            "example": true
                          }
                        },
                        "required": [
                          "id",
                          "taxId",
                          "availableCreditLimitAmountCents",
                          "creditLimitAmountCents",
                          "eligible",
                          "inactive",
                          "maxPaymentTermDays",
                          "name",
                          "onboarded"
                        ],
                        "x-readme-ref-name": "BuyerResponseDto"
                      }
                    },
                    "page": {
                      "type": "number",
                      "description": "Número da página.",
                      "example": 1
                    },
                    "items": {
                      "type": "number",
                      "description": "Número de itens na página atual.",
                      "example": 20
                    },
                    "total": {
                      "type": "number",
                      "description": "Número total de itens em todas as páginas.",
                      "example": 100
                    }
                  },
                  "required": [
                    "data",
                    "page",
                    "items",
                    "total"
                  ],
                  "x-readme-ref-name": "GetBuyersResponseDto"
                }
              }
            }
          }
        },
        "summary": "Get buyers",
        "tags": [
          "Buyers"
        ]
      }
    }
  },
  "info": {
    "title": "Credipay API",
    "description": "",
    "version": "2.0",
    "contact": {}
  },
  "servers": [
    {
      "url": "https://api.pre.credix.finance",
      "description": "Sandbox"
    },
    {
      "url": "https://api.credix.finance",
      "description": "Production"
    }
  ],
  "components": {
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "in": "header",
        "name": "X-CREDIPAY-API-KEY"
      }
    }
  },
  "security": [
    {
      "api_key": []
    }
  ]
}
```