Print Friendly and PDF
Follow

Leadspace API - Format Changes v2 vs v3

Leadspace has updated its API service that allows enrichment for Person records and Accounts through its API. For your assistance, below you will find four tables that present the differences and a comparison between Leadspace API V2 and V3 (the new version).

The tables are - 

  • Request - Bulk
  • Request - Single 
  • Response - Bulk
  • Response - Single 


Request Bulk 

Field Name Object Version 2 Version 3 Comments
External ID external_id Limited with 30 characters There are no limitations to this field beside native “string” type limitations This field was required on V2 and is no longer required on V3
Timeout       Leadspace doesn’t read the timeout parameter anymore
Data list data This list was provided as part of the schema   The list is no longer provided as a part of the schema 
Data nested object data[]  This nested object was provided as part of the schema    This nested object is no longer provided as a part of the schema 
Person nested objected data[].person  data[].person  person  The “data[]” prefix was removed 
Person first name data[].person.first_name data[].person.first_name  person.first_name The “data[]” prefix was removed 
Person last name data[].person.last_name  data[].person.last_name person.last_name The “data[]” prefix was removed
Person email data[].person.email data[].person.email person.email The “data[]” prefix was removed
Person title data[].person.title data[].person.title person.title The “data[]” prefix was removed
Person phone data[].person.phone data[].person.phone person.phone The “data[]” prefix was removed
Person address nested object data[].person.address data[].person.address - Leadspace doesn’t use this field as input
Person country data[].person.address.country  data[].person.address.country - Leadspace doesn’t use this field as input
Person state data[].person.address.state  data[].person.address.state - Leadspace doesn’t use this field as input
Person city data[].person.address.city data[].person.address.city - Leadspace doesn’t use this field as input
Person street data[].person.address.street data[].person.address.street - Leadspace doesn’t use this field as input
Person zipcode data[].person.address.zipcode data[].person.address.zipcode - Leadspace doesn’t use this field as input
Company nested object data[].company  data[].company company The “data[]” prefix was removed
Company name data[].company.name data[].company.name company.name The “data[]” prefix was removed 
Company website data[].company.website data[].company.website company.website The “data[]” prefix was removed
Company phone data[].company.phone data[].company.phone company.phone The “data[]” prefix was removed
Copmany DUNS data[].company.duns data[].company.duns company.duns The “data[]” prefix was removed
Company address nested object data[].company.address data[].company.address company.address The “data[]” prefix was removed
Company country data[].company.address.country data[].company.address.country company.address.country The “data[]” prefix was removed
Company state data[].company.address.state data[].company.address.state company.address.state The “data[]” prefix was removed
Company city data[].company.address.city data[].company.address.city company.address.city The “data[]” prefix was removed
Company street data[].company.address.street data[].company.address.street company.address.street The “data[]” prefix was removed
Company zipcode data[].company.address.zipcode data[].company.address.zipcode company.address.zipcode The “data[]” prefix was removed
Custom fields list data[].custom_fields data[].custom_fields custom_fields The “data[]” prefix was removed
Custom fields nested object data[].custom_fields[] data[].custom_fields[] custom_fields[] The “data[]” prefix was removed
Custom fields name data[].custom_fields[].name data[].custom_fields[].name custom_fields[].name The “data[]” prefix was removed
Custom fields value data[].custom_fields[].value data[].custom_fields[].value custom_fields[].value The “data[]” prefix was removed
Request external ID data[].external_id data[].external_id external_id The “data[]” prefix was removed
Request bulk ID external_bulk_id external_bulk_id external_bulk_id The field doesn’t exist on the single API

 

Request Single 

Field Name Object Version 2 Version 3 Comments
External ID external_id   There are no limitations to this field beside native "string" type limitations This field was required on V2 and is no longer required on V3
Timeout       Leadspace doesn’t read the timeout parameter anymore
Request ID request_id The field was provided - The field is no longer provided in V3
Data list data   - The list is no longer provided in V3
Data nested object data[]   - The nested object is no longer provided in V3
Person nested objected data[].person   person There is a change in the nested object format, now it doesn’t contain “data” anymore.
Person first name data[].person.first_name   person.first_name The “data[]” prefix was removed
Person last name data[].person.last_name   person.last_name The “data[]” prefix was removed
Person email data[].person.email   person.email The “data[]” prefix was removed
Person title data[].person.title   person.title The “data[]” prefix was removed
Person phone data[].person.phone   person.phone The “data[]” prefix was removed
Person address nested object data[].person.address   - Leadspace doesn’t use this field as input
Person country data[].person.address.country   - Leadspace doesn’t use this field as input
Person state data[].person.address.state   - Leadspace doesn’t use this field as input
Person city data[].person.address.city   - Leadspace doesn’t use this field as input
Person street data[].person.address.street   - Leadspace doesn’t use this field as input
Person zipcode data[].person.address.zipcode   - Leadspace doesn’t use this field as input
Company nested object data[].company   company  The “data[]” prefix was removed
Company name data[].company.name   company.name   The “data[]” prefix was removed
Company website data[].company.website   company.website The “data[]” prefix was removed
Company phone data[].company.phone   company.phone The “data[]” prefix was removed
Copmany DUNS data[].company.duns   company.client_id The “data[]” prefix was removed
Company address nested object data[].company.address   company.address The “data[]” prefix was removed
Company country data[].company.address.country   company.address.country The “data[]” prefix was removed
Company state data[].company.address.state   company.address.state The “data[]” prefix was removed
Company city data[].company.address.city   company.address.city The “data[]” prefix was removed
Company street data[].company.address.street   company.address.street The “data[]” prefix was removed
Company zipcode data[].company.address.zipcode   company.address.zipcode The “data[]” prefix was removed
Custom fields list data[].custom_fields   custom_fields The “data[]” prefix was removed
Custom fields nested object data[].custom_fields[]   custom_fields[] The “data[]” prefix was removed
Custom fields name data[].custom_fields[].name   custom_fields[].name The “data[]” prefix was removed
Custom fields value data[].custom_fields[].value   custom_fields[].value The “data[]” prefix was removed
Request external ID data[].external_id   external_id The “data[]” prefix was removed

 

Response Bulk

Field Name Object Version 2 Version 3 Comments
External ID external_id "external": "87948647"AND"external_id": null, inside data object "external_id": "27953317"  
Person Level person.level Job level can be one of the following:
C Level
Board Level
VP Level
Director Level
Manager Level
Staff Level
Job level can be one of the following:
C Level
Board Level
VP Level
Director Level
Manager Level
Staff Level
A blank value (empty string)
The change is on the picklist values
Company Scores company.analytics.scores   - The entire list object was removed
Installed Base Technologies company.analytics.installed_base_technologies - company.analytics.installed_base_technologies Newly added field
Company Stock Tickers list company.stock_tickers company.stock_tickers - The entire list object was removed
Company stock tickers (value) company.stock_tickers[] company.stock_tickers[] - The values of this field will also not be provided
company ranking lists company.ranking_lists company.ranking_lists - The entire list object was removed
Company Ranking Lists value company.ranking_lists[] company.ranking_lists[] - The values of this field will not be provided
Company Expertise list company.analytics.expertise company.analytics.expertise - The entire list object was removed
Company Expertise nested object company.analytics.expertise[] company.analytics.expertise[] - The entire nested object was removed
Company Expertise name company.analytics.expertise[].name company.analytics.expertise[].name - The values of this field will not be provided
Company Expertise confidence level company.analytics.expertise[].confidence_level company.analytics.expertise[].confidence_level - The values of this field will not be provided
Company Technologies list company.analytics.technologies company.analytics.technologies - The entire list object was removed
Company Technologies nested object company.analytics.technologies[] company.analytics.technologies[] - The entire nested object was removed
Company Technologies name company.analytics.technologies[].name company.analytics.technologies[].name - The values of this field will anot be provided
Company Technologies confidence level company.analytics.technologies[].confidence_level company.analytics.technologies[].confidence_level - The values of this field will anot be provided
Company scores nested object company.analytics.scores[] company.analytics.scores[] - The entire nested object was removed 
Company scores name company.analytics.scores[].profile_name company.analytics.scores[].profile_name - The values of this field will also not be provided
Company scores nested object company.analytics.scores[].score company.analytics.scores[].score - The entire nested object was removed
Company scores value company.analytics.scores[].score.value company.analytics.scores[].score.value - The values of this field will  not be provided 
Company Family Tree Type company.family_tree.companies[].type company type. can be one of the following:
HQ
DU
GU
company type. can be one of the following:
DU
GU
SITE
HQ field will not be provided as part of the schema. Instead, Leadspace provides the Site level.
Max Person Score person.analytics.max_positive_score_profiles      
Person Verification Source person.verification_source

This field presents the source type of the verification when the field "person.verification_status" is Verified".

Can be one of the following:
Social
Email
Social & Email

This field presents the source type of the verification when the field "person.verification_status" is Verified".

Can be one of the following:


Social
Email
Social & Email
A blank value (empty string)
The change is on the picklist values
Person Original Email person.original_email    

No change

Person Original Email Verification Status person.original_email_verification_status   If it has a blank value for the field, it will return the value “None”. Value addition to the picklist.
Company original name company.original_name     Newly added field
Company ownership company.ownership     Newly added field
Max positive total score profiles max_positive_total_score_profiles      
Content-Location (header) Content-Location (header) The header contains the full URL, for example:v2/bulk/enrichments/93267F53D90A8107AB489B30CEDDE4548296AA7D Leadspace will return it in the body of the response (this is not the response containing the enriched data but ONLY the path for the response). The body of the response will be the ID that the customer should insert in the URL path to poll the bulk enrichment results. The path itself will also change and will be: enrichment/enrich/bulk/results/{id}  
Conferences Person.analytics.conferences   - Leadspace doesn’t provide this data anymore
Results status results[].status results[].status status The “results[]” prefix was removed
Results errors list results[].errors results[].errors - Leadspace doesn’t provide this field as part of the schema
Results errors nested object results[].errors[] results[].errors[] - Leadspace doesn’t provide this field as part of the schema
Results errors code results[].errors[].code results[].errors[].code - Leadspace doesn’t provide this field as part of the schema
Results errors description results[].errors[].description results[].errors[].description - Leadspace doesn’t provide this field as part of the schema
Results external ID results[].external_id results[].external_id external_id The “results[]” prefix was removed
Results data results[].data results[].data data The “results[]” prefix was removed
External bulk ID external_bulk_id external_bulk_id - Leadspace doesn’t provide this field as part of the schema
Company size exact company.size.exact     If the field is empty, it will not be sent
Company family tree size exact company.family_tree.companies[].size.exact     If the field is empty, it will not be sent.
Applies to all SLM hierarchies
Data entity When there is an “Invalid Input” error results.data results.data - Leadspace doesn’t provide this field as part of the schema

 

 

Response Single

Field Name Object Version 2 Version 3 Comments
External ID external_id external_id "external_id": "27953317"  
Person Level person.level Job level can be one of the following:
C Level
Board Level
VP Level
Director Level
Manager Level
Staff Level
Job level can be one of the following:
C Level
Board Level
VP Level
Director Level
Manager Level
Staff Level
Blank value
The only change is semantic
Company Scores company.analytics.scores   - The entire list object is removed
Installed Base Technologies company.analytics.installed_base_technologies   company.analytics.installed_base_technologies Newly added field
Company Stock Tickers list company.stock_tickers   - The entire list object is removed
Company stock tickers (value) company.stock_tickers[]   - The values of this field will also not be provided 
Company Ranking Lists company.ranking_lists   - The entire list object is removed since Leadspace doesn’t support this data at the moment
Company Ranking Lists value company.ranking_lists[]   - The values of this field will also not be provided as Leadspace doesn’t support this data at the moment
Company Expertise list company.analytics.expertise   - The entire list object is removed since Leadspace doesn’t support this data at the moment
Company Expertise nested object company.analytics.expertise[]   - The entire nested object is removed since Leadspace doesn’t support this data at the moment
Company Expertise name company.analytics.expertise[].name   - The values of this field will also not be provided as Leadspace doesn’t support this data at the moment
Company Expertise confidence level company.analytics.expertise[].confidence_level   - The values of this field will also not be provided as Leadspace doesn’t support this data at the moment
Company Technologies list company.analytics.technologies   - The entire list object is removed since Leadspace doesn’t support this data at the moment
Company Technologies nested object company.analytics.technologies[]   - The entire nested object is removed since Leadspace doesn’t support this data at the moment
Company Technologies name company.analytics.technologies[].name   - The values of this field will also not be provided as Leadspace doesn’t support this data at the moment
Company Technologies confidence level company.analytics.technologies[].confidence_level   - The values of this field will also not be provided as Leadspace doesn’t support this data at the moment
Company scores nested object company.analytics.scores[]   - The entire nested object is removed since Leadspace doesn’t support this data at the moment
Company scores name company.analytics.scores[].profile_name   - The values of this field will also not be provided as Leadspace doesn’t support this data at the moment
Company scores nested object company.analytics.scores[].score   - The entire nested object is removed since Leadspace doesn’t support this data at the moment
Company scores value company.analytics.scores[].score.value   - The values of this field will also not be provided as Leadspace doesn’t support this data at the moment
Company Family Tree Type company.family_tree.companies[].type company type. can be one of the following:
LM
DU
GU
company type. can be one of the following:
DU
GU
SITE
HQ field will not be provided as part of the schema.
Max Person Score person.analytics.max_positive_score_profiles      
Person Verification Source person.verification_source if person.verification_status is "Verified", this field holds the source type of the verification. Can be one of the following:
Social
Email
Social & Email
if person.verification_status is "Verified", this field holds the source type of the verification. Can be one of the following:
Social
Email
Social & Email
None
Adding another possible data value
Person Original Email person.original_email Leadspace used to deliver it on bulk V2 as well Leadspace used to deliver it on bulk V2 as well Leadspace used to deliver it on bulk V2 as well
Person Original Email Verification Status person.original_email_verification_status Can be one of the following (must be capitalized):
VALID
INVALID
UNKNOWN
Leadspace used to deliver it on bulk V2 as well. In v3, in addition to the list of values we provide, if we have a blank value for the field, we will return the value “None”. Leadspace used to deliver it on bulk V2 as well, but it was not documented
Company original name company.original_name     Newly added field
Company ownership company.ownership     Newly added field
Max positive total score profiles max_positive_total_score_profiles      
Content-Location (header) Content-Location (header) - Leadspace will return it in the body of the response (this is not the response containing the enriched data but ONLY the path for the response). The body of the response will be the ID that the customer should insert in the URL path to poll the bulk enrichment results. The path itself will also change and will be: enrichment/enrich/bulk/results/{id}  
Conferences Person.analytics.conferences Field was provided - Leadspace doesn’t provide this data anymore
Results status results[].status   status The “results[]” prefix was removed
Results errors list results[].errors   - Leadspace doesn’t provide this field as part of the schema
Results errors nested object results[].errors[]   - Leadspace doesn’t provide this field as part of the schema
Results errors code results[].errors[].code   - Leadspace doesn’t provide this field as part of the schema
Results errors description results[].errors[].description   - Leadspace doesn’t provide this field as part of the schema
Results external ID results[].external_id   external_id The “results[]” prefix was removed
Results data results[].data   data The “results[]” prefix was removed
External bulk ID external_bulk_id   Leadspace doesn’t provide this field as part of the schema
Company size exact company.size.exact   company.size.exact If the field is empty, it will not be sent
Company family tree size exact company.family_tree.companies[].size.exact   company.family_tree.companies[].size.exact If the field is empty, it will not be sent.
Applies to all SLM hierarchies
Data entity When there are an “Invalid Input” error results.data - - This field doesn’t exist at the moment in V3
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.