Prospeo API

https://prospeo.io/api-docs
Admin
Prospeo API provides fast and stable endpoints for enriching person and company data, searching...
Tokens:88,476
Snippets:1,031
Trust Score:9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install and Run Prospeo MCP Local Server

Source: https://prospeo.io/api-docs/mcp

Installs and runs the Prospeo MCP server locally using npx. Requires Node.js 18+ and your API key. This is suitable for IDE-based clients.

```bash
claude mcp add prospeo --env PROSPEO_API_KEY=your_api_key -- npx -y @prospeo/prospeo-mcp-server
```

--------------------------------

### Example Error Response

Source: https://prospeo.io/api-docs/authentication

This is an example of an error response from the API, indicating a 'NO_MATCH' error code.

```json
{
    "error": true,
    "error_code": "NO_MATCH"
}
```

--------------------------------

### Company filter search response example

Source: https://prospeo.io/api-docs/search-suggestions

Example of a successful company integration search response returning a flat array of canonical strings.

```json
{
    "error": false,
    "company_integrations_suggestions": [
        "Salesforce",
        "Salesloft",
        "Microsoft Dynamics Sales"
    ]
}
```

--------------------------------

### Bulk Enrich Person Request Example

Source: https://prospeo.io/api-docs/bulk-enrich-person

This example demonstrates how to structure a request to the /bulk-enrich-person endpoint. It includes global enrichment options and a list of person data objects, each with an identifier and various datapoints for matching. Note that identifier '4' is missing sufficient matching data and will be ignored.

```json
POST "https://api.prospeo.io/bulk-enrich-person"
X-KEY: "your_api_key"
Content-Type: "application/json" 

{
   "only_verified_email": true,
   "enrich_mobile": true,
   "data": [
   	{
   		"identifier": "1",
   		"full_name": "Eva Kiegler",
   		"company_website": "intercom.com"
   	},
   	{
   		"identifier": "2",
   		"first_name": "Jonah",
   		"last_name": "Stones",
   		"linkedin_url":  "https://www.linkedin.com/in/jonah-stones",
   		"company_name": "Deloitte",
   		"company_website": "deloitte.com",
   		"company_linkedin_url": "https://www.linkedin.com/company/deloitte"
   	},
   	{
   		"identifier": "3",
   		"linkedin_url":  "https://www.linkedin.com/in/micah-sanders"
   	},
   	{
   		"identifier": "4",
   		"full_name":  "Brandon Stering"
   	},
   	{
   		"identifier": "5",
   		"email":  "nicolas.b@kpmg.com"
   	},
   	{
   		"identifier": "6",
   		"full_name":  "Nicole Wonda",
   		"company_linkedin_url": "https://www.linkedin.com/company/young"
   	},
   	{
   		"identifier": "7",
   		"person_id":  "66f745841665155f554e5f12"
   	},
   	... up to 50 objects
   ]
}
```

--------------------------------

### Filter by Past Companies

Source: https://prospeo.io/api-docs/filters-documentation

Example showing how to filter for individuals who previously worked at specific companies identified by their Prospeo company IDs.

```json
{
	"person_past_company": {
		"company_oids": ["507f1f77bcf86cd799439011", "507f191e810c19729de860ea"],
		"combine_with_current": "AND"
	}
}
```

--------------------------------

### Account Information API Response Example

Source: https://prospeo.io/api-docs/account-information

A successful request to the Account Information API returns details about the user's plan, credits, and quota renewal.

```json
{
    "error": false,
    "response": {
        "current_plan": "STARTER",
        "current_team_members": 1,
        "remaining_credits": 99,
        "used_credits": 1,
        "next_quota_renewal_days": 25,
        "next_quota_renewal_date": "2023-06-18 20:52:28+00:00"
    }
}
```

--------------------------------

### Enrich Company using Website

Source: https://prospeo.io/api-docs/enrich-company

This example demonstrates how to enrich a company's data by providing its website. This method is recommended for better accuracy compared to using only the company name.

```bash
POST "https://api.prospeo.io/enrich-company"
X-KEY: "your_api_key"
Content-Type: "application/json"

{
   "data": {
       "company_website": "intercom.com"
   }
}
```

--------------------------------

### Company Funding Filter Example

Source: https://prospeo.io/api-docs/filters-documentation

Filters companies based on funding stages, dates, total amounts, investors, and accelerator participation.

```json
{
	"company_funding": {
		"stage": ["Series A", "Series B", "Series C"],
		"funding_date": 365,
		"last_funding": {
			"min": "1M",
			"max": "100M"
		},
		"total_funding": {
			"min": "5M",
			"max": "500M"
		},
		"investors": ["Sequoia Capital", "Andreessen Horowitz"],
		"was_in_accelerator": true,
		"accelerator_name": "Y Combinator"
	}
}
```

--------------------------------

### Perform a Company Search Request

Source: https://prospeo.io/api-docs/search-company

Example of a POST request to the search-company endpoint using cURL with a JSON payload containing filters and pagination.

```bash
curl --location 'https://api.prospeo.io/search-company' \
--header 'X-KEY: api-key' \
--header 'Content-Type: application/json' \
--data '{
    "page": 1,
    "filters": {
        "company_industry": {
            "exclude": [
                "Semiconductors",
                "Pet Services"
            ]
        },
        "company_funding": {
			"stage": [
				"Series B", 
				"Series C"
			],
			"funding_date": 365,
			"last_funding": {
				"min": "1M", 
				"max": "10M"
			},
			"total_funding": {
				"min": "10M", 
				"max": "100M"
			}
    	}
    }
}'
```

--------------------------------

### Run Local MCP Server with Claude Code

Source: https://prospeo.io/api-docs/mcp-quick-start

Use this command to start the Prospeo MCP server locally for Claude Code. Ensure you have Node.js 18+ and replace 'your_api_key_here' with your actual Prospeo API key.

```bash
claude mcp add prospeo \
  --env PROSPEO_API_KEY=your_api_key_here \
  -- npx -y @prospeo/prospeo-mcp-server
```

--------------------------------

### Company Headcount Growth Filter Example

Source: https://prospeo.io/api-docs/filters-documentation

Filters companies based on headcount growth percentage over a specified timeframe and by department.

```json
{
	"company_headcount_growth": {
		"timeframe_month": 12,
		"min": 10,
		"max": 100,
		"departments": ["Sales", "Technical"]
	}
}
```

--------------------------------

### Get Account Information

Source: https://prospeo.io/api-docs/account-information

Fetches the current user's account details, including plan, credits, and renewal information. This endpoint is free to use.

```APIDOC
## GET /account-information

### Description
Retrieves information about the current user's usage, remaining credits, current plan, and next quota renewal date. This endpoint is free to use.

### Method
GET

### Endpoint
https://api.prospeo.io/account-information

### Headers
- **X-KEY** (string) - Required - Your API key

### Parameters
This endpoint does not require any parameters.

### Response
#### Success Response (200)
- **current_plan** (string) - The current plan you are subscribed to.
- **current_team_members** (integer) - The number of team members in your team.
- **remaining_credits** (integer) - The number of credits remaining.
- **used_credits** (integer) - The number of credits already used.
- **next_quota_renewal_days** (integer) - The number of days until the next quota renewal.
- **next_quota_renewal_date** (string) - The date and time of the next quota renewal.

#### Response Example
```json
{
    "error": false,
    "response": {
        "current_plan": "STARTER",
        "current_team_members": 1,
        "remaining_credits": 99,
        "used_credits": 1,
        "next_quota_renewal_days": 25,
        "next_quota_renewal_date": "2023-06-18 20:52:28+00:00"
    }
}
```

### Error Codes
- **400 INVALID_API_KEY**: Invalid API key, check your `X-KEY` header.
- **429 Rate limit exceeded**: You hit the rate limit for your current plan.
- **400 INVALID_REQUEST**: The request your submitted is invalid.
- **400 INTERNAL_ERROR**: An error occurred on our side, please contact the support.
```

--------------------------------

### Search People and Companies

Source: https://prospeo.io/api-docs/filters-documentation

Examples of filter configurations for searching people and companies via the Prospeo API.

```APIDOC
## Search People by Job Title, Seniority, and Company

### Request Body
- **filters** (object) - Required - Filter criteria for people and companies.
- **page** (integer) - Required - Page number for pagination.

### Request Example
{
	"filters": {
		"person_job_title": {
			"include": ["CEO", "CTO", "VP Engineering"],
			"match_mode": "CONTAINS"
		},
		"person_seniority": {
			"include": ["C-Suite", "Vice President"]
		},
		"company": {
			"names": {
				"include": ["Microsoft", "Google", "Apple"]
			}
		},
		"person_location_search": {
			"include": ["United States"]
		}
	},
	"page": 1
}

## Search People with Boolean Job Title Search

### Request Example
{
	"filters": {
		"person_job_title": {
			"boolean_search": "(CEO OR CTO OR \"Chief Technology Officer\") AND !Intern"
		},
		"company_industry": {
			"include": ["Software Development", "IT Services and IT Consulting"]
		},
		"company_headcount_range": ["101-200", "201-500", "501-1000"]
	},
	"page": 1
}

## Search Companies by Industry, Size, and Funding

### Request Example
{
	"filters": {
		"company_industry": {
			"include": ["Software Development", "IT Services and IT Consulting"]
		},
		"company_headcount_range": ["101-200", "201-500", "501-1000"],
		"company_funding": {
			"stage": ["Series A", "Series B", "Series C"],
			"funding_date": 365
		},
		"company_location_search": {
			"include": ["United States"]
		},
		"company_revenue": {
			"min": "10M",
			"max": "500M"
		}
	},
	"page": 1
}

## Search Companies by Technology and Growth

### Request Example
{
	"filters": {
		"company_technology": {
			"include": ["Salesforce", "HubSpot"]
		},
		"company_headcount_growth": {
			"timeframe_month": 12,
			"min": 20,
			"max": 200
		},
		"company_job_posting_quantity": {
			"min": 10
		}
	},
	"page": 1
}

## Search Companies by Website Content and Traffic

### Request Example
{
	"filters": {
		"company_website_search": {
			"include_keywords": ["enterprise pricing", "SOC 2 compliance"],
			"match_mode": "any",
			"has_security_page": true,
			"has_developer_docs_page": true
		},
		"company_website_traffic": {
			"min_monthly_visits": 50000,
			"visit_change": {
				"period": "quarterly",
				"min_change": 10
			}
		},
		"company_headcount_range": ["51-100", "101-200", "201-500"]
	},
	"page": 1
}

## Find Similar Companies with ICP and News Signals

### Request Example
{
	"filters": {
		"company_lookalike": {
			"domain": "hubspot.com",
			"minimum_tier": "T2"
		},
		"company_icp": {
			"company_sizes": ["smb", "midmarket"],
			"departments": {
				"include": ["Sales", "Marketing"],
				"match_mode": "any"
			}
		},
		"company_news": {
			"categories": ["Funding & Investment", "Product Launch"],
			"timeframe_days": 180
		}
	},
	"page": 1
}
```

--------------------------------

### Complete Enrich Person Response Example

Source: https://prospeo.io/api-docs/enrich-person

This is an example of a complete response from the Enrich Person API, including all possible fields for both the person and company objects. Fields that are unavailable will be represented as null. The company object details the lead's current employer, or can be null if the lead has no current job.

```json
{
    "error": false,
    "free_enrichment": false,
    "person": {
        "person_id": "aaaacd817619fba3d254cd64",
        "first_name": "Eoghan",
        "last_name": "Mccabe",
        "full_name": "Eoghan Mccabe",
        "linkedin_url": "https://www.linkedin.com/in/eoghanmccabe",
        "current_job_title": "CEO, chairman, and co-founder",
        "current_job_key": null,
        "headline": "CEO and founder at Intercom, building Fin.ai",
        "linkedin_member_id": null,
        "last_job_change_detected_at": null,
        "job_history": [
            {
                "title": "CEO, chairman, and co-founder",
                "company_name": "Intercom",
                "logo_url": "9ded0364-c88a-4789-9d39-2a15ed239edb.jpg",
                "current": true,
                "start_year": 2022,
                "start_month": 10,
                "end_year": null,
                "end_month": null,
                "duration_in_months": 39,
                "departments": [
                    "Founder",
                    "Chief Executive"
                ],
                "seniority": "C-Suite",
                "company_id": "cccc7c7da6116a8830a07100",
                "job_key": "82981650"
            },
            {
                "title": "Chairman and co-founder",
                "company_name": "Intercom",
                "logo_url": "9ded0364-c88a-4789-9d39-2a15ed239edb.jpg",
                "current": false,
                "start_year": 2020,
                "start_month": 7,
                "end_year": 2022,
                "end_month": 10,
                "duration_in_months": 27,
                "departments": [
                    "Founder"
                ],
                "seniority": "Founder/Owner",
                "company_id": "cccc7c7da6116a8830a07100",
                "job_key": "23054356"
            },
            {
                "title": "CEO and co-founder",
                "company_name": "Intercom",
                "logo_url": "9ded0364-c88a-4789-9d39-2a15ed239edb.jpg",
                "current": false,
                "start_year": 2011,
                "start_month": 8,
                "end_year": 2020,
                "end_month": 7,
                "duration_in_months": 107,
                "departments": [
                    "Founder",
                    "Chief Executive"
                ],
                "seniority": "C-Suite",
                "company_id": "cccc7c7da6116a8830a07100",
                "job_key": "68686694"
            },
            {
                "title": "CEO",
                "company_name": "Exceptional",
                "logo_url": "2588d75e-d2e7-4fb1-bf31-35cafd119ec0.jpg",
                "current": false,
                "start_year": 2008,
                "start_month": 10,
                "end_year": 2011,
                "end_month": 7,
                "duration_in_months": 33,
                "departments": [
                    "Chief Executive"
                ],
                "seniority": "C-Suite",
                "company_id": "ccccd431f3dfa7e88993bb18",
                "job_key": "80900834"
            },
            {
                "title": "CEO",
                "company_name": "Contrast",
                "logo_url": "d4bbee3f-7128-436d-a474-fcac68b989e4.jpg",
                "current": false,
                "start_year": 2007,
                "start_month": 12,
                "end_year": 2011,
                "end_month": 7,
                "duration_in_months": 43,
                "departments": [
                    "Chief Executive"
                ],
                "seniority": "C-Suite",
                "company_id": "ccccd431f3dfa7e88993bb18",
                "job_key": "80900834"
            }
        ],
        "email": "eoghan.mccabe@intercom.com",
        "email_verified": true,
        "mobile": "+353 87 123 4567",
        "mobile_verified": true,
        "country_code": "IE",
        "state": "Dublin",
        "city": "Dublin",
        "postal_code": "D02",
        "street": "2nd Floor, Fitzwilliam Building, Stephen's Green",
        "latitude": 53.3427,
        "longitude": -6.2543,
        "timezone": "Europe/Dublin",
        "gender": "male",
        "facebook_url": null,
        "twitter_url": "https://twitter.com/eoghanmccabe",
        "company": {
            "company_id": "cccc7c7da6116a8830a07100",
            "name": "Intercom",
            "website": "intercom.com",
            "linkedin_url": "https://www.linkedin.com/company/intercom",
            "logo_url": "9ded0364-c88a-4789-9d39-2a15ed239edb.jpg",
            "industry": "Computer Software",
            "industry_id": "100",
            "founded_year": 2011,
            "size": "201-500 employees",
            "size_id": "4",
            "revenue_usd": null,
            "revenue_currency": null,
            "revenue_range": null,
            "country_code": "US",
            "state": "San Francisco",
            "city": "San Francisco",
            "postal_code": "94107",
            "street": "555 Bryant Street, Suite 100",
            "latitude": 37.7777,
            "longitude": -122.402,
            "timezone": "America/Los_Angeles"
        }
    },
    "company": {
        "company_id": "cccc7c7da6116a8830a07100",
        "name": "Intercom",
        "website": "intercom.com",
        "linkedin_url": "https://www.linkedin.com/company/intercom",
        "logo_url": "9ded0364-c88a-4789-9d39-2a15ed239edb.jpg",
        "industry": "Computer Software",
        "industry_id": "100",
        "founded_year": 2011,
        "size": "201-500 employees",
        "size_id": "4",
        "revenue_usd": null,
        "revenue_currency": null,
        "revenue_range": null,
        "country_code": "US",
        "state": "San Francisco",
        "city": "San Francisco",
        "postal_code": "94107",
        "street": "555 Bryant Street, Suite 100",
        "latitude": 37.7777,
        "longitude": -122.402,
        "timezone": "America/Los_Angeles"
    }
}
```

--------------------------------

### Company Website Full-Text Search

Source: https://prospeo.io/api-docs/filters-documentation

Example of performing a full-text search across company website pages with keyword filtering and structural constraints.

```json
{
	"company_website_search": {
		"include_keywords": ["enterprise pricing", "SOC 2"],
		"exclude_keywords": ["free trial"],
		"match_mode": "any",
		"search_in": {
			"page_body": true,
			"page_titles": true
		},
		"page_scope": ["product", "about"],
		"url_contains": "pricing",
		"has_developer_docs_page": true,
		"has_security_page": true
	}
}
```

--------------------------------

### Company Lookalike Search Modes

Source: https://prospeo.io/api-docs/filters-documentation

Examples of using different modes for company similarity search. Exactly one mode (company_oids, icp_text, or domain) must be provided.

```json
{
	"company_lookalike": {
		"company_oids": ["507f1f77bcf86cd799439011", "507f1f77bcf86cd799439012"],
		"minimum_tier": "T2",
		"match_all": false
	}
}
```

```json
{
	"company_lookalike": {
		"icp_text": "B2B SaaS companies in the sales intelligence space with 50-500 employees",
		"minimum_tier": "T2"
	}
}
```

```json
{
	"company_lookalike": {
		"domain": "prospeo.io",
		"minimum_tier": "T2",
		"same_language": true
	}
}
```

--------------------------------

### Company Founded Filter Example

Source: https://prospeo.io/api-docs/filters-documentation

Filters companies by their founding year range and includes an option to include companies with unknown founding dates.

```json
{
	"company_founded": {
		"min": 2010,
		"max": 2020,
		"include_unknown_founded": true
	}
}
```

--------------------------------

### Filter by Past Job Titles

Source: https://prospeo.io/api-docs/filters-documentation

Example demonstrating how to combine current job title filtering with past job title criteria using exact or contains matching.

```json
{
	"person_job_title": {
		"include": ["VP of Sales"],
		"match_mode": "CONTAINS"
	},
	"person_past_job_title": {
		"include": ["Account Executive"],
		"match_mode": "EXACT",
		"combine_with_current": "AND"
	}
}
```

--------------------------------

### cURL Request with API Key

Source: https://prospeo.io/api-docs/authentication

Example of making a POST request to the Enrich Person API using cURL, including the necessary 'X-KEY' and 'Content-Type' headers.

```bash
curl -X POST \
  -H "Content-Type: application/json" \
  -H "X-KEY: your_api_key" \
  -d '{
        "only_verified_email": true,
        "enrich_mobile": false,
        "data": {
            "first_name": "John",
            "last_name": "Doe",
            "company_website": "intercom.com"
        }
    }' \
  "https://api.prospeo.io/enrich-person"
```

--------------------------------

### Always Enrich Person Mobile

Source: https://prospeo.io/api-docs/enrich-person

This request always returns a result if a match is found and reveals the mobile number if present. It costs 10 credits and includes email for free. This example uses full_name and company_name for matching, but using company_website is advised for better accuracy.

```bash
POST "https://api.prospeo.io/enrich-person"
X-KEY: "your_api_key"
Content-Type: "application/json"

{
   "enrich_mobile": true,
   "data": {
       "full_name": "Eva Kiegler",
       "company_name": "Intercom"
   }
}
```

--------------------------------

### Bulk Enrich Company Request Example

Source: https://prospeo.io/api-docs/bulk-enrich-company

Send a POST request to the /bulk-enrich-company endpoint with your API key and a JSON payload containing a list of company data objects. Each object requires an identifier and at least one company datapoint for matching.

```HTTP
POST "https://api.prospeo.io/bulk-enrich-company"
X-KEY: "your_api_key"
Content-Type: "application/json"
 
{
   "data": [
   	{
   		"identifier": "1",
   		"company_website": "intercom.com"
   	},
   	{
   		"identifier": "2",
   		"company_linkedin_url": "https://www.linkedin.com/company/deloitte"
   	},
   	{
   		"identifier": "3",
   		"company_name":  "Milka"
   	},
   	{
   		"identifier": "4",
   		"full_name":  "Pinterest"
   	},
   	... up to 50 objects
   ]
}
```

--------------------------------

### Person Object JSON Example

Source: https://prospeo.io/api-docs/person-object

This JSON object represents a person's profile, including their ID, name, contact information, and a detailed job history.

```json
"person": {
    "person_id": "aaaacd817619fba3d254cd64",
    "first_name": "Eoghan",
    "last_name": "Mccabe",
    "full_name": "Eoghan Mccabe",
    "linkedin_url": "https://www.linkedin.com/in/eoghanmccabe",
    "current_job_title": "CEO, chairman, and co-founder",
    "current_job_key": null,
    "headline": "CEO and founder at Intercom, building Fin.ai",
    "linkedin_member_id": null,
    "last_job_change_detected_at": null,
    "job_history": [
        {
            "title": "CEO, chairman, and co-founder",
            "company_name": "Intercom",
            "logo_url": "9ded0364-c88a-4789-9d39-2a15ed239edb.jpg",
            "current": true,
            "start_year": 2022,
            "start_month": 10,
            "end_year": null,
            "end_month": null,
            "duration_in_months": 39,
            "departments": [
                "Founder",
                "Chief Executive"
            ],
            "seniority": "C-Suite",
            "company_id": "cccc7c7da6116a8830a07100",
            "job_key": "82981650"
        },
        {
            "title": "Chairman and co-founder",
            "company_name": "Intercom",
            "logo_url": "9ded0364-c88a-4789-9d39-2a15ed239edb.jpg",
            "current": false,
            "start_year": 2020,
            "start_month": 7,
            "end_year": 2022,
            "end_month": 10,
            "duration_in_months": 27,
            "departments": [
                "Founder"
            ],
            "seniority": "Founder/Owner",
            "company_id": "cccc7c7da6116a8830a07100",
            "job_key": "23054356"
        },
        {
            "title": "CEO and co-founder",
            "company_name": "Intercom",
            "logo_url": "9ded0364-c88a-4789-9d39-2a15ed239edb.jpg",
            "current": false,
            "start_year": 2011,
            "start_month": 8,
            "end_year": 2020,
            "end_month": 7,
            "duration_in_months": 107,
            "departments": [
                "Founder",
                "Chief Executive"
            ],
            "seniority": "C-Suite",
            "company_id": "cccc7c7da6116a8830a07100",
            "job_key": "68686694"
        },
        {
            "title": "CEO",
            "company_name": "Exceptional",
            "logo_url": "2588d75e-d2e7-4fb1-bf31-35cafd119ec0.jpg",
            "current": false,
            "start_year": 2008,
            "start_month": 10,
            "end_year": 2011,
            "end_month": 7,
            "duration_in_months": 33,
            "departments": [
                "Chief Executive"
            ],
            "seniority": "C-Suite",
            "company_id": "ccccd431f3dfa7e88993bb18",
            "job_key": "80900834"
        },
        {
            "title": "CEO",
            "company_name": "Contrast",
            "logo_url": "d4bbee3f-7128-436d-a474-fcac68b989e4.jpg",
            "current": false,
            "start_year": 2007,
            "start_month": 12,
            "end_year": 2011,
            "end_month": 7,
            "duration_in_months": 43,
            "departments": [
                "Chief Executive"
            ],
            "seniority": "C-Suite",
            "company_id": "ccccf3e7f023592ee266a9d8",
            "job_key": "72014547"
        }
    ],
    "mobile": {
        "status": "VERIFIED",
        "revealed": false,
        "mobile": "+1 415-3**-****",
        "mobile_national": "(415) 3**-****",
        "mobile_international": "+1 415-3**-****",
        "mobile_country": "United States",
        "mobile_country_code": "US"
    },
    "email": {
        "status": "VERIFIED",
        "revealed": true,
        "email": "eoghan.*****@intercom.com",
        "verification_method": "BOUNCEBAN",
        "email_mx_provider": "Google"
    },
    "location": {
        "country": "United States",
        "country_code": "US",
        "state": "California",
        "city": "San Francisco",
        "time_zone": "America/Los_Angeles",
        "time_zone_offset": -7.0
    },
    "skills": []
}

```

--------------------------------

### PHP Request with API Key

Source: https://prospeo.io/api-docs/authentication

Example of making a POST request to the Enrich Person API using PHP with cURL, ensuring the 'X-KEY' and 'Content-Type' headers are set.

```php
$url = "https://api.prospeo.io/enrich-person";
$api_key = "your_api_key";

$headers = array(
    "Content-Type" => "application/json",
    "X-KEY" => $api_key
);

$data = array(
    "first_name" => "John",
    "last_name" => "Doe",
    "company_website" => "intercom.com"
);

$param = array(
    "only_verified_email" => true,
    "enrich_mobile" => false,
    "data" => $data
);

$options = array(
    CURLOPT_URL => $url,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_POSTFIELDS => json_encode($param),
    CURLOPT_RETURNTRANSFER => true
);

$ch = curl_init();
curl_setopt_array($ch, $options);
$response = curl_exec($ch);
curl_close($ch);
```

--------------------------------

### Successful API Response Example

Source: https://prospeo.io/api-docs/authentication

This JSON object represents a successful API response, including person enrichment data. It indicates no errors and provides detailed information about the individual.

```json
{
    "error": false,
    "free_enrichment": false,
    "person": {
        "person_id": "aaaacd817619fba3d254cd64",
        "first_name": "Eoghan",
        "last_name": "Mccabe",
        "full_name": "Eoghan Mccabe",
        "linkedin_url": "https://www.linkedin.com/in/eoghanmccabe",
        "current_job_title": "CEO, chairman, and co-founder",
        "current_job_key": null,
        "headline": "CEO and founder at Intercom, building Fin.ai",
        "linkedin_member_id": null,
        "last_job_change_detected_at": null,
        "job_history": [
            {
                "title": "CEO, chairman, and co-founder",
                "company_name": "Intercom",
                "logo_url": "9ded0364-c88a-4789-9d39-2a15ed239edb.jpg",
                "current": true,
                "start_year": 2022,
                "start_month": 10,
                "end_year": null,
                "end_month": null,
                "duration_in_months": 39,
                "departments": [
                    "Founder",
                    "Chief Executive"
                ],
                "seniority": "C-Suite",
                "company_id": "cccc7c7da6116a8830a07100",
                "job_key": "82981650"
            },
            {
                "title": "Chairman and co-founder",
                "company_name": "Intercom",
                "logo_url": "9ded0364-c88a-4789-9d39-2a15ed239edb.jpg",
                "current": false,
                "start_year": 2020,
                "start_month": 7,
                "end_year": 2022,
                "end_month": 10,
                "duration_in_months": 27,
                "departments": [
                    "Founder"
                ],
                "seniority": "Founder/Owner",
                "company_id": "cccc7c7da6116a8830a07100",
                "job_key": "23054356"
            },
            {
                "title": "CEO and co-founder",
                "company_name": "Intercom",
                "logo_url": "9ded0364-c88a-4789-9d39-2a15ed239edb.jpg",
                "current": false,
                "start_year": 2011,
                "start_month": 8,
                "end_year": 2020,
                "end_month": 7,
                "duration_in_months": 107,
                "departments": [
                    "Founder",
                    "Chief Executive"
                ],
                "seniority": "C-Suite",
                "company_id": "cccc7c7da6116a8830a07100",
                "job_key": "68686694"
            },
            {
                "title": "CEO",
                "company_name": "Exceptional",
                "logo_url": "2588d75e-d2e7-4fb1-bf31-35cafd119ec0.jpg",
                "current": false,
                "start_year": 2008,
                "start_month": 10,
                "end_year": 2011,
                "end_month": 7,
                "duration_in_months": 33,
                "departments": [
                    "Chief Executive"
                ],
                "seniority": "C-Suite",
                "company_id": "ccccd431f3dfa7e88993bb18",
                "job_key": "80900834"
            },
            {
                "title": "CEO",
                "company_name": "Contrast",
                "logo_url": "d4bbee3f-7128-436d-a474-fcac68b989e4.jpg",
                "current": false,
                "start_year": 2007,
                "start_month": 12,
                "end_year": 2011,
                "end_month": 7,
                "duration_in_months": 43,
                "departments": [
                    "Chief Executive"
                ],
                "seniority": "C-Suite",
                "company_id": "ccccf3e7f023592ee266a9d8",
                "job_key": "72014547"
            }
        ],
        "mobile": {
            "status": "VERIFIED",
            "revealed": false,
            "mobile": "+1 415-3**-****",
            "mobile_national": "(415) 3**-****",
            "mobile_international": "+1 415-3**-****",
            "mobile_country": "United States",
            "mobile_country_code": "US"
        },
        "email": {
            "status": "VERIFIED",
            "revealed": true,
            "email": "eoghan.*****@intercom.com",
            "verification_method": "BOUNCEBAN",
            "email_mx_provider": "Google"
        },
        "location": {
            "country": "United States"
        }
    }
}
```

--------------------------------

### Enrich Person Only if Mobile Exists

Source: https://prospeo.io/api-docs/enrich-person

This request returns a result only if a VERIFIED mobile number is available. It automatically reveals the mobile number (and includes email for free) at the cost of 10 credits. This example uses the person's linkedin_url for matching.

```bash
POST "https://api.prospeo.io/enrich-person"
X-KEY: "your_api_key"
Content-Type: "application/json"

{
   "only_verified_mobile": true,
   "data": {
       "linkedin_url": "https://www.linkedin.com/in/eva-kiegler"
   }
}
```

--------------------------------

### Configure Local MCP Server for Claude Desktop

Source: https://prospeo.io/api-docs/mcp-quick-start

Add this JSON configuration to your Claude Desktop settings file to enable the Prospeo MCP server. Replace 'your_api_key_here' with your Prospeo API key.

```json
{
  "mcpServers": {
    "prospeo": {
      "command": "npx",
      "args": ["-y", "@prospeo/prospeo-mcp-server"],
      "env": {
        "PROSPEO_API_KEY": "your_api_key_here"
      }
    }
  }
}
```

--------------------------------

### Company Enrichment API Response Example

Source: https://prospeo.io/api-docs/enrich-company

This JSON object represents a typical response from the company enrichment API, showcasing all available fields and their example values for a company.

```json
{
	"error": false,
	"free_enrichment": false,
	"company": {
		"company_id": "cccc7c7da6116a8830a07100",
		"name": "Intercom",
		"website": "https://intercom.com",
		"domain": "intercom.io",
		"other_websites": [],
		"description": "Intercom is the only complete AI-first customer service platform, enhancing the customer experience, improving operational efficiency, and scaling with your business every step of the way. 

Our AI-first platform is built on a single AI system, with two major components that will allow you to deliver the remarkable customer service you’ve spent decades striving for:\n\nFin AI Agent: The human-quality AI agent that works with any Helpdesk\n\nIntercom Customer Service Platform: The AI-first platform trusted by thousands of support leaders.  \n\nFounded in 2011 and backed by leading venture capitalists, including Kleiner Perkins, Bessemer Venture Partners and Social Capital, Intercom believes there's a new way to do customer service.",
		"description_seo": "Intercom is the complete AI-first customer service solution, giving exceptional experiences for support teams with AI agent, AI copilot, tickets, phone & more",
		"description_ai": "Intercom is an AI-first customer service solution that provides exceptional experiences for support teams with AI agent, AI copilot, tickets, phone, and more.",
		"type": "Private",
		"industry": "Software Development",
		"employee_count": 1822,
		"employee_count_on_prospeo": 437,
		"employee_range": "1001-2000",
		"location": {
			"country": "United States",
			"country_code": "US",
			"state": "California",
			"city": "San Francisco",
			"raw_address": "55 2nd Street, 4th Floor, San Francisco, California 94105, US"
		},
		"sic_codes": [
			"737"
		],
		"naics_codes": [],
		"email_tech": {
			"domain": "intercom.io",
			"mx_provider": "Google"
		},
		"linkedin_url": "https://www.linkedin.com/company/intercom",
		"twitter_url": "https://x.com/intercom",
		"facebook_url": "https://www.facebook.com/intercominc",
		"crunchbase_url": "https://www.crunchbase.com/organization/intercom",
		"instagram_url": "https://www.instagram.com/intercom",
		"youtube_url": "https://www.youtube.com/c/@intercominc",
		"phone_hq": {
			"phone_hq": "+14156733820",
			"phone_hq_national": "(415) 673-3820",
			"phone_hq_international": "+14156733820",
			"phone_hq_country": "United States",
			"phone_hq_country_code": "US"
		},
		"linkedin_id": null,
		"founded": 2011,
		"revenue_range": {
			"min": 100000000,
			"max": 250000000
		},
		"revenue_range_printed": "100M",
		"keywords": [
			"Customer Support",
			"Live Chat",
			"Marketing Automation",
			"Customer Relationship Management",
			"Customer Experience",
			"Customer Engagement",
			"Customer Service",
			"Mobile",
			"Customer Feedback",
			"AI",
			"Helpdesk",
			"CX",
			"Chat Bots",
			"Customer Communication",
			"Support Automation",
			"Shared Inbox"
		],
		"logo_url": "https://prospeo-static-assets.s3.us-east-1.amazonaws.com/company_logo/9ded0364-c88a-4789-9d39-2a15ed239edb.jpg",
		"attributes": {
			"is_b2b": true,
			"has_demo": false,
			"has_free_trial": true,
			"has_downloadable": false,
			"has_mobile_apps": false,
			"has_online_reviews": true,
			"has_pricing": true
		},
		"funding": {
			"count": 2,
			"total_funding": 125000000,
			"total_funding_printed": "$125.0M",
			"latest_funding_date": "2021-01-01T00:00:00",
			"latest_funding_stage": "Series unknown",
			"funding_events": [
				{
					"amount": null,
					"amount_printed": null,
					"raised_at": "2021-01-01T00:00:00",
					"stage": "Series unknown",
					"link": "https://www.crunchbase.com/funding_round/intercom-series-unknown--6ce20dfb"
				},
				{
					"amount": 125000000,
					"amount_printed": "$125,000,000",
					"raised_at": "2018-04-27T00:00:00",
					"stage": "Series D",
					"link": "https://www.crunchbase.com/funding_round/intercom-series-d--15490ce6"
				}
			]
		},
		"technology": {
			"count": 43,
			"technology_names": [
				"6sense",
				"theTradeDesk",
				"Amazon SES",
				"Contentful",
				"Node.js",
				"Tailwind CSS"
			],
			"technology_list": [
				{
					"name": "6sense",
					"category": "Marketing automation"
				},
				{
					"name": "theTradeDesk",
					"category": "Advertising"
				},
				{
					"name": "Amazon SES",
					"category": "Email"
				},
				{
					"name": "Contentful",
					"category": "CMS"
				}
			]
		},
		"job_postings": {
			"active_count": 3,
			"active_titles": [
				"account executive, senior midmarket",
				"senior product engineer",
				"senior recruiting coordinator"
			]
		}
	}
}
```

--------------------------------

### Company Technology Filter Example

Source: https://prospeo.io/api-docs/filters-documentation

Filters companies by specific technologies included or excluded from their stack.

```json
{
	"company_technology": {
		"include": ["Salesforce", "HubSpot", "AWS"],
		"exclude": ["Azure"]
	}
}
```
Tokens:
Raw