{ "openapi": "3.0.1", "info": { "title": "People Search API - Work Email, Mobile and Company Data", "description": "Search a people and company index by role, skills, employer, industry, headcount, revenue, funding and detected web technologies, then pull work emails, personal emails and phone numbers for the people worth reaching. Also job post search and reverse lookup. Pay per result.", "version": "0.1", "x-build-id": "0ckicFaqg0R8CPVT7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~people-contact-data-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-people-contact-data-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/nabeelbaghoor~people-contact-data-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-people-contact-data-api", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/nabeelbaghoor~people-contact-data-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-people-contact-data-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "mode": { "title": "What to do", "enum": [ "searchPeople", "searchCompanies", "searchJobs", "personDetail", "personContacts", "reverseEmail", "reversePhone", "websiteDetail" ], "type": "string", "description": "The three searches find records from filters. The person modes take somebody you have already identified and return either their full profile or their contact details, which are separate purchases at this provider. The reverse modes turn an address or a number back into a person, and the website mode returns traffic rank and detected technologies for a domain.", "default": "searchPeople" }, "personIdentifiers": { "title": "People to look up", "type": "array", "description": "For the profile and contact modes: a professional network profile URL, a bare profile slug, or the provider own numeric person id, one per line. A whole URL is reduced to its slug for you.", "items": { "type": "string" } }, "contactKinds": { "title": "Which contact details to find", "type": "array", "description": "In person contacts mode, which of the three lookups to run for each person. Each is a separate call with its own credit price on your own plan, so asking for all three costs three times as much as asking for one. Personal emails are limited to consumer webmail providers by the provider itself, and a lookup that finds nothing costs no credit.", "items": { "type": "string", "enum": [ "workEmails", "personalEmails", "phoneNumbers" ], "enumTitles": [ "Work emails, with a validation status on each", "Personal emails, consumer webmail providers only", "Phone numbers" ] }, "default": [ "workEmails" ] }, "emails": { "title": "Email addresses", "type": "array", "description": "In reverse email mode, the addresses to identify, one per line.", "items": { "type": "string" } }, "phoneNumbers": { "title": "Phone numbers", "type": "array", "description": "In reverse phone mode, the numbers to identify, one per line. Include the country code.", "items": { "type": "string" } }, "domains": { "title": "Domains", "type": "array", "description": "In website details mode, the domains to look up, one per line. A full URL or an email address is reduced to its domain for you.", "items": { "type": "string" } }, "roleTitle": { "title": "Job title", "type": "string", "description": "People search. The title held at the employer, for example Head of Sales. This field takes the provider own boolean query language, so AND, OR, NOT and quoted phrases work and are passed through exactly as typed." }, "roleDescription": { "title": "Role description", "type": "string", "description": "People search. Words in the description of what the person does in the role. This field takes the provider own boolean query language, so AND, OR, NOT and quoted phrases work and are passed through exactly as typed." }, "personName": { "title": "Person name", "type": "string", "description": "People search. A first name, last name or full name. This field takes the provider own boolean query language, so AND, OR, NOT and quoted phrases work and are passed through exactly as typed." }, "personHeadline": { "title": "Person headline", "type": "string", "description": "People search. The one-line summary a person writes about themselves, which is often more specific than their formal title. This field takes the provider own boolean query language, so AND, OR, NOT and quoted phrases work and are passed through exactly as typed." }, "personDescription": { "title": "Person summary", "type": "string", "description": "People search. Words in the longer profile summary. This field takes the provider own boolean query language, so AND, OR, NOT and quoted phrases work and are passed through exactly as typed." }, "companyDescription": { "title": "Company description", "type": "string", "description": "People and company search. Words in the description of the company itself. This is the filter that finds companies doing a thing rather than companies filed under a category. This field takes the provider own boolean query language, so AND, OR, NOT and quoted phrases work and are passed through exactly as typed." }, "jobPostTitle": { "title": "Job post title", "type": "string", "description": "All three searches. The title on a job posting. In people and company search this finds organisations that are hiring for the role, which is a hiring-intent signal rather than a firmographic one. This field takes the provider own boolean query language, so AND, OR, NOT and quoted phrases work and are passed through exactly as typed." }, "jobPostDescription": { "title": "Job post description", "type": "string", "description": "All three searches. Words in the body of a job posting, which is where the tools a team actually uses tend to be named. This field takes the provider own boolean query language, so AND, OR, NOT and quoted phrases work and are passed through exactly as typed." }, "personLocations": { "title": "Person locations", "type": "array", "description": "Where the person is, as a city, region or country. Type the name and the actor resolves it to the internal id this provider filters on, once per name. A name it cannot match is reported in the log and left out rather than silently ignored.", "items": { "type": "string" } }, "personIndustries": { "title": "Person industries", "type": "array", "description": "The industry recorded against the person profile, which can differ from their employer industry. Type the name and the actor resolves it to the internal id this provider filters on, once per name. A name it cannot match is reported in the log and left out rather than silently ignored.", "items": { "type": "string" } }, "personIndustriesExclude": { "title": "Person industries to exclude", "type": "array", "description": "Industries to leave out of a people search. Type the name and the actor resolves it to the internal id this provider filters on, once per name. A name it cannot match is reported in the log and left out rather than silently ignored.", "items": { "type": "string" } }, "personSkills": { "title": "Person skills", "type": "array", "description": "Skills listed on the profile, for example Kubernetes or Contract Negotiation. Type the name and the actor resolves it to the internal id this provider filters on, once per name. A name it cannot match is reported in the log and left out rather than silently ignored.", "items": { "type": "string" } }, "companyNames": { "title": "Company names", "type": "array", "description": "Named companies to restrict a people search to. Resolved against the provider own company index rather than matched as text. Type the name and the actor resolves it to the internal id this provider filters on, once per name. A name it cannot match is reported in the log and left out rather than silently ignored.", "items": { "type": "string" } }, "companyLocations": { "title": "Company locations", "type": "array", "description": "Where the company is, as a city, region or country. Type the name and the actor resolves it to the internal id this provider filters on, once per name. A name it cannot match is reported in the log and left out rather than silently ignored.", "items": { "type": "string" } }, "companyIndustries": { "title": "Company industries", "type": "array", "description": "The industry the company is filed under. Type the name and the actor resolves it to the internal id this provider filters on, once per name. A name it cannot match is reported in the log and left out rather than silently ignored.", "items": { "type": "string" } }, "companyIndustriesExclude": { "title": "Company industries to exclude", "type": "array", "description": "Industries to leave out. Type the name and the actor resolves it to the internal id this provider filters on, once per name. A name it cannot match is reported in the log and left out rather than silently ignored.", "items": { "type": "string" } }, "companyKeywords": { "title": "Company keywords", "type": "array", "description": "Keywords attached to the company by the provider, which are broader than its own description. Type the name and the actor resolves it to the internal id this provider filters on, once per name. A name it cannot match is reported in the log and left out rather than silently ignored.", "items": { "type": "string" } }, "companyTechnologies": { "title": "Web technologies", "type": "array", "description": "Technologies detected on the company website, for example Shopify, Segment or Salesforce. This is the technographic filter. Type the name and the actor resolves it to the internal id this provider filters on, once per name. A name it cannot match is reported in the log and left out rather than silently ignored.", "items": { "type": "string" } }, "jobPostLocations": { "title": "Job post locations", "type": "array", "description": "Where a job posting is located. Type the name and the actor resolves it to the internal id this provider filters on, once per name. A name it cannot match is reported in the log and left out rather than silently ignored.", "items": { "type": "string" } }, "jobPostLocationsExclude": { "title": "Job post locations to exclude", "type": "array", "description": "Job posting locations to leave out. Type the name and the actor resolves it to the internal id this provider filters on, once per name. A name it cannot match is reported in the log and left out rather than silently ignored.", "items": { "type": "string" } }, "personLinkedinSlugs": { "title": "Person profile URLs or slugs", "type": "array", "description": "People search. Restrict to specific people by professional network profile URL or slug. A whole URL is reduced to its slug for you.", "items": { "type": "string" } }, "companyDomains": { "title": "Company domains", "type": "array", "description": "People and company search. Restrict to companies at these website domains, one per line.", "items": { "type": "string" } }, "companyLinkedinSlugs": { "title": "Company profile URLs or slugs", "type": "array", "description": "People and company search. Restrict to specific companies by professional network URL or slug.", "items": { "type": "string" } }, "fundingTypes": { "title": "Funding round types", "type": "array", "description": "People and company search. Restrict to companies that have raised one of these round types. Pair it with the funding total and funding date ranges to find companies that recently raised at a particular stage.", "items": { "type": "string", "enum": [ "angel", "convertible_note", "corporate_round", "debt_financing", "equity_crowdfunding", "grant", "initial_coin_offering", "non_equity_assistance", "post_ipo_debt", "post_ipo_equity", "post_ipo_secondary", "pre_seed", "private_equity", "product_crowdfunding", "secondary_market", "seed", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "series_i", "series_j", "series_unknown", "undisclosed" ], "enumTitles": [ "Angel", "Convertible Note", "Corporate Round", "Debt Financing", "Equity Crowdfunding", "Grant", "Initial Coin Offering", "Non Equity Assistance", "Post Ipo Debt", "Post Ipo Equity", "Post Ipo Secondary", "Pre Seed", "Private Equity", "Product Crowdfunding", "Secondary Market", "Seed", "Series A", "Series B", "Series C", "Series D", "Series E", "Series F", "Series G", "Series H", "Series I", "Series J", "Series Unknown", "Undisclosed" ] }, "default": [] }, "jobSource": { "title": "Job board", "enum": [ "", "indeed", "linkedin", "angellist" ], "type": "string", "description": "Job post search only. Restrict to postings from one board. Leave empty for all of them.", "default": "" }, "currentRolesOnly": { "title": "Current roles only", "type": "boolean", "description": "People search. Keep only roles the person still holds. Leave this off to search work history, which is how you find people who used to do a job somewhere.", "default": false }, "jobPostIsRemote": { "title": "Remote job posts only", "type": "boolean", "description": "Restrict the job post part of the search to remote postings.", "default": false }, "jobPostIsActive": { "title": "Active job posts only", "type": "boolean", "description": "Restrict the job post part of the search to postings that are still open. Leave off to include historical ones, which is what you want when measuring what a company has been hiring for over time.", "default": false }, "yearsInRoleMin": { "title": "Minimum years in the current role", "minimum": 0, "maximum": 60, "type": "integer", "description": "People search only. Lower bound on years in the current role. Leave at zero for no lower bound.", "default": 0 }, "yearsInRoleMax": { "title": "Maximum years in the current role", "minimum": 0, "maximum": 60, "type": "integer", "description": "People search only. Upper bound on years in the current role. Leave at zero for no upper bound.", "default": 0 }, "headcountMin": { "title": "Minimum employee count", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "People and company search. Lower bound on employee count. Leave at zero for no lower bound.", "default": 0 }, "headcountMax": { "title": "Maximum employee count", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "People and company search. Upper bound on employee count. Leave at zero for no upper bound.", "default": 0 }, "revenueMin": { "title": "Minimum annual revenue in dollars", "minimum": 0, "maximum": 1000000000000, "type": "integer", "description": "People and company search. Lower bound on annual revenue in dollars. Leave at zero for no lower bound.", "default": 0 }, "revenueMax": { "title": "Maximum annual revenue in dollars", "minimum": 0, "maximum": 1000000000000, "type": "integer", "description": "People and company search. Upper bound on annual revenue in dollars. Leave at zero for no upper bound.", "default": 0 }, "domainRankMin": { "title": "Minimum website traffic rank", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "People and company search. A lower number is a busier site, so a maximum here is a floor on popularity. Lower bound on website traffic rank. Leave at zero for no lower bound.", "default": 0 }, "domainRankMax": { "title": "Maximum website traffic rank", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "People and company search. A lower number is a busier site, so a maximum here is a floor on popularity. Upper bound on website traffic rank. Leave at zero for no upper bound.", "default": 0 }, "domainTrafficMin": { "title": "Minimum monthly website visits", "minimum": 0, "maximum": 100000000000, "type": "integer", "description": "Company search only. Lower bound on monthly website visits. Leave at zero for no lower bound.", "default": 0 }, "domainTrafficMax": { "title": "Maximum monthly website visits", "minimum": 0, "maximum": 100000000000, "type": "integer", "description": "Company search only. Upper bound on monthly website visits. Leave at zero for no upper bound.", "default": 0 }, "fundingTotalMin": { "title": "Minimum total raised in dollars", "minimum": 0, "maximum": 1000000000000, "type": "integer", "description": "People and company search. Lower bound on total raised in dollars. Leave at zero for no lower bound.", "default": 0 }, "fundingTotalMax": { "title": "Maximum total raised in dollars", "minimum": 0, "maximum": 1000000000000, "type": "integer", "description": "People and company search. Upper bound on total raised in dollars. Leave at zero for no upper bound.", "default": 0 }, "roleStartedFrom": { "title": "Role start date from", "type": "string", "description": "People search only. Narrow to people who started their current role in a window, which is how you reach somebody in their first months in a job. Earliest the role start date, as YYYY-MM-DD. Leave empty for no lower bound." }, "roleStartedTo": { "title": "Role start date to", "type": "string", "description": "People search only. Narrow to people who started their current role in a window, which is how you reach somebody in their first months in a job. Latest the role start date, as YYYY-MM-DD. Leave empty for no upper bound." }, "foundedFrom": { "title": "Company founding date from", "type": "string", "description": "People and company search. Earliest the company founding date, as YYYY-MM-DD. Leave empty for no lower bound." }, "foundedTo": { "title": "Company founding date to", "type": "string", "description": "People and company search. Latest the company founding date, as YYYY-MM-DD. Leave empty for no upper bound." }, "fundedFrom": { "title": "Funding round date from", "type": "string", "description": "People and company search. Pair with the round types to find companies that raised recently. Earliest the funding round date, as YYYY-MM-DD. Leave empty for no lower bound." }, "fundedTo": { "title": "Funding round date to", "type": "string", "description": "People and company search. Pair with the round types to find companies that raised recently. Latest the funding round date, as YYYY-MM-DD. Leave empty for no upper bound." }, "jobPostedFrom": { "title": "Job posting date from", "type": "string", "description": "All three searches. Earliest the job posting date, as YYYY-MM-DD. Leave empty for no lower bound." }, "jobPostedTo": { "title": "Job posting date to", "type": "string", "description": "All three searches. Latest the job posting date, as YYYY-MM-DD. Leave empty for no upper bound." }, "requireLinkedinProfile": { "title": "Keep only rows with a profile URL", "type": "boolean", "description": "Drop rows carrying no professional network profile for the person or the company. Useful when the output feeds something that needs a profile to work from.", "default": false }, "requireCompanyDomain": { "title": "Keep only rows with a company domain", "type": "boolean", "description": "Drop rows where the company website domain is unknown. A domain is what most downstream enrichment needs.", "default": false }, "emailStatuses": { "title": "Keep only these email statuses", "type": "array", "description": "In person contacts mode, keep only rows whose best address carries one of these validation statuses. Leave empty to keep every status.", "items": { "type": "string", "enum": [ "valid", "risky", "invalid", "unknown" ], "enumTitles": [ "Valid", "Risky", "Invalid", "Unknown" ] }, "default": [] }, "minCompanyHeadcount": { "title": "Minimum company headcount in the result", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Drop rows whose company is smaller than this, after the fact. Different from the headcount range above, which is asked of the provider: this one also applies to the lookup modes, where there is no search filter to use.", "default": 0 }, "accountId": { "title": "Account id", "minimum": 0, "maximum": 999999999, "type": "integer", "description": "Which of your provider accounts to run against. Leave at zero and the actor reads it from your key, which is right unless your key reaches more than one account.", "default": 0 }, "requestsPerMinute": { "title": "Requests per minute", "minimum": 1, "maximum": 600, "type": "integer", "description": "Pace the run so it stays under whatever rate your plan allows.", "default": 120 }, "skipNotFound": { "title": "Skip values with no result", "type": "boolean", "description": "Leave values the provider returned nothing for, and inputs refused before they were sent, out of the dataset. Off by default, because knowing which of your inputs could not be resolved is usually the point. Misses are never charged for either way.", "default": false }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many rows. This is the cap on both spend and run time.", "default": 100 }, "apiKey": { "title": "API key", "type": "string", "description": "Your own API key for the people and company data API, created in your provider account. Sent in a header and never written to the log. Stored as a secret." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }