v1

latestOpenAPI 3.0.42026-08-064699207.1 KB
Clientes

Consulta una lista de clientes

Devuelve los clientes de la agencia aplicando los filtros indicados.

Requisitos:

  • clientes_read
get/api/v1/clientes

Query parameters

TiposClienteTipoCliente[]

Filtrar por tipo de cliente. (Ctrl para elegir varios)

Filtrar por tipo de cliente. (Ctrl para elegir varios)

IdGruposinteger[]

Grupos a los que peretenecen los clientes (puedes ver tus grupos en el endpoint GetGrupos/Clientes)

Grupos a los que peretenecen los clientes (puedes ver tus grupos en el endpoint GetGrupos/Clientes)

IdExcluyeGruposinteger[]

Grupos a los que no peretenecen los clientes (puedes ver tus grupos en el endpoint GetGrupos/Clientes)

Grupos a los que no peretenecen los clientes (puedes ver tus grupos en el endpoint GetGrupos/Clientes)

IdCampanainteger

IdCampaña (puedes ver tus campañas en el endpoint GetCampañas)

IdCampaña (puedes ver tus campañas en el endpoint GetCampañas)

UltimoContactoDesdestring date-time

Fecha mínima (inclusive) del último contacto. (YYYY-MM-DD HH:MM:SS)

Fecha mínima (inclusive) del último contacto. (YYYY-MM-DD HH:MM:SS)

UltimoContactoHastastring date-time

Fecha máxima (inclusive) del último contacto. (YYYY-MM-DD HH:MM:SS)

Fecha máxima (inclusive) del último contacto. (YYYY-MM-DD HH:MM:SS)

IdCuentainteger

IdCuenta (puedes ver tus cuentas en el endpoint GetCuentas)

IdCuenta (puedes ver tus cuentas en el endpoint GetCuentas)

FechaDesdestring date-time

Fecha mínima (inclusive) desde la que traer registros de alta. (YYYY-MM-DD HH:MM:SS)

Fecha mínima (inclusive) desde la que traer registros de alta. (YYYY-MM-DD HH:MM:SS)

FechaHastastring date-time

Fecha máxima (inclusive) hasta la que traer registros de alta. (YYYY-MM-DD HH:MM:SS)

Fecha máxima (inclusive) hasta la que traer registros de alta. (YYYY-MM-DD HH:MM:SS)

Busquedastring

Texto de búsqueda por coincidencia parcial (contiene) sobre el nombre o el email del cliente. Si el texto contiene dígitos, se busca además en todos los teléfonos del cliente (móvil, teléfono 2 y teléfono 3); el número se normaliza antes de comparar (se admiten espacios y prefijo internacional +34 o 0034). No distingue mayúsculas de minúsculas.

Texto de búsqueda por coincidencia parcial (contiene) sobre el nombre o el email del cliente. Si el texto contiene dígitos, se busca además en todos los teléfonos del cliente (móvil, teléfono 2 y teléfono 3); el número se normaliza antes de comparar (se admiten espacios y prefijo internacional +34 o 0034). No distingue mayúsculas de minúsculas.

OrdenarPor'FechaAlta' | 'NombreUsuario' | 'FechaUltimoContacto' | 'Referencia'
NumeroPaginainteger

Número de página a obtener (mínimo 1).

Número de página a obtener (mínimo 1).

TamanoPaginainteger

Número de elementos por página (máximo 100).

Número de elementos por página (máximo 100).

Ordenacion'Ascendente' | 'Descendente'

Response

OK

totalElementosinteger
paginainteger
tamanoPaginainteger