Lead Fields Reference
Complete reference guide for all lead fields available in Top Provider integrations
This comprehensive reference documents all available lead fields in the Top Provider system. Use this guide when configuring field mappings for Email Integration, Webhook Integration, or HubSpot Integration.
Lead fields are the data points Top Provider collects from buyers. Understanding these fields is essential for properly configuring your integrations and automating your lead workflow.
Field Categories
Top Provider organizes lead fields into logical categories for easier management:
- Contact Information - Primary contact details
- Personal Information - Name and title information
- Address Fields - Location information
- Company Information - Business and organization details
- Lead Details - Metadata about the lead itself
- Order Information - Data about the lead order
Understanding Field Properties
Each lead field has several properties you should understand:
- Field Name: Human-readable name shown in the interface
- Data Type: The kind of data stored in the field (String, Number, etc.)
- Default Mapping: Suggested field name when mapping to external systems
Not all leads will have data for every field. Your integration should handle null or empty values appropriately to prevent processing errors.
Contact Information
The primary contact details for reaching the lead.
| Field Name | Description | Data Type | Default Mapping |
|---|---|---|---|
| Email Address | Primary email address of the lead | String (Email) | emailAddress |
| Phone Number | Primary phone number | String | phoneNumber |
Personal Information
Individual identity information for the lead contact.
| Field Name | Description | Data Type | Default Mapping |
|---|---|---|---|
| First Name | First name of the lead | String | firstName |
| Last Name | Last name of the lead | String | lastName |
| Title | Professional or personal title | String | title |
Address Fields
Physical location information for the lead or their business.
| Field Name | Description | Data Type | Default Mapping |
|---|---|---|---|
| Address | Street address (line 1) | String | address |
| Address2 | Street address (line 2) | String | address2 |
| City | City name | String | city |
| State | State/province/region | String | state |
| Postal Code | ZIP or postal code | String | postalCode |
| Country | Country name | String | country |
Company Information
Details about the lead's organization or business.
| Field Name | Description | Data Type | Default Mapping |
|---|---|---|---|
| Company | Company name | String | company |
| Company Size | Number of employees | String/Number | companySize |
| Industry | Industry category | String | industry |
Company Size Values
The following values are used for the Company Size field:
| Value | Description |
|---|---|
1-4 | Micro company (1-4 employees) |
5-9 | Very small company (5-9 employees) |
10-24 | Small company (10-24 employees) |
25-49 | Medium company (25-49 employees) |
50-99 | Medium-large company (50-99 employees) |
100-249 | Large company (100-249 employees) |
250-499 | Extra large company (250-499 employees) |
500-999 | Huge company (500-999 employees) |
1,000-2,499 | Massive company (1,000-2,499 employees) |
2,500-4,999 | Enterprise (2,500-4,999 employees) |
5,000-9,999 | Mega enterprise (5,000-9,999 employees) |
10,000+ | Ultra enterprise (10,000+ employees) |
Industry Values
The following values are used for the Industry field:
AccountingAdvertising and MarketingAerospace and AviationAgricultureArts and CultureAutomotiveBiotechnology and PharmaceuticalsBusiness ServicesConstruction and EngineeringConsumer GoodsDefenseEducationEnergy and UtilitiesEntertainment and MediaFinancial ServicesFood and BeverageGovernment and Public AdministrationHealthcare and MedicalHospitality and TravelInformation Technology and ServicesLegal ServicesManufacturingNon-ProfitReal EstateRetailStaffing and RecruitingSports and RecreationTelecommunicationsTransportation and Logistics
Lead Details
Metadata and additional information about the lead itself.
| Field Name | Description | Data Type | Default Mapping |
|---|---|---|---|
| Lead Id | Unique identifier for the lead | String | leadId |
| Message | Additional message or notes | Text | message |
| Url | Related URL (e.g., referral URL) | String (URL) | url |
Order Information
Details about the lead order associated with this lead.
| Field Name | Description | Data Type | Default Mapping |
|---|---|---|---|
| Lead Order Name | Name of the associated lead order | String | leadOrderName |
| Lead Order Leads Remaining | Number of leads remaining in the order | Number | leadOrderLeadsRemaining |
| Order Leads Sent | Number of leads sent from the order | Number | orderLeadsSent |
| Send Date | Date when the lead was sent | DateTime | sendDate |
Field Data Types
Understanding the data types helps you handle field values appropriately in your integrations:
| Data Type | Description | Example |
|---|---|---|
| String | Basic text data, limited to 255 characters | "John Doe" |
| Text | Longer text data without specific character limits | "Detailed project requirements..." |
| Number | Numeric data (integer or decimal) | 42, 3.14 |
| DateTime | Date and time values in ISO format | "2023-06-15T14:22:43Z" |
| Specifically formatted email addresses | "contact@example.com" | |
| URL | Web addresses | "https://example.com" |
Using Fields in Integrations
Each integration type uses lead fields differently:
Email Integration
In Email Integration, all lead fields are included in the email body.
Webhook Integration
For Webhook Integration:
- Map Top Provider field names to your system's expected field names
- Use the field data types to validate and process incoming data
- Handle missing fields gracefully in your webhook endpoint
HubSpot Integration
With HubSpot Integration:
- Map lead fields to standard HubSpot properties
- Create custom properties in HubSpot for specialized fields
- Use constants for fields that should have fixed values
Handling Missing Data
Since not all fields will have values for every lead, your integration should properly handle missing or null values:
- Provide defaults when appropriate
- Skip processing of fields with null values
- Use conditional logic to handle variations in data completeness
- Log warnings rather than errors for missing data
Never assume all fields will be present in every lead. Always implement proper null checks in your integration code.
Need help? Contact our support team at support@topprovider.com if you need assistance.