Obtiene los clientes de la empresa autenticada. Usa el alias /suite/erp/clientes/:tkCliente para consultar un cliente específico. La respuesta incluye el encabezado Row-Count con el total de registros antes de aplicar la paginación.
Rutas alternativas
/suite/erp/clientes/:tkCliente
Parámetros
Nombre
Tipo
Validación
Descripción
orden
varchar
Criterio de ordenamiento. Anteponer - solicita orden descendente.
esCliente
int
Indicador por el que se filtra el registro de empresa.
nombre
varchar
Parámetro reservado; actualmente no modifica el resultado de la consulta.
tkCliente
varchar
Identificador del cliente. En el alias de detalle se proporciona en la ruta.
buscar
varchar
Texto que se busca dentro del nombre de la empresa.
letra
varchar
Letra inicial del nombre de la empresa.
tkUsuario
varchar
Identificador del ejecutivo asignado al cliente.
tkIndustria
varchar
Identificador de la industria con la que se filtran los clientes.
tkCorporativo
varchar
Identificador del corporativo con el que se filtran los clientes.
idPais
varchar
Código de país con el que se filtran los clientes.
idEstado
varchar
Código de estado con el que se filtran los clientes.
texto
varchar
Texto que se busca en el nombre, teléfono corporativo o ciudad del cliente.
pagina
int
Número de página que se consulta. Usa 0 para obtener hasta los primeros 1000 registros.
cantidadRegistros
int
Cantidad máxima de clientes que se devuelve por página.
Respuesta
Nombre
Tipo
Descripción
indice
Integer
Posición del cliente dentro del resultado.
tkEmpresa
String
Identificador único del cliente.
esCliente
Integer
Indicador del tipo de registro de empresa.
empresa
String
Nombre comercial del cliente.
idExterno
String
Identificador externo del cliente, si fue registrado.
tkCorporativo
String
Identificador del corporativo asociado, si existe.
tkIndustria
String
Identificador de la industria asociada, si existe.
tkUsuario
String
Identificador del ejecutivo asignado, si existe.
ejecutivoNombre
String
Nombre del ejecutivo asignado.
telefonoCorporativo
String
Teléfono corporativo registrado.
fechaCreacion
String
Fecha y hora en que se creó el cliente.
ultimaModificacion
String
Fecha y hora de la última modificación, si existe.
idPais
String
Código de país del domicilio comercial.
idEstado
String
Código de estado del domicilio comercial.
numeroEmpleados
Integer
Número de empleados registrado para el cliente.
numeroContactos
Integer
Número de contactos activos asociados al cliente.
tkRazonSocial
String
Identificador de la razón social predeterminada, si existe.
razonSocial
String
Razón social predeterminada del cliente.
rfc
String
RFC de la razón social predeterminada.
idUsoCfdi
Integer
Código de uso de CFDI de la razón social.
nombreContacto
String
Nombre del contacto principal, si existe.
correoContacto
String
Correo del contacto principal, si existe.
Solicitud
Consultar clientes
curl --request GET \
--url 'https://api.upnify.com/suite/erp/clientes?pagina=1&cantidadRegistros=50' \
--header 'token: 00000000-0000-4000-8000-000000000001'fetch("https://api.upnify.com/suite/erp/clientes?pagina=1&cantidadRegistros=50", { method: "GET", headers: { token: "00000000-0000-4000-8000-000000000001" } }).then((respuesta) => respuesta.json()).then(console.log);// Node.js 18 o posterior
fetch("https://api.upnify.com/suite/erp/clientes?pagina=1&cantidadRegistros=50", { method: "GET", headers: { token: "00000000-0000-4000-8000-000000000001" } }).then((respuesta) => respuesta.json()).then(console.log);import requests
respuesta = requests.get("https://api.upnify.com/suite/erp/clientes?pagina=1&cantidadRegistros=50", headers={"token": "00000000-0000-4000-8000-000000000001"})
respuesta.raise_for_status()
print(respuesta.json())package main
import (
"encoding/json"
"net/http"
)
func main() {
solicitud, err := http.NewRequest(http.MethodGet, "https://api.upnify.com/suite/erp/clientes?pagina=1&cantidadRegistros=50", nil)
if err != nil { panic(err) }
solicitud.Header.Set("token", "00000000-0000-4000-8000-000000000001")
respuesta, err := http.DefaultClient.Do(solicitud)
if err != nil { panic(err) }
defer respuesta.Body.Close()
var resultado any
if err := json.NewDecoder(respuesta.Body).Decode(&resultado); err != nil { panic(err) }
}using System.Net.Http;
using System.Net.Http.Json;
using var cliente = new HttpClient();
cliente.DefaultRequestHeaders.Add("token", "00000000-0000-4000-8000-000000000001");
using var respuesta = await cliente.GetAsync("https://api.upnify.com/suite/erp/clientes?pagina=1&cantidadRegistros=50");
respuesta.EnsureSuccessStatusCode();
var resultado = await respuesta.Content.ReadFromJsonAsync<object>();
