Consultar cliente por identificación

Busca un cliente por su tipo y número de identificación usando el endpoint GET /v1/clientes con los parámetros tipoId e id como query params. Cuando ambos parámetros están presentes, el servicio retorna el cliente específico en lugar del listado paginado.

Parámetros requeridos

ParámetroTipoDescripción
tipoIdstringTipo de identificación: CC, NIT, PS, DE, etc.
idstringNúmero de identificación del cliente. Máx. 30 caracteres.

Ejemplo de solicitud

GET /v1/clientes?tipoId=CC&id=1234567890

Reglas de negocio

  • tipoId e id deben enviarse juntos; si solo se envía uno, el servicio ignora el filtro y retorna el listado paginado.
  • Si no se encuentra el cliente, retorna 404.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
Defaults to 0

Número de registros a omitir (base 0)

integer
≤ 100
Defaults to 20

Cantidad máxima de registros a retornar. Si se supera 100, retorna 400.

string

Campo por el cual ordenar los resultados

string
length ≤ 6

Tipo de identificación del cliente (CC, NIT, PS, DE, etc.). Cuando se envía junto con id, retorna el cliente específico en lugar del listado.

string
length ≤ 30

Número de identificación del cliente. Debe enviarse junto con tipoId.

Responses

400

El parámetro limit supera el máximo permitido (100)

500

Error interno del servidor

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json