Person Object
The Person object represents a b2b contact, typically associated with a company. Here is a description of the Person object:| Field | Type | Description |
|---|---|---|
id | string | ID of the Person |
object | string | Object type (always “person”) |
linkedin_url | string | LinkedIn URL of the Person |
name | string | Name of the Person |
email | string | Email address of the Person |
first_name | string | First name of the Person |
last_name | string | Last name of the Person |
gender | enum | Gender of the Person |
title | string | Title of the Person |
headline | string | Headline of the Person |
about | string | About section of the Person |
current_position_start_date | string | Start date of the Person’s current position |
current_position_description | string | Description of the Person’s current position |
location | string | Location of the Person |
image_url | string | Image URL of the Person |
location_details | object | Location details of the Person |
experiences | array | Array of experience objects for the Person |
educations | array | Array of education objects for the Person |
languages | array | Array of language objects for the Person |
phone_numbers | array | Array of phone number objects for the Person |
company | Company object | Company the Person currently works for |
Company Object
Here is the description of the Company object:| Field | Type | Description |
|---|---|---|
id | string | Amplemarket ID of the Company |
object | string | Object type (always “company”) |
name | string | Name of the Company |
linkedin_url | string | LinkedIn URL of the Company |
website | string | Website of the Company |
overview | string | Description of the Company |
logo_url | string | Logo URL of the Company |
founded_year | integer | Year the Company was founded |
traffic_rank | integer | Traffic rank of the Company |
sic_codes | array of integers | SIC codes of the Company |
naics_codes | array of integers | NAICS codes of the Company |
type | string | Type of the Company (Public Company, etc.) |
total_funding | integer | Total funding of the Company |
latest_funding_stage | string | Latest funding stage of the Company |
latest_funding_date | string | Latest funding date of the Company |
keywords | array of strings | Keywords of the Company |
estimated_number_of_employees | integer | Estimated number of employees at the Company |
followers | integer | Number of followers on LinkedIn |
size | string | Self reported size of the Company |
industry | string | Industry of the Company |
location | string | Location of the Company |
location_details | object | Location details of the Company |
locations | array | Array of location objects for the Company |
is_b2b | boolean | true if the Company has a B2B component |
is_b2c | boolean | true if the Company has a B2C component |
technologies | array of strings | Technologies detected for the Company |
department_headcount | object | Headcount by department |
job_function_headcount | object | Headcount by job function |
estimated_revenue | string | The estimated annual revenue of the company |
revenue | integer | The annual revenue of the company |
People Endpoints
Finding a Person
Request The following endpoint can be used to find a Person on Amplemarket:Revealing an email address
Retry-After header.
Revealing phone numbers
Retry-After header.
Finding multiple people
Enrichment requests allow you to retrieve comprehensive data about multiple people simultaneously. This bulk operation is ideal for enriching large lists of leads with detailed information including their current company, title, location, and optionally their email addresses and phone numbers. The enrichment request flow will usually follow these steps:-
POST /people/enrichment-requestswith a list of leads that will be enriched -
In the response, follow the URL provided in
response._links.self.href -
Continue polling the endpoint while respecting the
Retry-AfterHTTP Header -
When enrichment completes, the results are in
response.results -
If the results are larger than the default limit, then follow the URL provided in
response._links.next.href
Enrichment Request Object
| Field | Type | Description |
|---|---|---|
id | integer | The ID of the enrichment request |
status | string | The status of the enrichment request: |
queued: The enrichment request hasn’t started yet | ||
processing: The enrichment request is in-progress | ||
completed: The enrichment request terminated successfully | ||
canceled: The enrichment request terminated due to being canceled | ||
error: The enrichment request terminated with an error; see _errors for more details | ||
results | array of enrichment_request_result | The enrichment results for the leads provided; default number of results range from 1 up to 100 |
_links | array of links | Contains useful links related to this resource |
_errors | array of errors | Contains the errors if the operation fails |
Enrichment Request Result Object
| Field | Type | Description |
|---|---|---|
id | integer | The ID of the enrichment result |
status | string | The result of the enrichment: |
enriched: Successfully found and enriched the person | ||
not_found: Unable to find a matching person in the database | ||
gdpr_removed: The person data has been removed due to GDPR compliance | ||
result | Person object | The enriched Person object (see Person Object) |
email | string | The email address used to search for this person (if provided in the request) |
linkedin_id | string | The LinkedIn ID used to search for this person (if provided in the request) |
company_domain | string | The company domain used to search for this person (if provided in the request) |
company_name | string | The company name used to search for this person (if provided in the request) |
name | string | The person name used to search for this person (if provided in the request) |
title | string | The person title used to search for this person (if provided in the request) |
Start Enrichment Request
Request A batch of leads can be sent to the enrichment request service, up to 10,000 leads according to usage limits.| Parameter | Type | Required | Description |
|---|---|---|---|
leads | array | Yes | Array of lead objects to enrich (max 100,000) |
reveal_email | boolean | No | Whether to reveal email addresses for the enriched people (consumes additional credits) |
reveal_phone_numbers | boolean | No | Whether to reveal phone numbers for the enriched people (consumes additional credits) |
| Property | Type | Description |
|---|---|---|
email | string | Email address of the person |
linkedin_id | string | LinkedIn ID of the person |
company_domain | string | Company domain (used with name and/or title) |
company_name | string | Company name (used with name and/or title) |
name | string | Full name of the person |
title | string | Job title of the person |
202 Accepted indicating that the enrichment request will soon be started:
Location:GETpoints back to the enrichment request object that was created
self-GETpoints back to the enrichment request object that was created
Enrichment Request Polling
Request The Enrichment Request object can be polled in order to receive results:200 OK while the operation hasn’t yet terminated.
Retry-After- indicates how long to wait until performing anotherGETrequest
-
self-GETpoints back to the same object -
next-GETpoints to the next page of entries, when available -
prev-GETpoints to the previous page of entries, when available
Retrieving Enrichment Request Results
Request When the enrichment request has terminated, the results can be retrieved using the same url:response._links.next.href (e.g. GET /people/enrichment-requests/1?page[size]=100&page[after]=2).
Links
-
self-GETpoints back to the same object -
next-GETpoints to the next page of entries, when available -
prev-GETpoints to the previous page of entries, when available
Cancelling a running Enrichment Request
Request You can cancel an enrichment request that’s still running by sending aPATCH request:
"status" is supported in this request, any other field will be ignored.
Response
The response will display any available results up until the point the enrichment request was canceled.
response._links.next.href (e.g. GET /people/enrichment-requests/1?page[size]=100&page[after]=1).
Links
-
self-GETpoints back to the same object -
next-GETpoints to the next page of entries, when available -
prev-GETpoints to the previous page of entries, when available