CRM

List all Leads

Returns a list of your Leads.

get/admin/crm/leads

Request

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

Response

billing_typestring

Billing type: 'recurring', 'prepaid_monthly'

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"

added_bystring

Added by: 'api', 'admin', 'widget'

added_by_idnumber

Added by id

namestring required

Full name

emailstring

Email

billing_emailstring

Billing 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

last_updatestring

Last date update customer.

subdivision_idnumber

State/province ID

idnumber required

Lead ID

Example response

[
  {
    "billing_type": "recurring",
    "partner_id": 1,
    "location_id": 1,
    "added_by": "admin",
    "added_by_id": 1,
    "name": "Lead Name",
    "email": "test@mail.com",
    "billing_email": "test@mail.com",
    "phone": "555-0135",
    "category": "person",
    "street_1": "2nd Street",
    "zip_code": "",
    "city": "",
    "date_add": "",
    "last_update": "2022-04-21 05:09:06",
    "subdivision_id": 1,
    "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.