PlatformDocs

Manual search

Filter the Platform contact database by job title, seniority, industry, location and company size, then add the people you want to your leads.

Two REST endpoints on https://rest-dash.revealid.xyz, authenticated with ?privateKey=YOUR_KEY, like every other endpoint. Your keys are in Integrations → API (see Authentication).

EndpointDoesCost
POST /admin/prospector/people/searchFinds people by title, seniority, industry, location and company sizeFree
POST /admin/prospector/people/revealShows the email and phone of one person1 credit
POST/admin/prospector/people/searchSearch people
POST/admin/prospector/people/revealReveal a person's email and phone
POST/v3/prospector/people/find-emailFind contact email
POST
Request body
Website IdThe website the search is for (GET /admin/websites)
QueryEvery filter is optional
TitlesJob titles (free text)
CEOFounder
CompaniesCompany names or domains (free text)
Seniorities
Departments
Industries
Computer Software
LocationsCompany headquarters: a country by full English name, or a continent for all its countries
United States
Employees Min
Employees Max
TechnologiesTechnologies the company uses
CountResults per page
PagePage number
curl -X POST "https://rest-dash.revealid.xyz/admin/prospector/people/search?privateKey=YOUR_KEY" \  -H "Content-Type: application/json" \  -d '{  "websiteId": "64b7f0a1c2d3e4f5a6b7c8d9",  "query": {    "titles": [      "CEO",      "Founder"    ],    "industries": [      "Computer Software"    ],    "locations": [      "United States"    ],    "employeesMin": 10,    "employeesMax": 200,    "count": 25  }}'
Response
Press Send request to try it with sample data.

What each field accepts

FieldTypeLimits and formatAccepted values
websiteId*string—any
query*object—any
query.titlesstring[]—any
query.companiesstring[]—any
query.senioritiesstring[]—InternManagerDirectorVPEmployeeC-Level
query.departmentsstring[]—
Show all 22 valuesAdministrative DepartmentConsulting DepartmentCreative DepartmentCustomer Service DepartmentUniversity DepartmentEngineering DepartmentCEO DepartmentFinance DepartmentHR DepartmentHealthcare DepartmentIT DepartmentLegal DepartmentLogistics DepartmentMaintenance DepartmentMarketing DepartmentOperations DepartmentOther DepartmentProduction DepartmentProgram and Project Management DepartmentPurchasing DepartmentQuality Assurance DepartmentSales Department
query.industriesstring[]—
Show all 154 valuesAccountingAirlines/AviationAlternative Dispute ResolutionAlternative MedicineAnimationApparel & FashionArchitecture & PlanningArtists and WritersArts and CraftsAutomotiveAviation & AerospaceBankingBiotechnologyBroadcast MediaBuilding MaterialsBusiness Consulting and ServicesBusiness Supplies and EquipmentCapital MarketsChemicalsCivic & Social OrganizationCivil EngineeringCommercial Real EstateComputer & Network SecurityComputer GamesComputer HardwareComputer NetworkingComputer SoftwareConstructionConsumer ElectronicsConsumer GoodsConsumer ServicesCosmeticsDairyDefense & SpaceDesignEducation ManagementeCommerceE-LearningElectrical/Electronic ManufacturingEntertainmentEnvironmental ServicesEvents ServicesExecutive OfficeFacilities ServicesFarmingFinancial ServicesFine ArtFisheryFood & BeveragesFood ProductionFund-RaisingFurnitureGambling & CasinosGlass, Ceramics & ConcreteGovernment AdministrationGovernment RelationsGraphic DesignHealth, Wellness and FitnessHigher EducationHospital & Health CareHospitalityHuman ResourcesImport and ExportIndividual & Family ServicesIndustrial AutomationInformation ServicesInformation Technology and ServicesInsuranceInternational AffairsInternational Trade and DevelopmentInternetInternet Marketplace PlatformsInvestment BankingInvestment ManagementJudiciaryLaw EnforcementLaw PracticeLegal ServicesLegislative OfficeLeisure, Travel & TourismLibrariesLogistics and Supply ChainLuxury Goods & JewelryMachineryManagement ConsultingMaritimeMarketing and AdvertisingMarket ResearchMechanical or Industrial EngineeringMedia ProductionMedical DevicesMedical PracticeMental Health CareMilitaryMining & MetalsMobile GamesMotion Pictures and FilmMuseums and InstitutionsMusicNanotechnologyNewspapersNonprofit Organization ManagementOil & EnergyOnline MediaOtherOutsourcing/OffshoringPackage/Freight DeliveryPackaging and ContainersPaper & Forest ProductsPerforming ArtsPharmaceuticalsPhilanthropyPhotographyPlasticsPolitical OrganizationPrimary/Secondary EducationPrintingProfessional Training & CoachingProgram DevelopmentPublic PolicyPublic Relations and CommunicationsPublic SafetyPublishingRailroad ManufactureRanchingReal EstateRecreational Facilities and ServicesReligious InstitutionsRenewables & EnvironmentResearchRestaurantsRetailSaaSSecurity and InvestigationsSemiconductorsShipbuildingSporting GoodsSportsStaffing and RecruitingSupermarketsTelecommunicationsTextilesThink TanksTobaccoTranslation and LocalizationTransportation/Trucking/RailroadUtilitiesVenture Capital & Private EquityVeterinaryWarehousingWholesaleWine and SpiritsWirelessWriting and Editing
query.locationsstring[]—
Show all 249 valuesAfghanistanÅland IslandsAlbaniaAlgeriaAmerican SamoaAndorraAngolaAnguillaAntarcticaAntigua and BarbudaArgentinaArmeniaArubaAustraliaAustriaAzerbaijanThe BahamasBahrainBangladeshBarbadosBelarusBelgiumBelizeBeninBermudaBhutanBoliviaBosnia and HerzegovinaBotswanaBouvet IslandBrazilBritish Indian Ocean TerritoryBruneiBulgariaBurkina FasoBurundiCambodiaCameroonCanadaCape VerdeCayman IslandsCentral African RepublicChadChileChinaChristmas IslandCocos (Keeling) IslandsColombiaComorosRepublic of the CongoCook IslandsCosta RicaCote d'IvoireCroatiaCubaCyprusCzechiaDenmarkDjiboutiDominicaDominican RepublicEcuadorEgyptEl SalvadorEquatorial GuineaEritreaEstoniaEthiopiaFalkland Islands (Islas Malvinas)Faroe IslandsFijiFinlandFranceFrench GuianaFrench PolynesiaFrench Southern and Antarctic LandsGabonThe GambiaGeorgiaGermanyGhanaGibraltarGreeceGreenlandGrenadaGuadeloupeGuamGuatemalaGuernseyGuineaGuinea-BissauGuyanaHaitiHeard Island and McDonald IslandsHoly See (Vatican City)HondurasHong KongHungaryIcelandIndiaIndonesiaIranIraqIrelandIsle of ManIsraelItalyJamaicaJapanJerseyJordanKazakhstanKenyaKiribatiNorth KoreaSouth KoreaKuwaitKyrgyzstanLaosLatviaLebanonLesothoLiberiaLibyaLiechtensteinLithuaniaLuxembourgMacauNorth MacedoniaMadagascarMalawiMalaysiaMaldivesMaliMaltaMarshall IslandsMartiniqueMauritaniaMauritiusMayotteMexicoFederated States of MicronesiaMoldovaMonacoMongoliaMontserratMoroccoMozambiqueMyanmar (Burma)NamibiaNauruNepalNetherlandsNetherlands AntillesNew CaledoniaNew ZealandNicaraguaNigerNigeriaNiueNorfolk IslandNorthern Mariana IslandsNorwayOmanPakistanPalauPalestinian TerritoryPanamaPapua New GuineaParaguayPeruPhilippinesPitcairn IslandsPolandPortugalPuerto RicoQatarReunionRomaniaRussiaRwandaSaint HelenaSaint Kitts and NevisSaint LuciaSaint Pierre and MiquelonSaint Vincent and the GrenadinesWestern SamoaSan MarinoSao Tome and PrincipeSaudi ArabiaSenegalMontenegroSerbiaSeychellesSierra LeoneSingaporeSlovakiaSloveniaSolomon IslandsSomaliaSouth AfricaSouth Georgia and the South Sandwich IslandsSpainSri LankaSudanSurinameSvalbardEswatiniSwedenSwitzerlandSyriaTaiwanTajikistanTanzaniaThailandTimor-LesteTogoTokelauTongaTrinidad and TobagoTunisiaTurkeyTurkmenistanTurks and Caicos IslandsTuvaluUgandaUkraineUnited Arab EmiratesUnited KingdomUnited StatesUnited States Minor Outlying IslandsUruguayUzbekistanVanuatuVenezuelaVietnamBritish Virgin IslandsVirgin IslandsWallis and FutunaWestern SaharaYemenZambiaZimbabweAfricaAsiaEuropeNorth AmericaOceaniaSouth America
query.employeesMinintegermin 1 · whole numberany
query.employeesMaxintegermin 1 · whole numberany
query.technologiesstring[]—any
query.countintegermin 1 · whole number · default 25any
query.pageintegermin 1 · whole number · default 1any

Use case: find people

POST /admin/prospector/people/search with websiteId (from GET /admin/websites) and a query; every filter is optional (all filters). Searching never returns emails.

Response
{
  "httpStatus": 200,
  "people": [
    {
      "profileId": "3cbd7f0d47879822dd5f722ab6dfac85",
      "companyProfileId": "4a837e150440103296e07fd46e3f1ff1",
      "name": "Ava Thompson",
      "firstName": "Ava",
      "lastName": "Thompson",
      "position": "Founder",
      "jobTitle": "Founder",
      "jobTitles": ["Founder"],
      "seniority": "Owner",
      "department": "Executive",
      "company": "Northwind Analytics",
      "companyName": "Northwind Analytics",
      "companyDomain": "northwind-analytics.example",
      "companyLocation": { "city": "Austin", "country": "United States", "countryCode": "US" },
      "companyInfo": {
        "logo": null,
        "industry": "Computer Software",
        "sector": "Technology",
        "employees": "42",
        "revenue": "$1M - $10M",
        "description": null,
        "foundedYear": 2018,
        "tags": []
      },
      "linkedin": "https://www.linkedin.com/in/sample-ava-thompson-00",
      "emailStatus": null,
      "hasEmail": false,
      "hasPhone": true
    }
  ],
  "total": 6,
  "note": "locations filters on the company headquarters. jobTitle is the position that matched your titles filter; jobTitles lists every position the person holds. companyLocation / companyDomain are null when we do not hold that employer yet."
}

Next page: pass query.page.

Use case: get their email

POST /admin/prospector/people/reveal with websiteId and a profileId from the search. 1 credit when we hold an email or phone, nothing when we don’t.

curl -X POST "https://rest-dash.revealid.xyz/admin/prospector/people/reveal?privateKey=YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "websiteId": "64b7f0a1c2d3e4f5a6b7c8d9", "profileId": "71e392938b6bfb2a8f112058d0afc3f1" }'
Response
{
  "httpStatus": 200,
  "profileId": "71e392938b6bfb2a8f112058d0afc3f1",
  "businessEmail": "noah.ramirez@northwind-analytics.example",
  "emailStatus": "valid",
  "phone": null,
  "creditsCharged": 1,
  "status": "revealed",
  "remainingCredits": 498
}

When it fails

The HTTP status says why: 401 missing or wrong key, 402 no credits, 403 plan without Prospector, 429 more than one search per second or the plan’s search limit is used up.

On this page