Venflow API
V1Clientes

Listar todos los clientes

GET
/v1/customers
Api-Key<token>

Tu clave API privada (comienza con pvk_)

In: header

Organization<token>

Tu ID de organización

In: header

Query Parameters

limit?integer

Límite en el número de objetos a devolver. El límite puede estar entre 1 y 100, y el valor predeterminado es 10

Range1 <= value <= 100
starting_after?string

Un cursor para paginación. starting_after es un ID de objeto que define tu posición en la lista

Formatuuid
ending_before?string

Un cursor para paginación. ending_before es un ID de objeto que define tu posición en la lista

Formatuuid
email?string

Un filtro sensible a mayúsculas/minúsculas basado en el campo de email del cliente

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.venflow.app/v1/customers"
{
  "data": [
    {
      "address": "string",
      "company_name": "string",
      "created": 0.1,
      "email": "string",
      "external_id": "string",
      "id": "string",
      "is_active": true,
      "last_name": "string",
      "livemode": true,
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "name": "string",
      "object": "customer",
      "phone": "string",
      "tax_id": {
        "type": "string",
        "value": "string"
      },
      "tax_withholding_rate": 0
    }
  ],
  "has_more": true,
  "object": "list",
  "url": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}