Enrich Persons

Endpoint Overview

The Enrich Persons endpoint accesses detailed profiles of individuals stored in the profileAPI system. This feature allows for precise queries based on various unique identifiers, including social media URLs, and contact information such as emails or phone numbers.

Endpoint Details

• URL: https://api.profileapi.com/2024-03-01/persons/enrich
• HTTP Method: GET

Request Parameters

Utilize one or multiple identifiers to enrich person data:

Parameter	Type	Description	Example
identifiers	Array of objects	Specify the identifiers to enrich person information. Each identifier can uniquely identify a person.	See Identifier Structure below
fields	Array of string	Determines which fields to return from the person object model. Defaults to returning all fields if not specified.	["department", "role"]

Identifier Structure

You can use one or more of the following identifiers to query person information:

Identifier	Type	Description	Example
linkedInUrl	linkedInUrl	Direct URL to the person's LinkedIn profile.	"https://linkedin.com/in/johndoe"
crunchbaseUrl	crunchbaseUrl	URL to the person's Crunchbase profile, which includes their entrepreneurial activities.	"https://crunchbase.com/person/john-doe"
twitterUrl	twitterUrl	Direct link to the person's Twitter profile.	"https://twitter.com/johndoe"
githubUrl	githubUrl	URL to the person's GitHub profile, showcasing their coding contributions.	"https://github.com/johndoe"
youtubeUrl	youtubeUrl	Direct link to the person's YouTube channel.	"https://youtube.com/user/johndoe"
angellistUrl	angellistUrl	URL to the person's AngelList profile, often used for startup and investment tracking.	"https://angel.co/johndoe"
phone	phone	Phone number associated with the person.	"+1234567890"
email	email	Email address associated with the person.	[[email protected]](mailto:[email protected])

Identifiers are processed using OR logic, allowing identification of a person through any given identifier.

Example Request

{
  "identifiers": [
    { "email": "[email protected]" },
    { "linkedinURL": "<https://linkedin.com/in/joedoe>" }
  ]
}

Example Usage

cURL:

curl '<https://api.profileapi.com/2024-03-01/persons/enrich>' \\
  -H 'Content-Type: application/json' \\
  -d '{
        "identifiers": [
          { "email": "[email protected]" },
          { "linkedinUrl": "<https://linkedin.com/in/johndoe>" }
        ],
        "fields": ["department", "role"]
      }'

Node.js (Using Axios):

const axios = require('axios');

axios.get('<https://api.profileapi.com/2024-03-01/persons/enrich>', {
  params: {
    identifiers: JSON.stringify([
      { "email": "[email protected]" },
      { "linkedinUrl": "<https://linkedin.com/in/johndoe>" }
    ]),
    fields: ['department', 'role']
  }
})
.then(response => console.log(response.data))
.catch(error => console.error('Error:', error));

Python (Using requests):

import requests

params = {
  'identifiers': [
    { "email": "[email protected]" },
    { "linkedinURL": "<https://linkedin.com/in/johndoe>" }
  ],
  'fields': ['department', 'role']
}
response = requests.get('<https://api.profileapi.com/2024-03-01/persons/enrich>', params=params)
if response.status_code == 200:
    print(response.json())
else:
    print('Failed to fetch data:', response.status_code)