View Categories

Clientes potenciales – Solicitar información del Lead

< 1 minutos de lectura

🌐 GET: dominio-de-oficina-virtual.com/api/leads/:id

Header #

CampoTipoDescripción
authtokenStringToken de autenticación, generado desde el área de administración.
Estructura Json – GetLead – Header
Copy
{
  "type": "object",
  "properties": {
    "authtoken": {
      "type": "string"
    }
  }
}

Parámetro:

CampoTipoDescripción
authtokenNumberID único del Lead

Datos de respuesta exitosa – Success 200 #

CampoTipoDescripción
LeadObjectInformación
Ejemplo – Respuesta Exitosa – Success
Copy
HTTP/1.1 200 OK
{
    "id": "17",
    "hash": "c6e938f8b7a40b1bcfd98dc04f6eeee0-60d9c039da373a685fc0f74d4bfae631",
    "name": "Lead name",
    "contact": "",
    "title": "",
    "company": "Themesic Interactive",
    "description": "",
    "country": "243",
    "zip": null,
    "city": "London",
    "zip": "WC13KJ",
    "state": "London",
    "address": "1a The Alexander Suite Silk Point",
    "assigned": "5",
    "dateadded": "2019-07-18 08:59:28",
    "from_form_id": "0",
    "status": "0",
    "source": "4",
    ...
}

Error 4xx #

NombreTipoDescripción
statusBooleanEstado de solicitud.
messageStringNo se encontraron datos
Ejemplo – Respuesta Fallida – Error
Copy
HTTP/1.1 404 Not Found
{
  "status": false,
  "message": "No data were found"
}

Estructura GetLead Exitoso – Success 200

Json – Sucess
Copy
{
  "type": "object",
  "properties": {}
}

Estructura Error 4xx

Json – Error
Copy
{
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean"
    },
    "message": {
      "type": "string"
    }
  }
}

Scroll al inicio