Listar Clientes
curl --request GET \
--url https://api.zynvo.uy/v1/enterprises/{rut}/customers \
--header 'Authorization: Bearer <token>' \
--header 'X-API-Key: <api-key>' \
--header 'X-Sandbox-Mode: <x-sandbox-mode>'import requests
url = "https://api.zynvo.uy/v1/enterprises/{rut}/customers"
headers = {
"X-Sandbox-Mode": "<x-sandbox-mode>",
"X-API-Key": "<api-key>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'X-Sandbox-Mode': '<x-sandbox-mode>',
'X-API-Key': '<api-key>',
Authorization: 'Bearer <token>'
}
};
fetch('https://api.zynvo.uy/v1/enterprises/{rut}/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zynvo.uy/v1/enterprises/{rut}/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"X-API-Key: <api-key>",
"X-Sandbox-Mode: <x-sandbox-mode>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zynvo.uy/v1/enterprises/{rut}/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Sandbox-Mode", "<x-sandbox-mode>")
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zynvo.uy/v1/enterprises/{rut}/customers")
.header("X-Sandbox-Mode", "<x-sandbox-mode>")
.header("X-API-Key", "<api-key>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zynvo.uy/v1/enterprises/{rut}/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Sandbox-Mode"] = '<x-sandbox-mode>'
request["X-API-Key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"doc_type": "RUC",
"doc_number": "214567890016",
"legal_name": "Cliente Ejemplo S.A.",
"fiscal_address": "Av. 8 de Octubre 1234",
"city": "Montevideo",
"department": "Montevideo",
"country": "Uruguay",
"country_code": "UY",
"notifications": [
{
"type": "EMAIL",
"destination": "cliente@example.com",
"enabled": true
}
]
}
]
}{
"error": {
"code": "INVALID_INPUT",
"message": "Los datos proporcionados no son válidos"
}
}Clientes
Listar Clientes
Obtiene la lista de clientes registrados para la empresa con filtros opcionales
GET
/
enterprises
/
{rut}
/
customers
Listar Clientes
curl --request GET \
--url https://api.zynvo.uy/v1/enterprises/{rut}/customers \
--header 'Authorization: Bearer <token>' \
--header 'X-API-Key: <api-key>' \
--header 'X-Sandbox-Mode: <x-sandbox-mode>'import requests
url = "https://api.zynvo.uy/v1/enterprises/{rut}/customers"
headers = {
"X-Sandbox-Mode": "<x-sandbox-mode>",
"X-API-Key": "<api-key>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'X-Sandbox-Mode': '<x-sandbox-mode>',
'X-API-Key': '<api-key>',
Authorization: 'Bearer <token>'
}
};
fetch('https://api.zynvo.uy/v1/enterprises/{rut}/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zynvo.uy/v1/enterprises/{rut}/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"X-API-Key: <api-key>",
"X-Sandbox-Mode: <x-sandbox-mode>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zynvo.uy/v1/enterprises/{rut}/customers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Sandbox-Mode", "<x-sandbox-mode>")
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zynvo.uy/v1/enterprises/{rut}/customers")
.header("X-Sandbox-Mode", "<x-sandbox-mode>")
.header("X-API-Key", "<api-key>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zynvo.uy/v1/enterprises/{rut}/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Sandbox-Mode"] = '<x-sandbox-mode>'
request["X-API-Key"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"doc_type": "RUC",
"doc_number": "214567890016",
"legal_name": "Cliente Ejemplo S.A.",
"fiscal_address": "Av. 8 de Octubre 1234",
"city": "Montevideo",
"department": "Montevideo",
"country": "Uruguay",
"country_code": "UY",
"notifications": [
{
"type": "EMAIL",
"destination": "cliente@example.com",
"enabled": true
}
]
}
]
}{
"error": {
"code": "INVALID_INPUT",
"message": "Los datos proporcionados no son válidos"
}
}Authorizations
API Key de Zynvo obtenida desde el dashboard. Requerida en todos los endpoints.
Token JWT obtenido del endpoint /tokens. Se debe enviar en el header Authorization como "Bearer {token}"
Headers
Define el entorno de ejecución de la API.
Valores:
"true"- Modo sandbox: Usa datos de prueba aislados"false"- Modo producción: Usa datos reales
Available options:
true, false Path Parameters
RUT de la empresa
Query Parameters
Filtrar por razón social (búsqueda parcial)
Filtrar por número de documento
Filtrar por código de país
Response
Lista de clientes
Show child attributes
Show child attributes
⌘I