Mostrar Cliente

Mostrar Cliente

GET https://api.sperant.com/v3/clients/<id>

Permite lista la información de un cliente en específico

Headers

Name	Type	Description
Authorization	string	Token entregado.

200

{
    "data": {
        "type": "clients",
        "id": "81397",
        "links": {
            "referred": "http://localhost:4000/v3/clients/6066"
        },
        "attributes": {
            "id": 81397,
            "uuid": "7d4bf886-b95c9c-0a27",
            "fname": "api",
            "lname": "v3",
            "phone": "",
            "email": "[e-mail]",
            "created_at": 1614977820089,
            "person_type": "natural",
            "gender": "m",
            "document_type_id": 1,
            "document_type": "DNI",
            "document": "auto-143213240189",
            "main_telephone": "",
            "interest_type_id": 4,
            "interest_type": "por contactar",
            "input_channel_id": 8,
            "input_channel": "chatbot",
            "input_channel_group_id": 1,
            "input_channel_group": "Grupo 1"         
            "email_consent": true,
            "observation": "",
            "extra_fields": {
                "email_1": "[e-mail]",
                "partida_electronica": "123456",
                "actividad_economica_de_la_empresa": "Inmobiliario"
            },
            "captation_way_id": 2,
            "captation_way": "panel terreno",
            "ubication": {
                "country": "PE",
                "state": "HUV",
                "address": ""
            },
            "couple_id": null,
            "publicity_consent": false,
            "reason_resigns_name": "No califica",
            "lead_priority_id": 1
        }
    }
}

Parámetros de retorno

Los parámetros de retorno son los siguientes

Parámetro	Tipo de Dato	Descripción
id	integer	Identificador del cliente.
uuid	string	UUID del cliente
fname	string	Nombres del cliente.
lname	string	Apellidos del cliente.
phone	string	Número de celular del cliente.
email	string	Correo electrónico del cliente.
created_at	timestamp	Fecha de creación del cliente.
person_type	string	Tipo de persona. Los valores son: natural legal
gender	string	Género del cliente. Los valores son f -> femenino m -> masculino
document_type_id	integer	Identificador del tipo de documento del cliente.
document_type	string	Tipo de documento del cliente.
document	string	Documento del cliente.
main_telephone	string	Teléfono fijo del cliente.
interest_type_id	integer	Identificador del nivel de interés del cliente.
interest_type	string	Nombre del nivel de interés del cliente.
input_channel_id	integer	ID de origen canal de entrada del cliente.
input_channel	string	Canal de entrada del cliente.
input_channel_group_id	integer	Identificador de la agrupación de canal de entrada.
input_channel_group	string	Agrupación de canal de entrada.
captation_way_id	integer	ID de origen medio de captación del cliente.
captation_way	string	Medio de captación del cliente.
num_interactions	integer	Número de interacciones del cliente. (no disponible)
last_interaction_date	timestamp	Última fecha de interacción del cliente. (no disponible)
observation	string	Observación del cliente.
couple_id	integer	Identificador del cónyuge del cliente.
publicity_consent	boolean	Autorización de envío de publicidad al cliente.
email_consent	boolean	Autorización de uso de datos del cliente.
lead_priority_id	integer	identificador de prioridad de lead

Asimismo, también retorna los objetos extra_fields y ubication que se explicarán a continuación:

• Ubication (Ubicación)

Parámetro	Tipo de Dato	Descripción
country	string	País del cliente en formato ISO_CODE.
state	string	Estado o departamento del cliente en formato ISO_CODE.
address	string	Dirección del cliente.
geo_address	string	Ubicación de la geolocalización
geo_latitud	float	Latitud
geo_longitud	float	Longitud

• Extra_fields (Datos Extras)

Los datos extras se mostrarán tal cual se registran en el CRM y el tipo de dato será el mismo que coloquen allí.