Search Persons

Endpoint Overview

The Search persons endpoint retrieves an array of person object models based on specific filters.

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

Request

Parameters

Filters

• Key: filters
• Data Type: object
• Required: true
• Description: Enables advanced filtering by specifying conditions that must be met.
• Structure
  • all: An array of filter that must all be satisfied.
  • any: An array of filter where at least one must be satisfied.

{
  "all": ["<filter>"],
  "any": ["<filter>"]
}

Filter

• Structure
  • key: The filter key. See Filter Keys below.
  • value: The value of the filter. it's a string or a number
  • operator: The operators based on the key type. See below Operators.
• Example

{ "key": "countryCode", "value": "US", "operator": "=" }

Filter Keys

Filter

Key	Value Type	Description
name	string
unitedStatesStateCode	string	Complete List
unitedStatesCity	string
countryCode	string	Complete List
worldRegion	string	Complete List
titleAtCurrentCompany	string
currentCompanyName	string
currentCompanyHeadcount	number	The total number of employees working at the company.
currentCompanyWebsite	string	A link to the company's website, formatted according to RFC 3986 guidelines.
currentCompanyIndustry	string	Industry that company belongs to. Complete List
currentCompanyNiche	string	Niche that company is in. Complete List
currentCompanyUnitedStatesHeadquartersStateCode	string	The U.S. state codes where the company's headquarters are located, if applicable. Complete List
currentCompanyUnitedStatesHeadquartersCity	string	Name of the city.
currentCompanyUnitedStatesHeadquartersRegion	string	Details geographical locations of company headquarters in the United States. Complete List
currentCompanyHeadquartersCountryCode	string	The country codes where the company's headquarters are located, compliant with ISO 3166-1 alpha-2. Complete List
currentCompanyHeadquartersWorldRegion	string	Details geographical locations of company headquarters globally. Complete List
currentCompanySignal	string	Complete List

Operators

Operator	Valid Types	Description
=	string, number	Equals
!=	string, number	Doesn't Equal
<	number, date	Greater than
>	number, date	Lower than
~	string	Contains
!~	string	Doesn't Contain

important

All string matches are case insensitives.

Limit

• Key: limit
• Data Type: number
• Required: false
• Default: 10
• Description: Specifies the maximum number of results to return. Maximum allowed value of 100.
• Example: 50

important

Pagination is limited to the first 1000 results for any given combination of filter keys.
If you require access beyond this range, please reach out to us.

Example

{
  "filters": {
    "all": [
      { "key": "countryCode", "value": "US", "operator": "=" },
      { "key": "unitedStatesStateCode", "value": "CA", "operator": "=" }
    ],
    "any": [
      { "key": "titleAtCurrentCompany", "value": "CEO", "operator": "=" },
      { "key": "titleAtCurrentCompany", "value": "Founder", "operator": "=" }
    ]
  },
  "limit": 100
}

Response

The response returns an array of person ids, along with pagination information.

Id

• Key: id
• Data Type: uuid
• Description: A universally unique identifier (UUID) compliant with RFC 4122, used to uniquely identify a person. Presented without hyphens.
• Example: "9e6a55b258ef11edb8780242ac120002"

Example

{
  "data": {
    "results": ["9e6a55b258ef11edb8780242ac120002"],
    "pagination": {
      "nextStart": [
        {
          "id": "9e6a55b258ef11edb8780242ac121233"
        }
      ]
    }
  }
}