# Obter compradores

Obtém todos os compradores associados a um vendedor.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/v2/buyers": {
      "get": {
        "description": "Obtém todos os compradores associados a um vendedor.",
        "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": "Operação bem-sucedida.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetBuyersResponseDto"
                }
              }
            }
          }
        },
        "summary": "Obter compradores",
        "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"
      }
    },
    "schemas": {
      "BuyerGroupMemberDto": {
        "type": "object",
        "properties": {
          "taxId": {
            "type": "string",
            "description": "CNPJ do membro do grupo.",
            "example": "56596567000127"
          },
          "name": {
            "type": "string",
            "description": "Nome do membro do grupo.",
            "example": "Comprador Inexistente LTDA"
          }
        },
        "required": [
          "taxId",
          "name"
        ]
      },
      "BuyerResponseDto": {
        "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
          },
          "creditLimitUpdatedAt": {
            "type": "string",
            "description": "Data de atualização do limite de crédito do comprador.",
            "example": "2021-01-01T00:00:00.000Z"
          },
          "eligible": {
            "type": "boolean",
            "description": "Se o comprador é elegível ou não para crédito.",
            "example": true,
            "deprecated": true
          },
          "eligibilityUpdatedAt": {
            "type": "string",
            "description": "Data de atualização da elegibilidade do comprador.",
            "example": "2021-01-01T00:00:00.000Z"
          },
          "inactive": {
            "type": "boolean",
            "description": "Se o comprador está marcado como inativo.",
            "example": false
          },
          "frozen": {
            "type": "boolean",
            "description": "Se o comprador está congelado.",
            "example": false
          },
          "needMoreInfo": {
            "type": "boolean",
            "description": "Se o comprador precisa de informações adicionais para análise.",
            "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
          },
          "disbursementSchedulingStrategy": {
            "type": "string",
            "description": "Estratégia efetiva de agendamento do desembolso do segmento do comprador (resolvida via Statsig — OnAssetCreation quando a flag está OFF). OnAssetCreation = antecipação; OnAssetDueDate / OnBuyerPayment = no-anticipation. Presente apenas no path de comprador único (taxId); ausente na listagem paginada.",
            "example": "OnAssetCreation",
            "enum": [
              "OnAssetCreation",
              "OnBuyerPayment",
              "OnAssetDueDate"
            ]
          },
          "disbursementDelayDays": {
            "type": "number",
            "description": "Dias adicionados à data base (vencimento ou pagamento do comprador) para definir a data de desembolso. 0 para antecipação. Presente apenas no path de comprador único (taxId).",
            "example": 0
          },
          "groupMembers": {
            "description": "Membros do grupo do comprador.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BuyerGroupMemberDto"
            }
          }
        },
        "required": [
          "id",
          "taxId",
          "availableCreditLimitAmountCents",
          "creditLimitAmountCents",
          "creditLimitUpdatedAt",
          "eligible",
          "eligibilityUpdatedAt",
          "inactive",
          "frozen",
          "needMoreInfo",
          "maxPaymentTermDays",
          "name",
          "onboarded",
          "groupMembers"
        ]
      },
      "GetBuyersResponseDto": {
        "type": "object",
        "properties": {
          "data": {
            "description": "Lista de compradores.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/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"
        ]
      }
    }
  },
  "security": [
    {
      "api_key": []
    }
  ]
}
```