Apollo - APOLLO_PEOPLE_SEARCH
I noticed that APOLLO_PEOPLE_SEARCH has the wrong output data documented. See the People API Search for details.
What actually returns is:
"first_name": ...,
"has_city": ...,
"has_country": ...,
"has_direct_phone": ...,
"has_email": ...,
"has_state": ...,
"id": ...,
"last_name_obfuscated": ...,
"last_refreshed_at": ...,
"organization": {
"has_city": ...,
"has_country": ...,
"has_employee_count": ...,
"has_industry": ...,
"has_phone": ...,
"has_revenue": ...,
"has_state": ...,
"has_zip_code": ...,
"name": ...
},
"title": ...
The output presently lists fields like city, state, and linkedin_url which are NOT part of the output:
{
"type": "object",
"title": "PeopleSearchResponseWrapper",
"required": [
"data",
"successful"
],
"properties": {
"data": {
"type": "object",
"title": "Data",
"properties": {
"people": {
"type": "array",
"items": {
"type": "object",
"title": "Person",
"required": [
"id",
"first_name"
],
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "Unique identifier for the person in Apollo's database. Use this ID with the people/bulk_match endpoint to get full enriched data."
},
"city": {
"type": "string",
"title": "City",
"description": "City where the person is located."
},
"name": {
"type": "string",
"title": "Name",
"description": "Full name of the person."
},
"state": {
"type": "string",
"title": "State",
"description": "State or region where the person is located."
},
"title": {
"type": "string",
"title": "Title",
"description": "Current job title or position."
},
"country": {
"type": "string",
"title": "Country",
"description": "Country where the person is located."
},
"has_city": {
"type": "boolean",
"title": "Has City",
"description": "Indicates whether city information is available for this person."
},
"has_email": {
"type": "boolean",
"title": "Has Email",
"description": "Indicates whether an email address is available for this person."
},
"has_state": {
"type": "boolean",
"title": "Has State",
"description": "Indicates whether state information is available for this person."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "Person's last name (may be present in full in some cases)."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "Person's first name."
},
"has_country": {
"type": "boolean",
"title": "Has Country",
"description": "Indicates whether country information is available for this person."
},
"linkedin_url": {
"type": "string",
"title": "Linkedin Url",
"description": "URL to the person's LinkedIn profile."
},
"organization": {
"type": "object",
"title": "Organization",
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "Name of the organization."
},
"has_city": {
"type": "boolean",
"title": "Has City",
"description": "Indicates whether city information is available for the organization."
},
"has_phone": {
"type": "boolean",
"title": "Has Phone",
"description": "Indicates whether a phone number is available for the organization."
},
"has_state": {
"type": "boolean",
"title": "Has State",
"description": "Indicates whether state information is available for the organization."
},
"has_country": {
"type": "boolean",
"title": "Has Country",
"description": "Indicates whether country information is available for the organization."
},
"has_revenue": {
"type": "boolean",
"title": "Has Revenue",
"description": "Indicates whether revenue data is available for the organization."
},
"has_industry": {
"type": "boolean",
"title": "Has Industry",
"description": "Indicates whether industry classification data is available for the organization."
},
"has_zip_code": {
"type": "boolean",
"title": "Has Zip Code",
"description": "Indicates whether postal code information is available for the organization."
},
"has_employee_count": {
"type": "boolean",
"title": "Has Employee Count",
"description": "Indicates whether employee count data is available for the organization."
}
},
"description": "Organization preview information with data availability flags.",
"additionalProperties": false
},
"has_direct_phone": {
"type": "string",
"title": "Has Direct Phone",
"description": "Indicates whether a direct phone number is available. Values include 'Yes' or other status indicators."
},
"last_refreshed_at": {
"type": "string",
"title": "Last Refreshed At",
"description": "ISO 8601 timestamp indicating when the person's data was last updated in Apollo's database."
},
"organization_name": {
"type": "string",
"title": "Organization Name",
"description": "Name of the organization where the person works."
},
"last_name_obfuscated": {
"type": "string",
"title": "Last Name Obfuscated",
"description": "Partially hidden last name (e.g., 'Po***r') shown when full data access requires enrichment."
}
},
"description": "Person object with preview data and availability indicators."
},
"title": "People",
"description": "Array of person objects matching the search criteria. This endpoint returns preview data with obfuscated fields and availability indicators."
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"title": "Contacts",
"description": "Array of contact objects (legacy field, may be empty)."
},
"has_join": {
"type": "boolean",
"title": "Has Join",
"description": "Indicates whether a join operation was performed."
},
"model_ids": {
"type": "array",
"items": {
"type": "string",
"properties": {}
},
"title": "Model Ids",
"description": "Array of model IDs used in the search."
},
"pagination": {
"type": "object",
"title": "Pagination",
"properties": {
"page": {
"type": "integer",
"title": "Page",
"description": "Current page number in the result set."
},
"per_page": {
"type": "integer",
"title": "Per Page",
"description": "Number of results returned per page."
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"description": "Total number of pages available for the search."
},
"total_entries": {
"type": "integer",
"title": "Total Entries",
"description": "Total number of people matching the search criteria across all pages."
}
},
"description": "Pagination metadata for the search results.",
"additionalProperties": false
},
"breadcrumbs": {
"type": "array",
"items": {
"type": "object",
"title": "Breadcrumb",
"properties": {
"label": {
"type": "string",
"title": "Label",
"description": "Human-readable label for the filter."
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"title": "Value",
"description": "Value(s) applied for this filter."
},
"display_name": {
"type": "string",
"title": "Display Name",
"description": "Display-friendly version of the filter value."
},
"signal_field_name": {
"type": "string",
"title": "Signal Field Name",
"description": "Internal field name of the filter."
}
},
"description": "Breadcrumb information showing applied search filters."
},
"title": "Breadcrumbs",
"description": "Array of breadcrumb objects showing applied search filters."
},
"derived_params": {
"type": "object",
"title": "DerivedParams",
"properties": {
"recommendation_config_id": {
"type": "string",
"title": "Recommendation Config Id",
"description": "Configuration ID used for recommendations."
}
},
"description": "Derived parameters used by the API for the search.",
"additionalProperties": false
},
"num_fetch_result": {
"type": "integer",
"title": "Num Fetch Result",
"description": "Number of results fetched in the current request."
},
"partial_results_only": {
"type": "boolean",
"title": "Partial Results Only",
"description": "Indicates whether only partial results are returned."
},
"partial_results_limit": {
"type": "integer",
"title": "Partial Results Limit",
"description": "Limit for partial results."
},
"disable_eu_prospecting": {
"type": "boolean",
"title": "Disable Eu Prospecting",
"description": "Indicates whether EU prospecting is disabled."
}
},
"description": "Data from the action execution",
"additionalProperties": false
},
"error": {
"type": "string",
"title": "Error",
"description": "Error if any occurred during the execution of the action"
},
"successful": {
"type": "boolean",
"title": "Successful",
"description": "Whether or not the action execution was successful or not"
}
}
}
What actually returns is:
"first_name": ...,
"has_city": ...,
"has_country": ...,
"has_direct_phone": ...,
"has_email": ...,
"has_state": ...,
"id": ...,
"last_name_obfuscated": ...,
"last_refreshed_at": ...,
"organization": {
"has_city": ...,
"has_country": ...,
"has_employee_count": ...,
"has_industry": ...,
"has_phone": ...,
"has_revenue": ...,
"has_state": ...,
"has_zip_code": ...,
"name": ...
},
"title": ...
The output presently lists fields like city, state, and linkedin_url which are NOT part of the output:
{
"type": "object",
"title": "PeopleSearchResponseWrapper",
"required": [
"data",
"successful"
],
"properties": {
"data": {
"type": "object",
"title": "Data",
"properties": {
"people": {
"type": "array",
"items": {
"type": "object",
"title": "Person",
"required": [
"id",
"first_name"
],
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "Unique identifier for the person in Apollo's database. Use this ID with the people/bulk_match endpoint to get full enriched data."
},
"city": {
"type": "string",
"title": "City",
"description": "City where the person is located."
},
"name": {
"type": "string",
"title": "Name",
"description": "Full name of the person."
},
"state": {
"type": "string",
"title": "State",
"description": "State or region where the person is located."
},
"title": {
"type": "string",
"title": "Title",
"description": "Current job title or position."
},
"country": {
"type": "string",
"title": "Country",
"description": "Country where the person is located."
},
"has_city": {
"type": "boolean",
"title": "Has City",
"description": "Indicates whether city information is available for this person."
},
"has_email": {
"type": "boolean",
"title": "Has Email",
"description": "Indicates whether an email address is available for this person."
},
"has_state": {
"type": "boolean",
"title": "Has State",
"description": "Indicates whether state information is available for this person."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "Person's last name (may be present in full in some cases)."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "Person's first name."
},
"has_country": {
"type": "boolean",
"title": "Has Country",
"description": "Indicates whether country information is available for this person."
},
"linkedin_url": {
"type": "string",
"title": "Linkedin Url",
"description": "URL to the person's LinkedIn profile."
},
"organization": {
"type": "object",
"title": "Organization",
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "Name of the organization."
},
"has_city": {
"type": "boolean",
"title": "Has City",
"description": "Indicates whether city information is available for the organization."
},
"has_phone": {
"type": "boolean",
"title": "Has Phone",
"description": "Indicates whether a phone number is available for the organization."
},
"has_state": {
"type": "boolean",
"title": "Has State",
"description": "Indicates whether state information is available for the organization."
},
"has_country": {
"type": "boolean",
"title": "Has Country",
"description": "Indicates whether country information is available for the organization."
},
"has_revenue": {
"type": "boolean",
"title": "Has Revenue",
"description": "Indicates whether revenue data is available for the organization."
},
"has_industry": {
"type": "boolean",
"title": "Has Industry",
"description": "Indicates whether industry classification data is available for the organization."
},
"has_zip_code": {
"type": "boolean",
"title": "Has Zip Code",
"description": "Indicates whether postal code information is available for the organization."
},
"has_employee_count": {
"type": "boolean",
"title": "Has Employee Count",
"description": "Indicates whether employee count data is available for the organization."
}
},
"description": "Organization preview information with data availability flags.",
"additionalProperties": false
},
"has_direct_phone": {
"type": "string",
"title": "Has Direct Phone",
"description": "Indicates whether a direct phone number is available. Values include 'Yes' or other status indicators."
},
"last_refreshed_at": {
"type": "string",
"title": "Last Refreshed At",
"description": "ISO 8601 timestamp indicating when the person's data was last updated in Apollo's database."
},
"organization_name": {
"type": "string",
"title": "Organization Name",
"description": "Name of the organization where the person works."
},
"last_name_obfuscated": {
"type": "string",
"title": "Last Name Obfuscated",
"description": "Partially hidden last name (e.g., 'Po***r') shown when full data access requires enrichment."
}
},
"description": "Person object with preview data and availability indicators."
},
"title": "People",
"description": "Array of person objects matching the search criteria. This endpoint returns preview data with obfuscated fields and availability indicators."
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"title": "Contacts",
"description": "Array of contact objects (legacy field, may be empty)."
},
"has_join": {
"type": "boolean",
"title": "Has Join",
"description": "Indicates whether a join operation was performed."
},
"model_ids": {
"type": "array",
"items": {
"type": "string",
"properties": {}
},
"title": "Model Ids",
"description": "Array of model IDs used in the search."
},
"pagination": {
"type": "object",
"title": "Pagination",
"properties": {
"page": {
"type": "integer",
"title": "Page",
"description": "Current page number in the result set."
},
"per_page": {
"type": "integer",
"title": "Per Page",
"description": "Number of results returned per page."
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"description": "Total number of pages available for the search."
},
"total_entries": {
"type": "integer",
"title": "Total Entries",
"description": "Total number of people matching the search criteria across all pages."
}
},
"description": "Pagination metadata for the search results.",
"additionalProperties": false
},
"breadcrumbs": {
"type": "array",
"items": {
"type": "object",
"title": "Breadcrumb",
"properties": {
"label": {
"type": "string",
"title": "Label",
"description": "Human-readable label for the filter."
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"title": "Value",
"description": "Value(s) applied for this filter."
},
"display_name": {
"type": "string",
"title": "Display Name",
"description": "Display-friendly version of the filter value."
},
"signal_field_name": {
"type": "string",
"title": "Signal Field Name",
"description": "Internal field name of the filter."
}
},
"description": "Breadcrumb information showing applied search filters."
},
"title": "Breadcrumbs",
"description": "Array of breadcrumb objects showing applied search filters."
},
"derived_params": {
"type": "object",
"title": "DerivedParams",
"properties": {
"recommendation_config_id": {
"type": "string",
"title": "Recommendation Config Id",
"description": "Configuration ID used for recommendations."
}
},
"description": "Derived parameters used by the API for the search.",
"additionalProperties": false
},
"num_fetch_result": {
"type": "integer",
"title": "Num Fetch Result",
"description": "Number of results fetched in the current request."
},
"partial_results_only": {
"type": "boolean",
"title": "Partial Results Only",
"description": "Indicates whether only partial results are returned."
},
"partial_results_limit": {
"type": "integer",
"title": "Partial Results Limit",
"description": "Limit for partial results."
},
"disable_eu_prospecting": {
"type": "boolean",
"title": "Disable Eu Prospecting",
"description": "Indicates whether EU prospecting is disabled."
}
},
"description": "Data from the action execution",
"additionalProperties": false
},
"error": {
"type": "string",
"title": "Error",
"description": "Error if any occurred during the execution of the action"
},
"successful": {
"type": "boolean",
"title": "Successful",
"description": "Whether or not the action execution was successful or not"
}
}
}