CRM

Retrieve a Lead

Work with Leads.Retrieves the Lead with the given ID.

get/admin/crm/leads/{id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/crm/leads/{id}
  • Auth: HTTP basic

Path parameters

idnumber double required
Example:1

The ID of the desired Lead.

Response

statusstring

Status: 'new', 'active', 'blocked', 'disabled'. Default value: 'new'

partner_idnumber required

Partner id. You can get it at page "Administration / Partners"

location_idnumber required

Location id. You can get it at page "Administration / Locations"

passwordstring

Password

namestring required

Full name

emailstring

Email

phonestring

Phone number

categorystring required

Category: 'person' (for private person) or 'company' (for company). Default value: 'person'

street_1string

Address part #1

zip_codestring

Zip

citystring

City

date_addstring

Date of adding. Format: 'YYYY-MM-DD'. Default value: current date

subdivision_idnumber

State/province ID

Example response

{
  "status": "new",
  "partner_id": 1,
  "location_id": 1,
  "password": "secret@@string",
  "name": "Lead Name",
  "email": "test@mail.com",
  "phone": "555-0135",
  "category": "person",
  "street_1": "2d Street",
  "zip_code": "",
  "city": "",
  "date_add": "",
  "subdivision_id": 1,
  "lead_labels": [
    {
      "id": 1,
      "label": "Label name",
      "color": "#357bf2"
    }
  ],
  "contacts": [
    {
      "id": 1,
      "type": "email",
      "value": "test@mail.com",
      "label": "primary",
      "country_code": null,
      "is_primary": true,
      "is_whatsapp": false
    },
    {
      "id": 2,
      "type": "phone",
      "value": "555-0135",
      "label": "primary",
      "country_code": null,
      "is_primary": true,
      "is_whatsapp": false
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.