Upnify API Docs
CRM · /prospectos

Prospectos

Lista Prospectos

GET/prospectos

Permite obtener la lista de los prospectos registrados en el sistema.

Parámetros

NombreTipoValidaciónDescripción
ordenvarchar
filtersvarchar
paginaint
cantidadRegistrosint
aprobacionEstadoIntegerIndica el status de asignacion de contacto a compania.
  • 0 Aprobado.
  • 1 Pendiente.
  • 2 Rechazado.
canalizadoIntegerIndica si el contacto ha sido canalizado.
  • 0 No canalizado.
  • 1 Canalizado.
compartidoIntegerIndica si el contacto ha sido compartido.
  • 0 No compartido.
  • 1 Compartido.
tkUsuarioStringPermite filtrar los registros por un usuario en particular.
tkGrupoStringPermite filtrar los registros por un grupo en particular.
tkIndustriaStringPermite filtrar los registros por una industria en particular.
tkEtiquetaStringPermite filtrar los registros por una etiqueta en particular.
tkFaseStringPermite filtrar los registros por una fase en particular.
tkOrigenStringPermite filtrar los registros por un origen en particular.
tkCorporativoStringPermite filtrar los registros por un corporativo en particular.
idPaisStringPermite filtrar los registros por un país en particular.
idEstadoStringPermite filtrar los registros por un estado/región en particular.
sexoStringPermite filtrar los registros por un genero en particular.
  • H Hombre.
  • M Mujer.
puestoStringPermite filtrar los registros por un puesto en particular.
textoStringPermite filtrar los registros por un texto en particular.
periodoIntegerPermite filtrar los registros por fecha de creación.
fechaInicioDatePermite filtrar los registros a partir de esta fecha.
fechaFinDatePermite filtrar los registros hasta esta fecha.
periodoUltimoContactoIntegerPermite filtrar los registros por fecha de último seguimiento.

Respuesta

NombreTipoDescripción
indiceIntegerDefine la posición del registro respecto a los demás registros.
propioIntegerDefine si el registro pertenece al usuario de la sesion.
compartidoIntegerIndica si el prospecto se encuentra actualmente compartido.
compartidoConmigoIntegerIndica si el prospecto se encuentra actualmente compartido con el usuario de la sesion.
archivadoIntegerIndica si el prospecto se encuentra archivado.
puedeCompartir=0IntegerCódigo que indica si el ejecutivo de la sesion tiene permitido compartir el prospecto.
puedeReasignar=0IntegerCódigo que indica si el ejecutivo de la sesion tiene permitido reasignar el prospecto.
puedeDescartar=0IntegerCódigo que indica si el ejecutivo de la sesion tiene permitido descartar el prospecto.
ventaDirecta=0IntegerCódigo que indica si el ejecutivo de la sesion tiene permitido crearle una venta directa al prospecto.
puedeArchivar=0IntegerCódigo que indica si el ejecutivo de la sesion tiene permitido archivar el prospecto.
puedeReactivar=0IntegerCódigo que indica si el ejecutivo de la sesion tiene permitido reactivar el prospecto.
puedeCrearOportunidad=0IntegerCódigo que indica si el ejecutivo de la sesion tiene permitido crearle una oportunidad al prospecto.
puedeAprobar=0IntegerCódigo que indica si el ejecutivo de la sesion tiene permitido ligar el prospecto a una empresa.
puedeRechazar=0IntegerCódigo que indica si el ejecutivo de la sesion tiene permitido rechazar la peticion de ligar el prospecto a una empresa.
puedeEtiquetar=0IntegerCódigo que indica si el ejecutivo de la sesion tiene permitido etiquetar el prospecto.
puedeDarSeguimiento=0IntegerCódigo que indica si el ejecutivo de la sesion tiene permitido dar seguimiento al prospecto.
correoValidoIntegerIndica si el correo del contacto es o no valido.
esCanalizadoIntegerAlmacena un código que define si el registro se encuentra canalizado o compartido.
esClienteIntegerDefine si el registro es o no cliente.
descartadoIntegerDefine si el registro está o no descartado.
tieneArchivosIntegerCódigo que indica si el prospecto tiene archivos asociados.
aprobacionEstadoIntegerCódigo que indica si el prospecto necesita ser aprobado por el dueño de la compañia con la cual se registró el prospecto.
movilValidoIntegerCódigo que indica si el móvil registrado ha sido validado.
empresaEsClienteBooleanCódigo que indica si la empresa a la que pertenece el prospecto es cliente.
tkProspectoUUIDCódigo token que identifica de forma única a un prospecto dentro el sistema.
contactoStringGuarda el nombre completo del prospecto, uniendo nombre y apellido.
nombreStringContiene el nombre del prospecto.
apellidosStringContiene los apellidos del prospecto.
fechaContactoDateTimeContiene un formato compuesto de fecha y hora, el cual indica la fecha del primer contacto con el prospecto.
tkUsuarioUUIDCódigo token que corresponde a un usuario o ejecutivo del sistema.
ejecutivoNombreStringContiene el nombre del ejecutivo que atendió al prospecto.
ejecutivoInicialesStringContiene las iniciales del ejecutivo que atendío al prospecto.
ultimoContactoNombreStringContiene el nombre del ejecutivo que realizó el último contacto.
ultimoContactoInicialesStringContiene las iniciales del nombre del ejecutivo que realizó el último contacto.
ultimoContactoStringContiene una descripción breve que indica el motivo del último cotacto.
ultimoContactoFechaHoraDateTimeContiene un formato compuesto por fecha y hora que indica cuando se realizaró el último contacto con el prospecto.
tkEmpresaUUIDCódigo token que identifica de forma única a una empresa dentro el sistema.
empresaStringGuarda el nombre de la empresa a la que pertenece el prospecto.
tkIndustriaUUIDCódigo token que identifica de forma única a una industria dentro el sistema.
industriaStringIndica el nombre o descripción al tipo de industria a la que pertenece la empresa del prospecto.
tkCorporativoUUIDCódigo token que identifica de forma única a un corporativo dentro el sistema.
corporativoStringEn caso de existir, indica el nombre del corporativo al que pertenece la empresa del prospecto.
tkFaseUUIDCódigo token que corresponde a una fase de prospecto.
faseStringIndica en que fase se encuentra el prospecto.
tkOrigenUUIDCódigo token que corresponde a un origen de prospecto.
origenStringGuarda el origen desde la cual se originó una oportunidad.
idPaisStringContiene un código que especifica el país utilizado.
paisStringContiene el nombre del país.
idEstadoStringContiene el identificador para un estado de un país.
estadoStringGuarda el nombre del estado de un país.
idMunicipioStringContiene el identificador para un municipio de un estado de un país.
municipioStringGuarda el nombre del municipio del estado de un país.
codigoPostalStringAlmacena el codigo postal el prospecto.
proximoEventoStringContiene un arreglo de datos que proporciona los datos de un evento.
compartidoConObjectContiene un arreglo de datos que proporciona los datos de ejecutivos con los que está compartido el prospecto.
etiquetasObjectArreglo de datos que contiene las etiquetas asociadas al prospecto.
tituloStringAlmacena el titulo con el que se registra el prospecto.
comentariosStringContiene un comentario que describe al prospecto.
puestoStringAlmacena el puesto que ocupa el prospecto en la empresa.
calleStringContiene el nombre o número de la calle, que forma parte de la ubicación del prospecto.
coloniaStringContiene el nombre o número de la colonia, que forma parte de la ubicación del prospecto.
ciudadStringContiene el nombre o número de la ciudad, que forma parte de la ubicación del prospecto.
fechaCanalizadoDateTimeContiene un formato de fecha que indica cuando el registro fué canalizado.
canalizoStringIndica el usuario que realizó la canalización.
canalizadoStringIndica el usuario al que se le realizó la canalización.
sexoStringGuarda el sexo que corresponde al prospecto.
correoStringEspecifica el correo del prospecto.
telefonoIntegerAlmacena el número de teléfono que pertenece al prospecto (Si tiene un valor no númerico, devolvera un String).
telefono2IntegerEn caso de existir, se guarda un número de teléfono secundario del prospecto (Si tiene un valor no númerico, devolvera un String).
movilIntegerAlmacena un número de teléfono movil del prospecto (Si tiene un valor no númerico, devolvera un String).
urlStringContiene laq url o dirección del sitio web del prospecto.
facebookStringContiene la dirección o nombre de facebook del prospecto.
twitterStringContiene la dirección o nombre de twitter del prospecto.
skypeStringContiene la dirección o nombre de skype del prospecto.
linkedInStringContiene la dirección o nombre de linkedin del prospecto.
googlePlusStringContiene la dirección o nombre de google plus del prospecto.
cp1StringContiene el valor del primer campo personalizado para prospectos, el cual es establecido por el usuario.
cp100StringContiene el valor del centésimo campo personalizado para prospectos, el cual es establecido por el usuario.
cp1eStringContiene el valor del primer campo personalizado para empresas, el cual es establecido por el usuario.
cp60eStringContiene el valor del sexagésimo campo personalizado para empresas, el cual es establecido por el usuario.