Skip to Content
v1.5Documentación oficial de la API LX CloudPos · estable en producción
V1Referencia De EndpointsConsultar cliente

Consultar cliente

GET /api/v1/clientes/{identificacion}

Consulta un cliente por identificación — cédula física, jurídica, DIMEX o pasaporte. Ver Tipo de identificación.

Autenticación y permisos

AtributoValor
EsquemaAPI key (X-Api-Key)
Scope requeridocatalogo:read
Rate limit120 req/min por API key

Ejemplo

curl https://api.pos.lxsyscr.com/api/v1/clientes/117890123 \ -H "X-Api-Key: $LXS_API_KEY"

Respuestas

200 OK

{ "idCliente": 46, "identificacion": "117890123", "tipoIdentificacion": "01", "nombre": "Cliente Prueba", "apellidos": "Integracion API", "nombreInterno": null, "correo": "cliente.prueba@ejemplo.cr", "telefono": "8888-8888", "direccion": null, "comentario": null, "estado": true, "exonerado": false, "pagaTimbre": false, "limiteCredito": null }

404 Not Found

{ "error": "No existe un cliente con identificación '117890123'." }

Notas operativas

  • No filtra por estado: un cliente desactivado se devuelve de igual forma.