---
updatedAt: 2026-08-17T14:21:10.000Z
agentTools:
projectIndex: https://docs.ai-ark.com/llms.txt
---
# People Search API
Searches 400+ million enriched, verified and active person profiles using contact and/or account (company) filters β the starting point for building outbound lead lists. Each result contains the full person profile and their company data. Results do not include emails or phone numbers β enrich them with the endpoints listed under Related Endpoints below.
π³ Credit Usage: 0.5 credits per returned result (e.g. size: 25 with 25 matches = 12.5 credits). You only pay for results actually returned.
β οΈ Track ID: The response includes a trackId. Pass it to Find Emails by Track ID to get verified emails for this exact result set. The trackId can be used once and expires 6 hours after this response β submit it promptly.
Contact Filters:
Profile: Full Name, Social Media Link, LinkedIn, Location, Language Skills, Profile Badge, LinkedIn Follower & Connection Count
Professional: Current & Past Company, Seniority, Department and Function, Experience (Current/Previous Title, Duration)
Skills & Education: Skills, Certifications, Education (School, Degree, Field of Study, Date), Keywords, Social Media
Account Filters:
Company Identification: Name or Domain, Domain, LinkedIn, URL, Name, Social Media Link, Phone Number
Company Details: Industry, Location, Products and Services, Social Media, Company Type, Founded Year, Operation Language, Geo Location
Financial & Size: Employee Size, Annual Revenue, Funding
Advanced Filters: Keywords, Employee by Department, Headcount Growth, Technologies, NAICS
π Related Endpoints:
β’ People Preview β validate these filters first for a flat 1 credit per page
β’ Find Emails by Track ID β get BounceBan-verified emails for this result set (1 credit per found email, 0 if not found)
β’ Export People with Email β search + email finding in a single async call, up to 10,000 people
β’ Export Single Person with Email β enrich one person from a result id
β’ Company Search β build the account list first, then target its employees via contact.company
β’ Lists β exclude already-contacted people (free)
π₯ Filter value lists: industries.csv (919) Β· technologies.csv (16,000+) Β· departments-and-functions.csv (617). All other allowed values are listed inline in the field descriptions below.
Learn how to use this API to enrich leads inside Clay: Watch Video
Rate limits: 5 requests per second by default. Customers using more than 450,000 credits per month can get custom rate limits β contact us at support@ai-ark.com or via the in-app chat.
The header Content-Type: application/json must be included in the request.
# OpenAPI definition
````json
{
"openapi": "3.1.0",
"info": {
"title": "AI Ark",
"version": "1.0.0",
"contact": {}
},
"servers": [
{
"url": "https://api.ai-ark.com/api/developer-portal"
}
],
"paths": {
"/v1/people": {
"post": {
"tags": [
"People Search"
],
"summary": "People Search API",
"description": "Searches 400+ million enriched, verified and active person profiles using contact and/or account (company) filters β the starting point for building outbound lead lists. Each result contains the full person profile and their company data. Results do not include emails or phone numbers β enrich them with the endpoints listed under Related Endpoints below.
π³ Credit Usage: 0.5 credits per returned result (e.g. size: 25 with 25 matches = 12.5 credits). You only pay for results actually returned.
β οΈ Track ID: The response includes a trackId. Pass it to Find Emails by Track ID to get verified emails for this exact result set. The trackId can be used once and expires 6 hours after this response β submit it promptly.
Contact Filters:
Profile: Full Name, Social Media Link, LinkedIn, Location, Language Skills, Profile Badge, LinkedIn Follower & Connection Count
Professional: Current & Past Company, Seniority, Department and Function, Experience (Current/Previous Title, Duration)
Skills & Education: Skills, Certifications, Education (School, Degree, Field of Study, Date), Keywords, Social Media
Account Filters:
Company Identification: Name or Domain, Domain, LinkedIn, URL, Name, Social Media Link, Phone Number
Company Details: Industry, Location, Products and Services, Social Media, Company Type, Founded Year, Operation Language, Geo Location
Financial & Size: Employee Size, Annual Revenue, Funding
Advanced Filters: Keywords, Employee by Department, Headcount Growth, Technologies, NAICS
π Related Endpoints:
β’ People Preview β validate these filters first for a flat 1 credit per page
β’ Find Emails by Track ID β get BounceBan-verified emails for this result set (1 credit per found email, 0 if not found)
β’ Export People with Email β search + email finding in a single async call, up to 10,000 people
β’ Export Single Person with Email β enrich one person from a result id
β’ Company Search β build the account list first, then target its employees via contact.company
β’ Lists β exclude already-contacted people (free)
π₯ Filter value lists: industries.csv (919) Β· technologies.csv (16,000+) Β· departments-and-functions.csv (617). All other allowed values are listed inline in the field descriptions below.
Learn how to use this API to enrich leads inside Clay: Watch Video
Rate limits: 5 requests per second by default. Customers using more than 450,000 credits per month can get custom rate limits β contact us at support@ai-ark.com or via the in-app chat.
The header Content-Type: application/json must be included in the request.",
"operationId": "people-search",
"security": [
{
"Header": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"page",
"size"
],
"properties": {
"account": {
"allOf": [
{
"$ref": "#/components/schemas/AccountFilter"
}
]
},
"contact": {
"allOf": [
{
"$ref": "#/components/schemas/ContactFilter"
}
]
},
"lists": {
"$ref": "#/components/schemas/PeopleListsFilter",
"description": "Reference exclusion lists created via `POST /v1/lists` (free): `{ \"people_id\": { \"exclude\": [\"\"] } }` on people endpoints, `{ \"company_id\": { \"exclude\": [\"\"] } }` on Company Search. Up to **10 lists per request**, each holding up to 10,000 items. Standard uses: suppress already-contacted prospects, and paginate beyond the 10,000-result cap.\n\n---"
},
"page": {
"type": "integer",
"description": "**Required** on People Search and Company Search (default `0`). Zero-based page number. Use with `size` to paginate. The full result set is capped at 10,000 records per search β see the Lists pagination pattern above to go deeper.",
"example": 0,
"default": 0
},
"size": {
"type": "integer",
"description": "**Required** on People Search and Company Search. Results per page: max 100. Default **10** on People Search / Company Search, **25** on Preview. On Export People with Email, `size` is the total export size, up to 10,000.",
"minimum": 0,
"maximum": 100,
"example": 10,
"default": 10
}
}
},
"example": {
"account": {
"domain": {
"any": {
"include": [
"Amazon.com"
]
}
},
"linkedin": {
"any": {
"include": [
"http://linkedin.com/company/amazon"
]
}
},
"url": {
"any": {
"include": {
"mode": "SMART",
"content": [
"amazon.com"
]
}
}
},
"name": {
"any": {
"include": {
"mode": "SMART",
"content": [
"Amazon"
]
}
}
},
"socialMediaLink": {
"any": {
"include": [
"https://www.facebook.com/amazon"
]
}
},
"phoneNumber": {
"any": {
"include": [
"+18885335659"
]
}
},
"industries": {
"any": {
"include": {
"mode": "WORD",
"content": [
"retail"
]
},
"exclude": {
"mode": "WORD",
"content": [
"construction"
]
}
},
"all": {
"include": {
"mode": "WORD",
"content": [
"software development"
]
},
"exclude": {
"mode": "WORD",
"content": [
"real estate"
]
}
}
},
"location": {
"any": {
"include": [
"United States"
]
}
},
"productAndServices": {
"any": {
"include": {
"mode": "SMART",
"content": [
"e-commerce"
]
}
}
},
"socialMedia": {
"any": {
"include": [
"LINKEDIN"
]
}
},
"type": {
"any": {
"include": [
"PUBLIC_COMPANY"
]
}
},
"foundedYear": {
"type": "RANGE",
"range": {
"start": 1994,
"end": 2020
}
},
"employeeSize": {
"type": "RANGE",
"range": [
{
"start": 1000,
"end": 5000
}
]
},
"retailSize": {
"type": "RANGE",
"range": [
{
"start": 1,
"end": 10
}
]
},
"revenue": {
"type": "RANGE",
"range": [
{
"start": 0,
"end": 99999
}
]
},
"language": {
"any": {
"include": [
"english"
]
},
"range": {
"start": 1,
"end": 5
}
},
"geoLocation": {
"position": {
"lat": 47.6062,
"lng": -122.3321
},
"radius": 50,
"unit": "km"
},
"keyword": {
"any": {
"include": {
"sources": [
{
"mode": "SMART",
"source": "NAME"
}
],
"content": [
"retail"
]
}
}
},
"funding": {
"type": [
"VENTURE_ROUND"
],
"totalAmount": {
"start": 1000000,
"end": 5000000
},
"lastAmount": {
"start": 500000,
"end": 2000000
},
"duration": {
"start": "1620847800000",
"end": "1747168200000"
}
},
"metric": {
"employee": [
{
"function": [
"sales"
],
"start": 10,
"end": 100
}
],
"growth": [
{
"function": [
"sales"
],
"start": 10,
"end": 100,
"timeFrame": "SIX"
}
]
},
"technology": {
"any": {
"include": [
"AWS"
]
}
},
"technologies": {
"any": {
"include": {
"mode": "WORD",
"content": [
"java"
]
},
"exclude": {
"mode": "WORD",
"content": [
"Python"
]
}
},
"all": {
"include": {
"mode": "WORD",
"content": [
"React"
]
},
"exclude": {
"mode": "WORD",
"content": [
"JavaScript"
]
}
}
},
"naics": {
"any": {
"include": [
"454110"
]
}
}
},
"contact": {
"fullName": {
"any": {
"include": {
"mode": "SMART",
"content": [
"David Bowie"
]
}
}
},
"socialMediaLink": {
"any": {
"include": [
"https://www.facebook.com/joneslisap"
]
}
},
"company": {
"latest": {
"any": {
"include": [
"931fc1a0-1ed5-baf8-0dd2-a068a0fd0430"
]
}
},
"current": {
"any": {
"include": [
"b4e53e29-32e5-7d82-642b-8e054bec6b67"
]
}
},
"previous": {
"any": {
"include": [
"8b1c2fa5-3ceb-437e-5ef5-495bc6d34ace"
]
}
}
},
"seniority": {
"any": {
"include": [
"founder"
]
}
},
"location": {
"any": {
"include": [
"United States"
]
}
},
"linkedin": {
"any": {
"include": [
"https://www.linkedin.com/in/david-bowie"
]
}
},
"departmentAndFunction": {
"any": {
"include": [
"product_management"
]
}
},
"skill": {
"any": {
"include": {
"mode": "SMART",
"content": [
"leadership"
]
}
}
},
"certification": {
"any": {
"include": {
"mode": "SMART",
"content": [
"Scrum Master Certification (CSM)"
]
}
}
},
"keyword": {
"any": {
"include": {
"sources": [
{
"mode": "SMART",
"source": "ORGANIZATION"
}
],
"content": [
"music"
]
}
}
},
"socialMedia": {
"any": {
"include": [
"LINKEDIN"
]
}
},
"language": {
"any": {
"include": {
"mode": "SMART",
"content": [
"english"
]
}
},
"range": {
"start": 1,
"end": 5
}
},
"education": {
"school": {
"any": {
"include": [
"49c9a269-b00e-28ac-eeb6-f74d3fd32a00"
]
}
},
"degree": {
"any": {
"include": {
"mode": "SMART",
"content": [
"Marketing digital"
]
}
}
},
"fieldOfStudy": {
"any": {
"include": {
"mode": "SMART",
"content": [
"digital communication"
]
}
}
},
"date": {
"start": 2015,
"end": 2025,
"present": false
}
},
"profileBadge": {
"any": {
"include": [
"VERIFIED"
]
}
},
"socialMediaFollower": {
"linkedin": {
"followers": {
"type": "RANGE",
"range": [
{
"start": 1,
"end": 500
},
{
"start": 1000,
"end": 2000
},
{
"start": 30000
}
]
},
"connections": {
"type": "RANGE",
"range": [
{
"start": 1500,
"end": 4200
}
]
}
}
},
"experience": {
"latest": {
"title": {
"any": {
"include": {
"mode": "SMART",
"content": [
"founder"
]
}
}
}
},
"current": {
"title": {
"any": {
"include": {
"mode": "SMART",
"content": [
"founder"
]
}
}
},
"duration": {
"currentCompany": {
"min": {
"year": 2,
"month": 6
},
"max": {
"year": 5,
"month": 0
}
},
"currentJob": {
"min": {
"year": 1,
"month": 0
},
"max": {
"year": 3,
"month": 6
}
},
"total": {
"min": {
"year": 5,
"month": 0
},
"max": {
"year": 10,
"month": 0
}
}
}
},
"previous": {
"title": {
"any": {
"include": {
"mode": "SMART",
"content": [
"founder"
]
}
}
}
}
}
},
"lists": {
"people_id": {
"exclude": [
"294ce93e-8881-414c-8951-e91b5df7f560"
]
}
},
"page": 0,
"size": 10
}
}
}
},
"responses": {
"200": {
"description": "People Search",
"content": {
"application/json": {
"schema": {
"type": "object",
"example": "{ \"content\": [ {\n \"id\": \"18d20042-3d11-030a-c4c1-21c45c5cb821\",\n \"identifier\": \"dan-claps-cfe-ceo-of-voda-cleaning-and-restoration-0036b9a2\",\n \"profile\": {\n \"first_name\": \"Dan\",\n \"last_name\": \"Claps, CFE (CEO of VODA Cleaning and Restoration)\",\n \"full_name\": \"Dan Claps, CFE (CEO of VODA Cleaning and Restoration)\",\n \"headline\": \"CEO of Voda Cleaning and Restoration\",\n \"title\": \"Chief Executive Officer & Co-Founder\",\n \"picture\": {\n \"source\": \"https://s3.ai-ark.com/ark-person/images/18d20042-3d11-030a-c4c1-21c45c5cb821.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251010T094403Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=HC2GZVQFT79BXWGX0GP2%2F20251010%2Fai-ark%2Fs3%2Faws4_request&X-Amz-Signature=5f02a55561a32e47445628f8e420177b6f17bbaa19289a9d7a1ccfc66259dc9a\"\n },\n \"background\": {\n \"source\": \"https://media.licdn.com/dms/image/v2/D4E16AQEoExFnEd9npA/profile-displaybackgroundimage-shrink_350_1400/profile-displaybackgroundimage-shrink_350_1400/0/1680632085748?e=1755734400&v=beta&t=jDu0ckMch0FJCWbn7Kzy9lg2e1ewq9vqLpvHcF4-NjU\"\n },\n \"birth_date\": null,\n \"summary\": \"Dan Claps is an accomplished entrepreneur and visionary leader, best known as the CEO of Voda Cleaning & Restoration, a premier cleaning and restoration franchise. With a passion for empowering business owners and delivering exceptional customer service, Dan has positioned Voda as a trusted brand in its industry.\"\n },\n \"link\": {\n \"linkedin\": \"https://www.linkedin.com/in/dan-claps-cfe-ceo-of-voda-cleaning-and-restoration-0036b9a2\",\n \"twitter\": null,\n \"github\": null,\n \"facebook\": null\n },\n \"location\": {\n \"country\": \"United States\",\n \"state\": \"New York\",\n \"city\": \"New York\",\n \"position\": null,\n \"default\": \"New York, New York, United States, North America\",\n \"short\": \"New York, New York\"\n },\n \"languages\": {\n \"primary_locale\": {\n \"country\": \"US\",\n \"language\": \"en\"\n },\n \"supported_locales\": [\n {\n \"country\": \"US\",\n \"language\": \"en\"\n }\n ],\n \"profile_languages\": null\n },\n \"industry\": \"Consumer Services\",\n \"educations\": [\n {\n \"school\": {\n \"id\": null,\n \"name\": \"South Brunswick High School\",\n \"logo\": null,\n \"url\": null\n },\n \"degree_name\": null,\n \"field_of_study\": \"High School\",\n \"grade\": null,\n \"date\": null\n }\n ],\n \"certifications\": [\n {\n \"name\": \"Certified Franchise Executive (CFE)\",\n \"authority\": \"International Franchise Association\",\n \"url\": null,\n \"license_number\": null,\n \"display_source\": null,\n \"company\": null,\n \"date\": {\n \"start\": \"2022-12-01\",\n \"end\": null\n }\n }\n ],\n \"organizations\": [\n {\n \"name\": \"BNI\",\n \"position\": \"Event Coordinator\",\n \"date\": {\n \"start\": \"2015-01-01\",\n \"end\": null\n }\n }\n ],\n \"position_groups\": [\n {\n \"company\": {\n \"id\": \"5fbd1182-3d7e-3c5d-adbd-8da44e040f00\",\n \"name\": \"Voda Cleaning & Restoration\",\n \"logo\": \"https://s3.ai-ark.com/ark-company/images/5fbd1182-3d7e-3c5d-adbd-8da44e040f00.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251010T094403Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=HC2GZVQFT79BXWGX0GP2%2F20251010%2Fai-ark%2Fs3%2Faws4_request&X-Amz-Signature=91872611e253dcc43918260f66ba52d846675192b1a8057f36e3bf7c5d4a52e1\",\n \"url\": \"https://www.linkedin.com/company/vodacleaningrestoration\",\n \"employees\": {\n \"start\": 11,\n \"end\": 50\n }\n },\n \"date\": {\n \"start\": \"2023-01-01\",\n \"end\": null\n },\n \"profile_positions\": [\n {\n \"company\": \"Voda Cleaning & Restoration\",\n \"description\": null,\n \"title\": \"Chief Executive Officer & Co-Founder\",\n \"employment_type\": \"Full-time\",\n \"location\": \"West Salem, Wisconsin, United States\",\n \"date\": {\n \"start\": \"2023-01-01\",\n \"end\": null\n }\n }\n ]\n },\n {\n \"company\": {\n \"id\": \"b8b3dba5-3b71-7246-9044-b03ec53694bb\",\n \"name\": \"Titus Center for Franchising at Palm Beach Atlantic University\",\n \"logo\": \"https://s3.ai-ark.com/ark-company/images/b8b3dba5-3b71-7246-9044-b03ec53694bb.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251010T094403Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=HC2GZVQFT79BXWGX0GP2%2F20251010%2Fai-ark%2Fs3%2Faws4_request&X-Amz-Signature=6aeb7a66678b818449dfc24efd4d75d2e3b209f5325564fc270dd61feaf17c2c\",\n \"url\": \"https://www.linkedin.com/school/titus-center-for-franchising-at-palm-beach-atlantic-university\",\n \"employees\": {\n \"start\": 201,\n \"end\": 500\n }\n },\n \"date\": {\n \"start\": \"2025-01-01\",\n \"end\": null\n },\n \"profile_positions\": [\n {\n \"company\": \"Titus Center for Franchising at Palm Beach Atlantic University\",\n \"description\": null,\n \"title\": \"Advisory Board Member\",\n \"employment_type\": \"Freelance\",\n \"location\": \"West Palm Beach, Florida, United States\",\n \"date\": {\n \"start\": \"2025-01-01\",\n \"end\": null\n }\n }\n ]\n },\n {\n \"company\": {\n \"id\": \"0c8aea79-328e-0a97-2d05-91de85926a9e\",\n \"name\": \"Franchise Playbook\",\n \"logo\": \"https://s3.ai-ark.com/ark-company/images/0c8aea79-328e-0a97-2d05-91de85926a9e.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251010T094403Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=HC2GZVQFT79BXWGX0GP2%2F20251010%2Fai-ark%2Fs3%2Faws4_request&X-Amz-Signature=c58ce1e6c714fad692502c920728952b57505413a404e5bdde6ce026ba3b1531\",\n \"url\": \"https://www.linkedin.com/company/franchise-playbook\",\n \"employees\": {\n \"start\": 2,\n \"end\": 10\n }\n },\n \"date\": {\n \"start\": \"2022-12-01\",\n \"end\": null\n },\n \"profile_positions\": [\n {\n \"company\": \"Franchise Playbook\",\n \"description\": \"Franchise Playbook is an incubator of franchise brands. We create, own and operate dynamic franchise brands in the mobile services space.\",\n \"title\": \"Founder & Chief Executive Officer\",\n \"employment_type\": \"Full-time\",\n \"location\": \"New York City Metropolitan Area\",\n \"date\": {\n \"start\": \"2022-12-01\",\n \"end\": null\n }\n }\n ]\n },\n {\n \"company\": {\n \"id\": \"d2dea81f-c0c8-500a-09a8-fce32fe7bf3c\",\n \"name\": \"Murphy Business & Financial Corporation\",\n \"logo\": \"https://s3.ai-ark.com/ark-company/images/d2dea81f-c0c8-500a-09a8-fce32fe7bf3c.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251010T094403Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=HC2GZVQFT79BXWGX0GP2%2F20251010%2Fai-ark%2Fs3%2Faws4_request&X-Amz-Signature=2f799dc5472477c098e5f852e14942c6ef0dc38a7a2dc045d69fd8bb43961e08\",\n \"url\": \"https://www.linkedin.com/company/murphy-business\",\n \"employees\": {\n \"start\": 201,\n \"end\": 500\n }\n },\n \"date\": {\n \"start\": \"2015-01-01\",\n \"end\": \"2017-12-01\"\n },\n \"profile_positions\": [\n {\n \"company\": \"Murphy Business & Financial Corporation\",\n \"description\": \"I am a Business Broker, I represent buyers and sellers of businesses acting as the intermediary between both parties. I help sole proprietors, partnerships and private equity groups purchase a business venture and help sellers find the right party to acquire their business. \\n\\nIf you are looking to sell your business, evaluate the market value of your business or want to buy a business please call me at 732-476-9273.\",\n \"title\": \"Business Broker\",\n \"employment_type\": null,\n \"location\": \"Westfield, New Jersey\",\n \"date\": {\n \"start\": \"2015-01-01\",\n \"end\": \"2017-12-01\"\n }\n }\n ]\n },\n {\n \"company\": {\n \"id\": \"ab6578aa-049b-9a30-1e47-a9afa21474cd\",\n \"name\": \"Heartland\",\n \"logo\": \"https://s3.ai-ark.com/ark-company/images/ab6578aa-049b-9a30-1e47-a9afa21474cd.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251010T094403Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=HC2GZVQFT79BXWGX0GP2%2F20251010%2Fai-ark%2Fs3%2Faws4_request&X-Amz-Signature=e7f14d6d6613be13065e7f9e0b8f8ceabfce8187d8f6fb30a8615237da40c3ea\",\n \"url\": \"https://www.linkedin.com/company/heartland-payment-systems\",\n \"employees\": {\n \"start\": 1001,\n \"end\": 5000\n }\n },\n \"date\": {\n \"start\": \"2014-09-01\",\n \"end\": \"2015-01-01\"\n },\n \"profile_positions\": [\n {\n \"company\": \"Heartland Payment Systems\",\n \"description\": \"Implement consultative sales approach to discover and address business needs. Present and deliver business solutions to prospective clients.\",\n \"title\": \"Sales And Business Development\",\n \"employment_type\": null,\n \"location\": \"princeton\",\n \"date\": {\n \"start\": \"2014-09-01\",\n \"end\": \"2015-01-01\"\n }\n }\n ]\n }\n ],\n \"skills\": [\n \"Marketing\",\n \"Direct Sales\",\n \"Marketing Strategy\",\n \"Advertising\",\n \"Sales Management\",\n \"Salesforce.com\",\n \"Social Media\",\n \"Account Management\",\n \"Sales Process\",\n \"Customer Service\",\n \"Consultative Selling\",\n \"Negotiation\",\n \"Training\",\n \"B2B\",\n \"Cold Calling\",\n \"Sales Presentations\",\n \"Business Development\",\n \"Strategic Partnerships\",\n \"Sales Operations\",\n \"Solution Selling\"\n ],\n \"member_badges\": {\n \"creator\": true,\n \"hiring\": false,\n \"open_to_work\": false,\n \"premium\": false\n },\n \"company\": {\n \"id\": \"5fbd1182-3d7e-3c5d-adbd-8da44e040f00\",\n \"summary\": {\n \"name\": \"Voda Cleaning & Restoration\",\n \"description\": \"Voda Cleaning & Restoration is elevating the standards of cleaning & restoration across the nation. Our mission is to make life easier for those responsible for creating inviting, healthy spaces where people live, work and do business. \\n\\nWe're your secret weapon, knowledgable sidekick and your first call when your carpet and floors are less than dazzling, allergies are acting up or flooding invades your home. Because you know weβll be there. Itβs all right there in our name β Voda β meaning water. A gentle, cleansing element that has the power to safely renew your space. Washing over the seen and unseen areas, leaving nothing behind but a radiant clean. So you can get back to living.\\n\\nOur Services: \\n- Carpet Cleaning\\n- Water Damage Restoration\\n- Hardwood Floor Cleaning and Polishing\\n- Tile and Grout Cleaning\\n- Upholstery Cleaning\\n- Odor and Mold Mitigation\\n\\nNOW FRANCHISING: Call us at 608-405-6717 or email info@myvoda.com to learn about owning a Voda Cleaning & Restoration franchise. Key markets available across the country!\",\n \"seo\": \"A new level of franchise opportunity. Start a cleaning & restoration business with Voda Cleaning & Restoration. Contact us at 608-405-6717.\",\n \"founded_year\": 2009,\n \"type\": \"PRIVATELY_HELD\",\n \"industry\": \"consumer services\",\n \"staff\": {\n \"total\": 113,\n \"range\": {\n \"start\": 11,\n \"end\": 50\n }\n },\n \"logo\": {\n \"source\": \"https://s3.ai-ark.com/ark-company/images/5fbd1182-3d7e-3c5d-adbd-8da44e040f00.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251010T094403Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=HC2GZVQFT79BXWGX0GP2%2F20251010%2Fai-ark%2Fs3%2Faws4_request&X-Amz-Signature=91872611e253dcc43918260f66ba52d846675192b1a8057f36e3bf7c5d4a52e1\"\n }\n },\n \"link\": {\n \"website\": \"http://myvodafranchise.com\",\n \"domain\": \"myvodafranchise.com\",\n \"domain_ltd\": \"myvodafranchise.com\",\n \"linkedin\": \"https://www.linkedin.com/company/vodacleaningrestoration\"\n },\n \"financial\": {\n \"revenue\": {\n \"annual\": {\n \"start\": 1000000,\n \"end\": 5000000,\n \"amount\": \"1000000-5000000\"\n }\n }\n },\n \"location\": {\n \"headquarter\": {\n \"continent\": \"North America\",\n \"country\": \"United States\",\n \"city\": \"Madison, Wi\",\n \"raw_address\": \"Madison, Wi, United States, North America\",\n \"position\": {\n \"lng\": -89.36674,\n \"lat\": 43.13113\n }\n },\n \"locations\": [\n {\n \"continent\": \"North America\",\n \"country\": \"United States\",\n \"city\": \"Madison, Wi\",\n \"raw_address\": \"Madison, Wi, United States, North America\",\n \"position\": {\n \"lng\": -89.36674,\n \"lat\": 43.13113\n }\n }\n ]\n },\n \"technologies\": [\n {\n \"name\": \"Bootstrap Framework\",\n \"category\": \"CSS and JavaScript Libraries\"\n },\n {\n \"name\": \"DoubleClick\",\n \"category\": \"Ad Servers\"\n },\n {\n \"name\": \"DoubleClick Conversion\",\n \"category\": \"Advertising Networks\"\n },\n {\n \"name\": \"Facebook Custom Audiences\",\n \"category\": \"Retargeting\"\n },\n {\n \"name\": \"Facebook Login (Connect)\",\n \"category\": \"Social Login\"\n },\n {\n \"name\": \"Facebook Widget\",\n \"category\": \"Widgets\"\n },\n {\n \"name\": \"Gmail\",\n \"category\": \"Email Providers\"\n },\n {\n \"name\": \"Google Apps\",\n \"category\": \"Other\"\n },\n {\n \"name\": \"Google Dynamic Remarketing\",\n \"category\": \"Retargeting\"\n },\n {\n \"name\": \"Google Tag Manager\",\n \"category\": \"Tag Management\"\n },\n {\n \"name\": \"Hubspot\",\n \"category\": \"Marketing Automation\"\n },\n {\n \"name\": \"Mobile Friendly\",\n \"category\": \"Other\"\n },\n {\n \"name\": \"Outlook\",\n \"category\": \"Email Providers\"\n },\n {\n \"name\": \"Remote\",\n \"category\": \"Other\"\n },\n {\n \"name\": \"Reviews\",\n \"category\": \"Customer Reviews\"\n },\n {\n \"name\": \"Sendgrid\",\n \"category\": \"Email Delivery\"\n },\n {\n \"name\": \"Vimeo\",\n \"category\": \"Online Video Platforms\"\n },\n {\n \"name\": \"WordPress.org\",\n \"category\": \"CMS\"\n },\n {\n \"name\": \"reCAPTCHA\",\n \"category\": \"Captcha\"\n }\n ],\n \"industries\": [\n \"consumer services\"\n ],\n \"keywords\": [\n \"carpet cleaning\",\n \"water damage restoration\",\n \"hardwood floor cleaning\",\n \"tile and grout cleaning\",\n \"upholstery cleaning\",\n \"odor elimination\",\n \"mold mitigation\"\n ],\n \"hashtags\": [\n \"franchising\",\n \"franchiseopportunities\",\n \"franchisor\"\n ],\n \"languages\": [\n \"english\"\n ],\n \"sic\": [\n \"7349\"\n ],\n \"naics\": [\n \"561740\"\n ]\n },\n \"department\": {\n \"departments\": [\n \"operations\",\n \"business_development\"\n ],\n \"sub_departments\": [\n \"business_operations\",\n \"corporate_strategy\",\n \"new_ventures_and_corporate_innovation\"\n ],\n \"functions\": [\n \"business_operations\",\n \"corporate_strategy\"\n ],\n \"seniority\": \"founder\"\n },\n \"statistics\": {\n \"network\": {\n \"followers_count\": 5430,\n \"connections_count\": 1200\n }\n },\n \"last_updated\": \"2026-02-17\"\n}, ], \"pageable\": {\n \"pageNumber\": 0,\n \"pageSize\": 10,\n \"sort\": {\n \"empty\": false,\n \"sorted\": true,\n \"unsorted\": false\n },\n \"offset\": 0,\n \"paged\": true,\n \"unpaged\": false\n}, \"totalElements\": 4, \"totalPages\": 1, \"last\": true, \"size\": 10, \"number\": 0, \"sort\": {\n \"empty\": false,\n \"sorted\": true,\n \"unsorted\": false\n}, \"numberOfElements\": 4, \"trackId\": \"c0eb2caa-b482-4350-a42e-f32d047df1ef\", \"first\": true, \"empty\": false }"
}
}
}
},
"404": {
"description": "Data not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"format": "date-time",
"example": "2025-10-14T13:27:32.210+00:00"
},
"status": {
"type": "integer",
"example": 404
},
"error": {
"type": "string",
"example": "data not found"
},
"path": {
"type": "string",
"example": ""
}
}
},
"example": {
"timestamp": "2025-10-14T13:27:32.210+00:00",
"status": 404,
"error": "data not found",
"path": ""
}
}
}
},
"501": {
"description": "Returned when contact.socialMediaFollower targets an unsupported platform. Only linkedin is currently supported β facebook, twitter, and instagram are rejected.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "SOCIAL_MEDIA_FOLLOWER_PLATFORM_NOT_SUPPORTED"
}
}
},
"example": {
"message": "SOCIAL_MEDIA_FOLLOWER_PLATFORM_NOT_SUPPORTED"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"ListExcludeFilter": {
"type": "object",
"properties": {
"exclude": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "IDs of lists (created via POST /v1/lists) whose values should be excluded from the results."
}
}
},
"PeopleListsFilter": {
"type": "object",
"description": "Reference up to 10 lists per request (each list holds up to 10,000 items) to exclude the matching people from your results.",
"properties": {
"people_id": {
"allOf": [
{
"$ref": "#/components/schemas/ListExcludeFilter"
}
],
"description": "Exclude people whose id is in any of the referenced lists."
}
},
"additionalProperties": false,
"example": {
"people_id": {
"exclude": [
"294ce93e-8881-414c-8951-e91b5df7f560"
]
}
}
},
"AccountFilter": {
"type": "object",
"properties": {
"domain": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyDomain"
}
],
"example": {
"any": {
"include": [
"Apple.com"
],
"exclude": [
"www.Apple.net"
]
},
"all": {
"include": [
"Apple.com"
],
"exclude": [
"www.Apple.net"
]
}
},
"description": "The company's website domain, case-insensitive β the bare domain (`apple.com`) is recommended. For full URLs or LinkedIn company URLs, use `account.url` instead. Use `domain` to restrict a people search to specific employers, or in Company Search to resolve domains to AI Ark company `id`s. Max 300 values.\nExamples: `apple.com`; `raisin.com`."
},
"linkedin": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyLinkedin"
}
],
"example": {
"any": {
"include": [
"http://linkedin.com/company/microsoft"
],
"exclude": [
"http://linkedin.com/company/amazon"
]
},
"all": {
"include": [
"http://linkedin.com/company/apple"
],
"exclude": [
"http://linkedin.com/company/google"
]
}
},
"description": "The company's LinkedIn URL. Provide the **full URL** (e.g. `https://www.linkedin.com/company/apple`). The most reliable identifier next to `domain` for resolving companies to AI Ark IDs via Company Search.\n\nUse the FULL URL (e.g. `http://linkedin.com/company/apple`), not the slug."
},
"url": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyUrl"
}
],
"example": {
"any": {
"include": {
"mode": "SMART",
"content": [
"microsoft.com",
"www.microsoft.com",
"https://www.microsoft.com",
"http://linkedin.com/company/microsoft"
]
},
"exclude": {
"mode": "SMART",
"content": [
"amazon.com",
"http://linkedin.com/company/amazon"
]
}
},
"all": {
"include": {
"mode": "SMART",
"content": [
"apple.com",
"www.apple.com",
"https://www.apple.com",
"http://linkedin.com/company/apple"
]
},
"exclude": {
"mode": "SMART",
"content": [
"google.com",
"http://linkedin.com/company/google"
]
}
}
},
"description": "The company's URL β the most tolerant identifier filter, with match modes. Supports multiple formats: bare domain (`apple.com`), with www (`www.apple.com`), full URL (`https://www.apple.com`), and even the LinkedIn company URL (`http://linkedin.com/company/apple`)."
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyName"
}
],
"example": {
"any": {
"include": {
"mode": "SMART",
"content": [
"Apple"
]
},
"exclude": {
"mode": "SMART",
"content": [
"Amazon"
]
}
},
"all": {
"include": {
"mode": "SMART",
"content": [
"Apple"
]
},
"exclude": {
"mode": "SMART",
"content": [
"Amazon"
]
}
}
},
"description": "The company name, with match modes. Name matching can hit unrelated companies that share a name β when precision matters, resolve names to IDs via Company Search and use `contact.company` instead.\nExamples: `{ \"mode\": \"SMART\", \"content\": [\"Deutsche Bank\"] }`."
},
"socialMediaLink": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnySocialMediaLink"
}
],
"example": {
"any": {
"include": [
"https://www.facebook.com/apple"
],
"exclude": [
"https://www.facebook.com/google"
]
},
"all": {
"include": [
"https://www.facebook.com/apple"
],
"exclude": [
"http://linkedin.com/company/google"
]
}
},
"description": "A specific social profile URL of the company (full URL), with match modes.\n\nFormats: full profile URLs (Facebook, X/Twitter, Instagram, LinkedInβ¦). Plain value arrays."
},
"phoneNumber": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyPhoneNumber"
}
],
"example": {
"any": {
"include": [
"+14089961010"
],
"exclude": [
"+18885335659"
]
},
"all": {
"include": [
"+14089961010"
],
"exclude": [
"+18885335659"
]
}
},
"description": "The company's phone number in E.164 format, e.g. `+18885335659`.\n\nInternational format, e.g. `+14089961010`. Plain value arrays."
},
"industries": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyIndustries"
}
],
"description": "The company's industries, with match modes (SMART also matches adjacent industries). A company can have several industries (see the `industries` array in responses), and matches if any of them fits.\n919 allowed values β [download CSV](https://ai-ark.com/static/industries.csv?v=1). Examples: `software development`; `hospitals and health care`; `renewable energy semiconductor manufacturing`.",
"example": {
"any": {
"include": {
"mode": "WORD",
"content": [
"retail"
]
},
"exclude": {
"mode": "WORD",
"content": [
"construction"
]
}
},
"all": {
"include": {
"mode": "WORD",
"content": [
"software development"
]
},
"exclude": {
"mode": "WORD",
"content": [
"real estate"
]
}
}
}
},
"location": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyLocation"
}
],
"example": {
"any": {
"include": [
"United States"
],
"exclude": [
"Texas"
]
},
"all": {
"include": [
"United States"
],
"exclude": [
"Canada"
]
}
},
"description": "The company's office locations β matches **any office**, not only headquarters. Accepts countries, states, cities, and regions like `Europe`; same vocabulary as `contact.location`. City matching is forgiving β plain city names work (`munich`); metro-area values like `greater munich metropolitan area` are also supported for wider targeting.\nFor a distance-based search around a point, use `account.geoLocation` instead.\nExamples: `United States`; `Bavaria`; `paris`; `Europe`."
},
"productAndServices": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyProductAndServices"
}
],
"example": {
"any": {
"include": {
"mode": "SMART",
"content": [
"branding"
]
},
"exclude": {
"mode": "SMART",
"content": [
"project management"
]
}
},
"all": {
"include": {
"mode": "SMART",
"content": [
"marketing"
]
},
"exclude": {
"mode": "SMART",
"content": [
"digital marketing"
]
}
}
},
"description": "The products and services the company offers, with match modes. Sourced from the company's public positioning. Examples: `payroll software`; `solar installation`.\n\n---\n\nMatch modes apply β e.g. `e-commerce`, `cloud computing`."
},
"socialMedia": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnySocialMedia"
}
],
"example": {
"any": {
"include": [
"INSTAGRAM"
],
"exclude": [
"TWITTER"
]
},
"all": {
"include": [
"LINKEDIN"
],
"exclude": [
"FACEBOOK"
]
}
},
"description": "Filter for companies that have a profile link on a given network: `FACEBOOK`, `INSTAGRAM`, `TWITTER`, `LINKEDIN`.\n\nEnum values: `FACEBOOK`, `INSTAGRAM`, `TWITTER`, `LINKEDIN`. Plain value arrays."
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyCompanyType"
}
],
"example": {
"any": {
"include": [
"SELF_EMPLOYED"
],
"exclude": [
"PARTNERSHIP"
]
},
"all": {
"include": [
"PRIVATELY_HELD"
],
"exclude": [
"SELF_OWNED"
]
}
},
"description": "The company's legal/organizational type. 8 allowed values: `PRIVATELY_HELD`, `SELF_OWNED`, `SELF_EMPLOYED`, `PARTNERSHIP`, `PUBLIC_COMPANY`, `NON_PROFIT`, `EDUCATIONAL`, `GOVERNMENT_AGENCY`.\n\nEnum: `PRIVATELY_HELD`, `PUBLIC_COMPANY`, `SELF_OWNED`, `SELF_EMPLOYED`, `PARTNERSHIP`, `NON_PROFIT`, `EDUCATIONAL`, `GOVERNMENT_AGENCY`."
},
"foundedYear": {
"allOf": [
{
"$ref": "#/components/schemas/FoundedYearWithType"
}
],
"example": {
"type": "RANGE",
"range": {
"start": 2000,
"end": 2020
}
},
"description": "The year the company was founded. `type` values: `RANGE` (founded within a year range, e.g. 1980β1990), `ALL` (any company with a known founded year), `NONE` (companies where the founded year is missing).\n```json\n\"foundedYear\": { \"type\": \"RANGE\", \"range\": { \"start\": 2015, \"end\": 2022 } }\n```"
},
"employeeSize": {
"allOf": [
{
"$ref": "#/components/schemas/RangeWithTypeEmployeeSize"
}
],
"example": {
"type": "RANGE",
"range": [
{
"start": 1,
"end": 10
},
{
"start": 100,
"end": 500
}
]
},
"description": "Company headcount, as one or more ranges (`type: \"RANGE\"`). Add multiple ranges to expand results.\n```json\n\"employeeSize\": { \"type\": \"RANGE\", \"range\": [ { \"start\": 51, \"end\": 200 }, { \"start\": 201, \"end\": 500 } ] }\n```"
},
"retailSize": {
"allOf": [
{
"$ref": "#/components/schemas/RangeWithTypeRetailSize"
}
],
"description": "The company's number of physical locations worldwide, e.g. retail chains with 10β100 stores. `type` is always `RANGE`; `range` is an array of `{start, end}` bands (multiple bands are OR'd).\n```json\n\"retailSize\": { \"type\": \"RANGE\", \"range\": [ { \"start\": 10, \"end\": 100 } ] }\n```",
"example": {
"type": "RANGE",
"range": [
{
"start": 1,
"end": 10
}
]
}
},
"revenue": {
"allOf": [
{
"$ref": "#/components/schemas/RevenueWithTypeCompany"
}
],
"example": {
"type": "RANGE",
"range": [
{
"start": 0,
"end": 99999
}
]
},
"description": "The company's annual revenue in USD, no currency symbols or separators. `type` values:\n- `RANGE` β revenue within the given band(s). `range` is an **array**; multiple bands are OR'd: `\"range\": [ { \"start\": 1000000, \"end\": 10000000 } ]`.\n- `ALL` β every company **that has a revenue value**, whatever it is (everything that is not NONE).\n- `NONE` β only companies **with no revenue data**."
},
"language": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyAndRangeEnumForLanguageAccount"
}
],
"example": {
"any": {
"include": [
"french"
],
"exclude": [
"german"
]
},
"all": {
"include": [
"english"
],
"exclude": [
"spanish"
]
},
"range": {
"start": 1,
"end": 5
}
},
"description": "The languages the company operates in. `include`/`exclude` take plain value arrays (no match mode here, unlike `contact.language`), plus a `range` on the number of languages. Same 48 allowed values as `contact.language` (see above).\n\n48 valid values (e.g. `english`, `german`, `french`β¦); `range` filters HOW MANY languages."
},
"geoLocation": {
"type": "object",
"properties": {
"position": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"format": "float"
},
"lng": {
"type": "number",
"format": "float"
}
}
},
"radius": {
"type": "number",
"format": "float"
},
"unit": {
"type": "string",
"enum": [
"km",
"mi"
]
}
},
"example": {
"position": {
"lat": 37.7749,
"lng": -122.4194
},
"radius": 50,
"unit": "km"
},
"description": "Radius search around a coordinate β matches companies with **any office location** within the radius. Fields: `position.lat`, `position.lng`, `radius`, `unit` (`km` or `mi`).\n```json\n\"geoLocation\": { \"position\": { \"lat\": 53.5511, \"lng\": 9.9937 }, \"radius\": 50, \"unit\": \"km\" }\n```"
},
"keyword": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyCompanyKeywordsAccount"
}
],
"example": {
"any": {
"include": {
"sources": [
{
"mode": "SMART",
"source": "NAME"
},
{
"mode": "WORD",
"source": "KEYWORD"
}
],
"content": [
"software",
"development"
]
},
"exclude": {
"sources": [
{
"mode": "SMART",
"source": "NAME"
}
],
"content": [
"consulting"
]
}
},
"all": {
"include": {
"sources": [
{
"mode": "SMART",
"source": "NAME"
},
{
"mode": "WORD",
"source": "KEYWORD"
}
],
"content": [
"software",
"development"
]
},
"exclude": {
"sources": [
{
"mode": "SMART",
"source": "NAME"
}
],
"content": [
"consulting"
]
}
}
},
"description": "Free-text search across company fields. `content` holds the search terms; `sources` defines where to search, each with its own match `mode`. All 5 sources may be used at once (no source limit on company level).\nAllowed sources: `NAME`, `KEYWORD`, `SEO`, `DESCRIPTION`, `INDUSTRY`.\nExample β companies positioning themselves around \"carbon accounting\" in their description or SEO terms:\n```json\n\"keyword\": { \"any\": { \"include\": { \"sources\": [ { \"mode\": \"SMART\", \"source\": \"DESCRIPTION\" }, { \"mode\": \"SMART\", \"source\": \"SEO\" } ], \"content\": [\"carbon accounting\"] } } }\n```"
},
"funding": {
"type": "object",
"properties": {
"type": {
"type": "array",
"items": {
"type": "string",
"enum": [
"PRE_SEED",
"SEED",
"SERIES_A",
"SERIES_B",
"SERIES_C",
"SERIES_D",
"SERIES_E",
"SERIES_F",
"SERIES_G",
"SERIES_H",
"SERIES_I",
"SERIES_J",
"VENTURE_ROUND",
"ANGEL",
"PRIVATE_EQUITY",
"DEBT_FINANCING",
"CONVERTIBLE_NOTE",
"GRANT",
"CORPORATE_ROUND",
"EQUITY_CROWDFUNDING",
"PRODUCT_CROWDFUNDING",
"SECONDARY_MARKET",
"POST_IPO_EQUITY",
"POST_IPO_DEBT",
"POST_IPO_SECONDARY",
"NON_EQUITY_ASSISTANCE",
"INITIAL_COIN_OFFERING",
"UNDISCLOSED",
"SERIES_UNKNOWN",
"FUNDING_ROUND"
]
}
},
"totalAmount": {
"$ref": "#/components/schemas/SingleRangeFundingTotalAmount"
},
"lastAmount": {
"$ref": "#/components/schemas/SingleRangeFundingLastAmount"
},
"duration": {
"$ref": "#/components/schemas/SingleRangeTimeStamp"
}
},
"example": {
"type": [
"PRE_SEED",
"SEED"
],
"totalAmount": {
"start": 100000,
"end": 500000
},
"lastAmount": {
"start": 50000,
"end": 200000
},
"duration": {
"start": "1620847800000",
"end": "1747168200000"
}
},
"description": "Filter by the company's funding history:\n- **`type`** β funding round types the company has raised (any match). 30 allowed values: `PRE_SEED`, `SEED`, `SERIES_A` β¦ `SERIES_J`, `VENTURE_ROUND`, `ANGEL`, `PRIVATE_EQUITY`, `DEBT_FINANCING`, `CONVERTIBLE_NOTE`, `GRANT`, `CORPORATE_ROUND`, `EQUITY_CROWDFUNDING`, `PRODUCT_CROWDFUNDING`, `SECONDARY_MARKET`, `POST_IPO_EQUITY`, `POST_IPO_DEBT`, `POST_IPO_SECONDARY`, `NON_EQUITY_ASSISTANCE`, `INITIAL_COIN_OFFERING`, `UNDISCLOSED`, `SERIES_UNKNOWN`, `FUNDING_ROUND`.\n- **`totalAmount`** β total raised across all rounds, USD range.\n- **`lastAmount`** β size of the most recent round, USD range.\n- **`duration`** β the date of the most recent funding round (month/year range) β target companies that raised recently, when budgets are fresh.\n```json\n\"funding\": { \"type\": [\"SEED\", \"SERIES_A\"], \"totalAmount\": { \"start\": 1000000, \"end\": 20000000 } }\n```"
},
"metric": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyMetrics"
}
],
"example": {
"employee": [
{
"function": [
"program_and_project_management",
"education"
],
"start": 10,
"end": 100
}
],
"growth": [
{
"function": [
"program_and_project_management",
"education"
],
"start": 10,
"end": 100,
"timeFrame": "SIX"
}
]
},
"description": "Two department-level metrics; `function` takes one of 27 department values (`sales`, `marketing`, `engineering`, `finance`, `human_resources`, `information_technology`, `operations`, `business_development`, `customer_success_and_support`, `product_management`, `accounting`, `legal`, `consulting`, `education`, `research`, `purchasing`, `real_estate`, `media_and_communication`, `quality_assurance`, `arts_and_design`, `healthcare_services`, `entrepreneurship`, `community_and_social_services`, `administrative`, `military_and_protective_services`, `program_and_project_management`, `support`).\n- **`employee`** β the current absolute number of employees in the given department(s), within `start`β`end`. E.g. companies with 10β50 people in `engineering`:\n```json\n\"metric\": { \"employee\": [ { \"function\": [\"engineering\"], \"start\": 10, \"end\": 50 } ] }\n```\n- **`growth`** β the percentage headcount change of the department(s) over a look-back window. Here `timeFrame` applies, in months: `ONE`, `THREE`, `SIX`, `TWELVE`, `TWENTY_FOUR`. E.g. `marketing` grew 10β15% in the last 6 months:\n```json\n\"metric\": { \"growth\": [ { \"function\": [\"marketing\"], \"start\": 10, \"end\": 15, \"timeFrame\": \"SIX\" } ] }\n```\nDepartment growth is one of the strongest intent signals available β a growing sales team buys sales tooling."
},
"technology": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyTechnology"
}
],
"example": {
"any": {
"include": [
"Python",
"JavaScript"
],
"exclude": [
"PHP",
"Ruby"
]
},
"all": {
"include": [
"React",
"Node.js"
],
"exclude": [
"Angular",
"Vue.js"
]
}
},
"description": "The original technology filter, kept for backward compatibility with existing integrations. It takes plain string values and does **not** support match modes. **For new integrations, use `account.technologies` instead** β same data, plus SMART/WORD/STRICT matching."
},
"technologies": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyTechnologies"
}
],
"description": "The technologies the company uses (detected from multiple sources, updated regularly). **Supports match modes** (`SMART`, `WORD`, `STRICT`) β SMART also finds related technologies.\n16,000+ known values sorted by how many companies use them β [download CSV](https://ai-ark.com/static/technologies.csv?v=1). Examples: `salesforce`; `hubspot`; `google analytics`; `shopify`.\n```json\n\"technologies\": { \"any\": { \"include\": { \"mode\": \"WORD\", \"content\": [\"hubspot\", \"salesforce\"] } } }\n```",
"example": {
"any": {
"include": {
"mode": "WORD",
"content": [
"java"
]
},
"exclude": {
"mode": "WORD",
"content": [
"Python"
]
}
},
"all": {
"include": {
"mode": "WORD",
"content": [
"React"
]
},
"exclude": {
"mode": "WORD",
"content": [
"JavaScript"
]
}
}
}
},
"naics": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyNaics"
}
],
"example": {
"any": {
"include": [
"621320"
],
"exclude": [
"621330"
]
},
"all": {
"include": [
"111120"
],
"exclude": [
"111160"
]
}
},
"description": "The company's NAICS industry classification codes. Example: `449210`. (SIC codes appear in company responses but are not yet filterable.)\n\nPlain value arrays, e.g. `454110`. (SIC filtering not yet available; SIC appears in responses.)"
}
},
"description": "**Match modes & combination logic**\nEvery text filter accepts a `mode` that controls how your search terms are matched:\n\n- **`SMART` (default)** β Uses AI to find related concepts, not just the words you typed. Searching for `creative director` will also find people with titles like `art director` or `head of creative`. Use SMART to expand your reach when the exact wording varies.\n- **`WORD`** β Finds the exact phrase but allows extra words around it. `creative director` will match `associate creative director` or `group creative director`, but not `art director`. Use WORD when the phrase must appear literally.\n- **`STRICT`** β The most restrictive mode: only the exact characters you typed. `creative director` returns only `creative director` β no variations, prefixes, or suffixes. Use STRICT for precise, deduplicated targeting.\n\n### `any` vs `all`\n- **`any`** = OR logic β a record matches if it matches **at least one** of the values. Adding more values **expands** your results.\n- **`all`** = AND logic β a record matches only if it matches **every** value. Adding more values **narrows** your results.\n\nBoth accept `include` and `exclude`. A search cannot consist of `exclude` filters only.\n\n**Value limits**\n- Maximum **300 values** per `include`/`exclude` array.\n- Maximum **10,000 results** per search (100 per page). To retrieve more than 10,000 β e.g. a search matching 38,000 people β use the Lists pagination pattern: pull the first 10,000, add their `id`s to a list via `POST /v1/lists` (free), re-run the same search with `\"lists\": { \"people_id\": { \"exclude\": [\"\"] } }` β now only 28,000 remain β pull the next 10,000, append to the list, and repeat until you have all 38,000.\n\n---"
},
"ContactFilter": {
"type": "object",
"properties": {
"fullName": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyFullName"
}
],
"example": {
"any": {
"include": {
"mode": "SMART",
"content": [
"David Bowie"
]
},
"exclude": {
"mode": "SMART",
"content": [
"Roger Waters"
]
}
},
"all": {
"include": {
"mode": "SMART",
"content": [
"David Bowie"
]
},
"exclude": {
"mode": "SMART",
"content": [
"Roger Waters"
]
}
}
},
"description": "The person's full name, with match modes. Useful for finding a specific person when you don't have their LinkedIn URL β combine with `contact.company` or `account.domain` to disambiguate common names.\nExample: `{ \"mode\": \"STRICT\", \"content\": [\"Jane Smith\"] }` + `account.domain: acme.com`."
},
"socialMediaLink": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyContactSocialMediaLink"
}
],
"example": {
"any": {
"include": [
"https://www.facebook.com/joneslisap"
],
"exclude": [
"https://www.facebook.com/garry.martin.503"
]
},
"all": {
"include": [
"https://www.facebook.com/roni.berger.7"
],
"exclude": [
"https://www.facebook.com/saurave"
]
}
},
"description": "A specific social profile URL of the person (full URL), with match modes."
},
"company": {
"type": "object",
"description": "Filter people by their employer, using **AI Ark company IDs (UUID)** β the most precise way to target a fixed set of accounts (name matching can hit unrelated companies that share a name).\n**Where to get IDs:** call the Company Search endpoint (`POST /v1/companies`) and filter by the company's `domain` or LinkedIn URL; each result contains the company `id`. Company IDs also appear in every People Search / Preview result under `company.id`.\nScopes work like `contact.experience`: **`latest`** = the company of the person's primary active role; **`current`** = any of their active roles' companies; **`previous`** = past employers.\nMax 300 IDs per array. For larger sets, split across searches or narrow with other filters.\n```json\n\"company\": { \"latest\": { \"any\": { \"include\": [\"abce3ed0-6732-bc57-6732-e1801358b811\"] } } }\n```",
"properties": {
"latest": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyCompanyIds"
},
{
"type": "object",
"example": {
"any": {
"include": [
"931fc1a0-1ed5-baf8-0dd2-a068a0fd0430"
],
"exclude": [
"a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
]
},
"all": {
"include": [
"931fc1a0-1ed5-baf8-0dd2-a068a0fd0430"
],
"exclude": [
"b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e"
]
}
}
}
]
},
"current": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyCompanyIds"
},
{
"type": "object",
"example": {
"any": {
"include": [
"6f52adbf-72fa-6e51-c05c-33424441f4b7"
],
"exclude": [
"0d089797-f0c6-2838-20e9-f7bbb97ad6a2"
]
},
"all": {
"include": [
"b4e53e29-32e5-7d82-642b-8e054bec6b67"
],
"exclude": [
"48b25b16-7bae-abfe-5343-42f6896702bd"
]
}
}
}
]
},
"previous": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyCompanyIds"
},
{
"type": "object",
"example": {
"any": {
"include": [
"389c456c-207a-d1a0-b588-fef62077dc76"
],
"exclude": [
"65a8e052-d862-5fb9-104b-1326a3ea7788"
]
},
"all": {
"include": [
"8b1c2fa5-3ceb-437e-5ef5-495bc6d34ace"
],
"exclude": [
"2248d3b5-8185-7708-5851-5fceb5686878"
]
}
}
}
]
}
}
},
"experience": {
"type": "object",
"properties": {
"latest": {
"type": "object",
"properties": {
"title": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyJobTitle"
},
{
"type": "object",
"example": {
"all": {
"include": {
"mode": "SMART",
"content": [
"founder"
]
},
"exclude": {
"mode": "SMART",
"content": [
"senior"
]
}
},
"any": {
"include": {
"mode": "SMART",
"content": [
"intern"
]
},
"exclude": {
"mode": "SMART",
"content": [
"head"
]
}
}
}
}
]
}
},
"description": "Filter by the latest active position only. This corresponds to the \"Latest Active Position Only\" toggle in the application UI."
},
"current": {
"type": "object",
"properties": {
"title": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyJobTitle"
},
{
"type": "object",
"example": {
"all": {
"include": {
"mode": "SMART",
"content": [
"founder"
]
},
"exclude": {
"mode": "SMART",
"content": [
"senior"
]
}
},
"any": {
"include": {
"mode": "SMART",
"content": [
"intern"
]
},
"exclude": {
"mode": "SMART",
"content": [
"head"
]
}
}
}
}
]
},
"duration": {
"type": "object",
"properties": {
"currentCompany": {
"$ref": "#/components/schemas/YearAndMonthDuration"
},
"currentJob": {
"$ref": "#/components/schemas/YearAndMonthDuration"
},
"total": {
"$ref": "#/components/schemas/YearAndMonthDuration"
}
}
}
}
},
"previous": {
"type": "object",
"properties": {
"title": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyJobTitle"
},
{
"type": "object",
"example": {
"any": {
"include": {
"mode": "SMART",
"content": [
"founder"
]
},
"exclude": {
"mode": "SMART",
"content": [
"head"
]
}
},
"all": {
"include": {
"mode": "SMART",
"content": [
"intern"
]
},
"exclude": {
"mode": "SMART",
"content": [
"senior"
]
}
}
}
}
]
}
}
}
},
"example": {
"latest": {
"title": {
"any": {
"include": {
"mode": "SMART",
"content": [
"founder"
]
}
}
}
},
"current": {
"duration": {
"currentCompany": {
"min": {
"year": 2,
"month": 6
},
"max": {
"year": 5,
"month": 0
}
},
"currentJob": {
"min": {
"year": 1,
"month": 0
},
"max": {
"year": 3,
"month": 6
}
},
"total": {
"min": {
"year": 5,
"month": 0
},
"max": {
"year": 10,
"month": 0
}
}
}
},
"previous": {
"title": {
"any": {
"include": {
"mode": "SMART",
"content": [
"founder"
]
},
"exclude": {
"mode": "SMART",
"content": [
"head"
]
}
},
"all": {
"include": {
"mode": "SMART",
"content": [
"intern"
]
},
"exclude": {
"mode": "SMART",
"content": [
"senior"
]
}
}
}
}
},
"description": "Filter people by job title, with three scopes:\n- **`latest`** β the person's **primary active role** only. If someone holds 3 positions at once, only the one they marked as their primary/latest role is matched. Use this for the classic \"current job title\" search.\n- **`current`** β **all active roles**. A person holding 3 simultaneous positions matches if **any** of them fits. Use this to catch advisors, board members, and multi-role founders.\n- **`previous`** β past roles only. Someone who *was* a Director but is now a VP matches `previous: director`, not `latest`.\n\nEach scope takes `any`/`all` with `include`/`exclude`, and text values wrapped in a match mode (`SMART`, `WORD`, `STRICT`). With SMART, `marketing manager` also finds related titles like `growth marketing lead`.\nCombine with `contact.seniority` to pin the reporting level, and `contact.departmentAndFunction` to pin the function.\nExamples: `sales development representative`; `marketing manager`; `research analyst`. Max 300 values.\n```json\n\"experience\": { \"latest\": { \"title\": { \"any\": { \"include\": { \"mode\": \"SMART\", \"content\": [\"creative director\"] } } } } }\n```\n\n**Tenure filters (`duration`):**\nAvailable on the `current` scope only (not on `latest` or `previous`). Each key is a `{ \"min\": { \"year\", \"month\" }, \"max\": { \"year\", \"month\" } }` range:\n- **`currentCompany`** β how long at the current employer.\n- **`currentJob`** β how long in the current role.\n- **`total`** β the person's total career experience.\nUse them to find people new in role (a strong outreach trigger β e.g. `currentJob.max: { year: 0, month: 6 }`) or long-tenured decision makers.\n```json\n\"current\": { \"duration\": { \"currentJob\": { \"min\": { \"year\": 0, \"month\": 0 }, \"max\": { \"year\": 0, \"month\": 6 } } } }\n```"
},
"seniority": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyContactSeniority"
}
],
"example": {
"any": {
"include": [
"founder"
],
"exclude": [
"head"
]
},
"all": {
"include": [
"founder"
],
"exclude": [
"senior"
]
}
},
"description": "The seniority level of the person's current position. A person matches if they hold **at least one** of the levels you add (within `any`). Searches are based on the current role: a former Director who is now a VP matches `vp`, not `director`.\nCombine with `contact.experience` (titles) and `contact.departmentAndFunction` for function + level targeting (e.g. `manager` + `marketing`).\nAllowed values (12): `founder`, `owner`, `partner`, `c_suite`, `vp`, `director`, `head`, `manager`, `senior`, `mid-level`, `entry`, `intern`.\n```json\n\"seniority\": { \"any\": { \"include\": [\"director\", \"vp\"] } }\n```"
},
"location": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyContactLocation"
}
],
"example": {
"any": {
"include": [
"United States"
],
"exclude": [
"Canada"
]
},
"all": {
"include": [
"United States"
],
"exclude": [
"Texas"
]
}
},
"description": "Where the person lives. Accepts countries (`Germany`), states (`California`), cities (`london`), and even regions (`Europe`). Same vocabulary as `account.location`, so the same values work for both.\nCity matching is forgiving β plain city names work (`seattle`, `hamburg`, `london`); exact values are not required. Metro-area values like `greater seattle area` or `new york city metropolitan area` are also supported for wider targeting.\nTo search by the employer's location instead, use `account.location` (any office) or `account.geoLocation` (radius).\nExamples: `Germany`; `California`; `london`; `Europe`."
},
"linkedin": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyContactLinkedin"
}
],
"example": {
"any": {
"include": [
"https://www.linkedin.com/in/jane-smith-87654321"
],
"exclude": [
"https://www.linkedin.com/in/john-doe-12345678"
]
},
"all": {
"include": [
"https://www.linkedin.com/in/mikel-lejarza-13615428"
],
"exclude": [
"https://www.linkedin.com/in/john-doe-12345678"
]
}
},
"description": "The person's LinkedIn profile URL. Provide the **full URL** (e.g. `https://www.linkedin.com/in/john-doe`). Use it to check whether specific profiles exist in AI Ark, or to exclude known profiles. Max 300 values."
},
"departmentAndFunction": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyContactDepartmentAndFunction"
}
],
"example": {
"any": {
"include": [
"accounting"
],
"exclude": [
"payroll_accounting"
]
},
"all": {
"include": [
"product_management"
],
"exclude": [
"design"
]
}
},
"description": "The department, sub-department, or function of the person's role β this one filter matches across all three levels you see in responses (`departments`, `sub_departments`, `functions`). E.g. `engineering_technical` (department) and `data_science` (sub-department) are both valid values.\nThe taxonomy has **37 parent departments**, each expanding into its detailed job functions β most of them including an `other_` catch-all (e.g. `other_accounting`) β plus the standalone value `unknown` for profiles that could not be classified. Passing a parent department matches everyone in it; pass a function to narrow to that specific role.\nCombine with `contact.seniority` to build searches like \"AI/ML + director-level\".\n617 allowed values β [download CSV](https://ai-ark.com/static/departments-and-functions.csv?v=4). Examples: `software_development`, `demand_generation`, `recruiting_talent_acquisition`, `financial_planning_analysis`.\n```json\n\"departmentAndFunction\": { \"any\": { \"include\": [\"artificial_intelligence_machine_learning\", \"data_science\"] } }\n```"
},
"skill": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnySkill"
}
],
"example": {
"any": {
"include": {
"mode": "SMART",
"content": [
"teamwork"
]
},
"exclude": {
"mode": "SMART",
"content": [
"public speaking"
]
}
},
"all": {
"include": {
"mode": "SMART",
"content": [
"leadership"
]
},
"exclude": {
"mode": "SMART",
"content": [
"sales"
]
}
}
},
"description": "Skills listed on the person's profile, with match modes. With `all`, require several skills at once (e.g. `python` AND `machine learning`). Skills are also searchable via `contact.keyword` with source `SKILL`.\nExamples: `salesforce`; `cold calling`; `kubernetes`."
},
"certification": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyCertification"
}
],
"example": {
"any": {
"include": {
"mode": "SMART",
"content": [
"AWS Certified Solutions Architect β Associate"
]
},
"exclude": {
"mode": "SMART",
"content": [
"Google Data Analytics Professional Certificate"
]
}
},
"all": {
"include": {
"mode": "SMART",
"content": [
"Scrum Master Certification (CSM)"
]
},
"exclude": {
"mode": "SMART",
"content": [
"Meta Front-End Developer Certificate"
]
}
}
},
"description": "Professional certifications on the person's profile, with match modes. Examples: `pmp`; `aws certified solutions architect`; `cpa`."
},
"keyword": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyPeopleKeywordsContact"
}
],
"example": {
"any": {
"include": {
"sources": [
{
"mode": "SMART",
"source": "ORGANIZATION"
},
{
"mode": "WORD",
"source": "SUMMARY"
}
],
"content": [
"software",
"development"
]
},
"exclude": {
"sources": [
{
"mode": "SMART",
"source": "HEADLINE"
}
],
"content": [
"consulting"
]
}
},
"all": {
"include": {
"sources": [
{
"mode": "SMART",
"source": "ORGANIZATION"
},
{
"mode": "WORD",
"source": "SUMMARY"
}
],
"content": [
"software",
"development"
]
},
"exclude": {
"sources": [
{
"mode": "SMART",
"source": "HEADLINE"
}
],
"content": [
"consulting"
]
}
}
},
"description": "Free-text search across specific sections of the person's profile. `content` holds the search terms; `sources` defines **which profile sections to search in**, each with its own match `mode`. **Maximum 5 sources per request.**\nAllowed sources (15): `HEADLINE`, `SUMMARY`, `SKILL`, `CERTIFICATION`, `COURSE`, `PROJECTS`, `PUBLICATION`, `PATENT`, `AWARD`, `ORGANIZATION`, `VOLUNTEERING`, `TEST_SCORE`, `WORK_HISTORY_DESCRIPTION`, `EDUCATION_DESCRIPTION`, `LANGUAGE_SKILL`.\nExample β people who mention \"machine learning\" in their headline or summary:\n```json\n\"keyword\": { \"any\": { \"include\": { \"sources\": [ { \"mode\": \"SMART\", \"source\": \"HEADLINE\" }, { \"mode\": \"SMART\", \"source\": \"SUMMARY\" } ], \"content\": [\"machine learning\"] } } }\n```"
},
"socialMedia": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyContactSocialMedia"
}
],
"example": {
"any": {
"include": [
"INSTAGRAM"
],
"exclude": [
"TWITTER"
]
},
"all": {
"include": [
"LINKEDIN"
],
"exclude": [
"FACEBOOK"
]
}
},
"description": "Filter for people who have a profile link on a given network. Allowed values: `FACEBOOK`, `INSTAGRAM`, `TWITTER`, `LINKEDIN`."
},
"language": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyAndRangePlusSearchMatchWithLanguageEnumsContact"
}
],
"example": {
"any": {
"include": {
"mode": "SMART",
"content": [
"english"
]
},
"exclude": {
"mode": "SMART",
"content": [
"german"
]
}
},
"all": {
"include": {
"mode": "SMART",
"content": [
"english"
]
},
"exclude": {
"mode": "SMART",
"content": [
"spanish"
]
}
},
"range": {
"start": 1,
"end": 5
}
},
"description": "Languages the person speaks. `include`/`exclude` wrap the values with a match `mode`: `{ \"mode\": \"SMART\", \"content\": [\"english\"] }`. Additionally, **`range` filters by the number of languages spoken** β e.g. `range: { \"start\": 3 }` finds polyglots who speak 3+ languages (a strong signal for international sales roles).\n48 allowed values: `english`, `spanish`, `french`, `portuguese`, `german`, `dutch`, `italian`, `chinese`, `turkish`, `polish`, `russian`, `swedish`, `arabic`, `indonesian`, `danish`, `czech`, `norwegian`, `japanese`, `korean`, `romanian`, `ukrainian`, `thai`, `hindi`, `malay`, `tagalog`, `vietnamese`, `finnish`, `persian`, `greek`, `hungarian`, `bengali`, `marathi`, `telugu`, `panjabi`, `serbian`, `slovak`, `croatian`, `lithuanian`, `latvian`, `albanian`, `icelandic`, `armenian`, `bosnian`, `tamil`, `javanese`, `malayalam`, `kannada`, `burmese`."
},
"education": {
"type": "object",
"properties": {
"school": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyEducationSchool"
},
{
"type": "object",
"example": {
"any": {
"include": [
"49c9a269-b00e-28ac-eeb6-f74d3fd32a00"
]
},
"all": {
"include": [
"49c9a269-b00e-28ac-eeb6-f74d3fd32a00"
]
}
}
}
]
},
"degree": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyEducationDegree"
},
{
"type": "object",
"example": {
"any": {
"include": {
"mode": "SMART",
"content": [
"Marketing digital"
]
}
},
"all": {
"include": {
"mode": "SMART",
"content": [
"Marketing digital"
]
}
}
}
}
]
},
"fieldOfStudy": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyEducationFieldOfStudy"
},
{
"type": "object",
"example": {
"any": {
"include": {
"mode": "SMART",
"content": [
"digital communication"
]
}
},
"all": {
"include": {
"mode": "SMART",
"content": [
"digital communication"
]
}
}
}
}
]
},
"date": {
"$ref": "#/components/schemas/EducationDateRange"
}
},
"example": {
"date": {
"start": 2015,
"end": 2025,
"present": false
}
},
"description": "Filter by education history:\n- **`school`** β takes **AI Ark company IDs** of the institution. Universities are companies in AI Ark: get the ID by calling Company Search with the university's domain (e.g. `harvard.edu`) or LinkedIn URL, exactly like any other company.\n- **`degree`** β text with match modes, e.g. `mba`, `bachelor of science`.\n- **`fieldOfStudy`** β text with match modes, e.g. `computer science`, `economics`.\n- **`date`** β the **study period** as stated on the person's public profile: `start` = year they began studying, `end` = year they finished or left, `present` (boolean) = still studying now. \"Studied at Harvard from 2011 to 2015\" β `{ \"start\": 2011, \"end\": 2015, \"present\": false }`. Use it for alumni-cohort targeting, or `present: true` for current students."
},
"profileBadge": {
"allOf": [
{
"$ref": "#/components/schemas/FilterWithAllAnyContactProfileBadge"
}
],
"example": {
"any": {
"include": [
"CREATOR",
"HIRING",
"INFLUENCER",
"VERIFIED"
],
"exclude": [
"OPEN_TO_WORK"
]
},
"all": {
"include": [
"CREATOR",
"HIRING",
"VERIFIED"
],
"exclude": [
"OPEN_TO_WORK"
]
}
},
"description": "Badges shown on the person's public profile. Allowed values (6): `VERIFIED`, `PREMIUM`, `OPEN_TO_WORK`, `INFLUENCER`, `CREATOR`, `HIRING`.\n`HIRING` is a strong buying signal for recruiting-adjacent products; `OPEN_TO_WORK` is essential for talent sourcing."
},
"socialMediaFollower": {
"allOf": [
{
"$ref": "#/components/schemas/SocialMediaFollowerFilter"
}
],
"description": "Filter by the person's follower and connection counts. Only the `linkedin` platform is supported β targeting `facebook`, `twitter`, or `instagram` is rejected with **HTTP 501** (`SOCIAL_MEDIA_FOLLOWER_PLATFORM_NOT_SUPPORTED`).\n`followers` and `connections` are independently optional; each takes `type: \"RANGE\"` with a `range` **array** β multiple bands are OR'd together, and the whole filter ANDs with the rest of the search. Omit `end` for an open-ended band (`{ \"start\": 30000 }` = 30K+); omit `start` for \"less than\". An empty object is a no-op.\nIn responses, the counts appear under `statistics.network.followers_count` and `.connections_count` (either may be absent when unknown β absence β zero).\n```json\n\"socialMediaFollower\": { \"linkedin\": { \"followers\": { \"type\": \"RANGE\", \"range\": [ { \"start\": 5000, \"end\": 10000 }, { \"start\": 30000 } ] } } }\n```\n\n---",
"example": {
"linkedin": {
"followers": {
"type": "RANGE",
"range": [
{
"start": 1,
"end": 500
},
{
"start": 1000,
"end": 2000
},
{
"start": 30000
}
]
},
"connections": {
"type": "RANGE",
"range": [
{
"start": 1500,
"end": 4200
}
]
}
}
}
}
},
"description": "**Match modes & combination logic**\nEvery text filter accepts a `mode` that controls how your search terms are matched:\n\n- **`SMART` (default)** β Uses AI to find related concepts, not just the words you typed. Searching for `creative director` will also find people with titles like `art director` or `head of creative`. Use SMART to expand your reach when the exact wording varies.\n- **`WORD`** β Finds the exact phrase but allows extra words around it. `creative director` will match `associate creative director` or `group creative director`, but not `art director`. Use WORD when the phrase must appear literally.\n- **`STRICT`** β The most restrictive mode: only the exact characters you typed. `creative director` returns only `creative director` β no variations, prefixes, or suffixes. Use STRICT for precise, deduplicated targeting.\n\n### `any` vs `all`\n- **`any`** = OR logic β a record matches if it matches **at least one** of the values. Adding more values **expands** your results.\n- **`all`** = AND logic β a record matches only if it matches **every** value. Adding more values **narrows** your results.\n\nBoth accept `include` and `exclude`. A search cannot consist of `exclude` filters only.\n\n**Value limits**\n- Maximum **300 values** per `include`/`exclude` array.\n- Maximum **10,000 results** per search (100 per page). To retrieve more than 10,000 β e.g. a search matching 38,000 people β use the Lists pagination pattern: pull the first 10,000, add their `id`s to a list via `POST /v1/lists` (free), re-run the same search with `\"lists\": { \"people_id\": { \"exclude\": [\"\"] } }` β now only 28,000 remain β pull the next 10,000, append to the list, and repeat until you have all 38,000.\n\n---"
},
"FilterWithAllAnyDomain": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeDomainStrings",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeDomainStrings",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyLinkedin": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeLinkedinStrings",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeLinkedinStrings",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnySocialMediaLink": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeSocialMediaLinkStrings",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeSocialMediaLinkStrings",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyPhoneNumber": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludePhoneNumberStrings",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludePhoneNumberStrings",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyUrl": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeUrlStringsPlusSearchMatch",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeUrlStringsPlusSearchMatch",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyName": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeNameStringsPlusSearchMatch",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeNameStringsPlusSearchMatch",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyIndustries": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeIndustriesPlusSearchMatch",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeIndustriesPlusSearchMatch",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyLocation": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeLocationStrings",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeLocationStrings",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyProductAndServices": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeProductAndServicesPlusSearchMatch",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeProductAndServicesPlusSearchMatch",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnySocialMedia": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeSocialMediaEnums",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeSocialMediaEnums",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyCompanyType": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeCompanyTypeEnums",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeCompanyTypeEnums",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyAndRangeEnumForLanguageAccount": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeLanguageEnums",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeLanguageEnums",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
},
"range": {
"$ref": "#/components/schemas/SingleRangeLanguage",
"description": "Numeric range(s): `{start, end}`. Omit `start` or `end` for open-ended bounds."
}
}
},
"FilterWithAllAnyCompanyKeywordsAccount": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeCompanyKeywordsAccount",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeCompanyKeywordsAccount",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyTechnology": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeTechnologyStrings",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeTechnologyStrings",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyTechnologies": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeTechnologiesPlusSearchMatch",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeTechnologiesPlusSearchMatch",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyNaics": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeNaicsStrings",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeNaicsStrings",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyFullName": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeFullNameStringsPlusSearchMatch",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeFullNameStringsPlusSearchMatch",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyContactSocialMediaLink": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeContactSocialMediaLinkStrings",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeContactSocialMediaLinkStrings",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"SocialMediaFollowerFilter": {
"type": "object",
"description": "Container for per-platform follower/connection range filters. Only the linkedin property is currently supported.",
"properties": {
"linkedin": {
"$ref": "#/components/schemas/SocialMediaFollowerLinkedinFilter",
"description": "LinkedIn audience filters: `followers` and `connections`, each as OR'd `{start, end}` range arrays (open-ended bands supported). LinkedIn only β other networks return an error."
}
}
},
"SocialMediaFollowerLinkedinFilter": {
"type": "object",
"description": "LinkedIn follower- and connection-count ranges. followers and connections are independently optional. Sending the object empty ({}) is a no-op and applies no constraint.",
"properties": {
"followers": {
"$ref": "#/components/schemas/RangeWithTypeFollowerCount",
"description": "LinkedIn follower-count ranges (OR'd; open-ended bands supported)."
},
"connections": {
"$ref": "#/components/schemas/RangeWithTypeFollowerCount",
"description": "LinkedIn connection-count ranges (OR'd; open-ended bands supported)."
}
}
},
"RangeWithTypeFollowerCount": {
"type": "object",
"description": "Range filter for follower/connection counts. Multiple entries in range are OR'd together. Omit end for an open-ended X+ band (e.g. 30K+); omit start for a less-than-X band.",
"properties": {
"type": {
"type": "string",
"enum": [
"RANGE"
],
"description": "The type of range filter."
},
"range": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SingleRangeFollowerCount"
},
"description": "Array of follower/connection count ranges (OR'd)."
}
},
"example": {
"type": "RANGE",
"range": [
{
"start": 501,
"end": 1000
},
{
"start": 5000,
"end": 10000
}
]
}
},
"SingleRangeFollowerCount": {
"type": "object",
"description": "A single follower/connection count band. Counts are absolute integers (1K = 1000, 1.5K = 1500, 7.5K = 7500). Omit end for an open-ended start+ range; omit start for a less than end range.",
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"description": "Lower bound, inclusive. Omit for \"less than end\" semantics.",
"example": 501
},
"end": {
"type": "integer",
"minimum": 0,
"description": "Upper bound, inclusive. Omit for open-ended \"start+\" semantics.",
"example": 1000
}
}
},
"FilterWithAllAnyCompanyIds": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeCompanyIdStrings",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeCompanyIdStrings",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyJobTitle": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeJobTitleStringsPlusSearchMatch",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeJobTitleStringsPlusSearchMatch",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyContactLocation": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeContactLocationStrings",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeContactLocationStrings",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyContactLinkedin": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeContactLinkedinStrings",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeContactLinkedinStrings",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyContactSeniority": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeContactSeniorityLevelEnums",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeContactSeniorityLevelEnums",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyContactDepartmentAndFunction": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeContactDepartmentAndFunctionEnums",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeContactDepartmentAndFunctionEnums",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnySkill": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeSkillStringsPlusSearchMatch",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeSkillStringsPlusSearchMatch",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyCertification": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeCertificationStringsPlusSearchMatch",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeCertificationStringsPlusSearchMatch",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyPeopleKeywordsContact": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludePeopleKeywordsContact",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludePeopleKeywordsContact",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyContactSocialMedia": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeContactSocialMediaEnums",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeContactSocialMediaEnums",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyAndRangePlusSearchMatchWithLanguageEnumsContact": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeContactLanguageEnumsPlusSearchMatch",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeContactLanguageEnumsPlusSearchMatch",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
},
"range": {
"$ref": "#/components/schemas/SingleRangeContactLanguage",
"description": "Numeric range(s): `{start, end}`. Omit `start` or `end` for open-ended bounds."
}
}
},
"FilterWithAllAnyEducationSchool": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeEducationSchoolIdStrings",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeEducationSchoolIdStrings",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyEducationDegree": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeEducationDegreeStringsPlusSearchMatch",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeEducationDegreeStringsPlusSearchMatch",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyEducationFieldOfStudy": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeEducationFieldOfStudyStringsPlusSearchMatch",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeEducationFieldOfStudyStringsPlusSearchMatch",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"FilterWithAllAnyContactProfileBadge": {
"type": "object",
"properties": {
"any": {
"$ref": "#/components/schemas/IncludeExcludeContactProfileBadgeEnums",
"description": "OR logic β matches if at least ONE value matches. More values = broader results."
},
"all": {
"$ref": "#/components/schemas/IncludeExcludeContactProfileBadgeEnums",
"description": "AND logic β matches only if EVERY value matches. More values = narrower results."
}
}
},
"IncludeExcludeDomainStrings": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"type": "string",
"example": "apple.com"
},
"example": [
"apple.com",
"microsoft.com"
],
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "array",
"items": {
"type": "string",
"example": "amazon.com"
},
"example": [
"amazon.com"
],
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeLinkedinStrings": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"type": "string",
"example": "http://linkedin.com/company/apple"
},
"example": [
"http://linkedin.com/company/apple"
],
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "array",
"items": {
"type": "string",
"example": "http://linkedin.com/company/amazon"
},
"example": [
"http://linkedin.com/company/amazon"
],
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeSocialMediaLinkStrings": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"type": "string",
"example": "https://www.facebook.com/apple"
},
"example": [
"https://www.facebook.com/apple"
],
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "array",
"items": {
"type": "string",
"example": "https://www.facebook.com/google"
},
"example": [
"https://www.facebook.com/google"
],
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludePhoneNumberStrings": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"type": "string",
"example": "+14089961010"
},
"example": [
"+14089961010"
],
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "array",
"items": {
"type": "string",
"example": "+18885335659"
},
"example": [
"+18885335659"
],
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeLocationStrings": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"type": "string",
"example": "United States"
},
"example": [
"United States"
],
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "array",
"items": {
"type": "string",
"example": "Texas"
},
"example": [
"Canada"
],
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeTechnologyStrings": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"type": "string",
"example": "AWS"
},
"example": [
"AWS",
"Python"
],
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "array",
"items": {
"type": "string",
"example": "PHP"
},
"example": [
"PHP",
"Ruby"
],
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeNaicsStrings": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"type": "string",
"example": "621320"
},
"example": [
"621320"
],
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "array",
"items": {
"type": "string",
"example": "621330"
},
"example": [
"621330"
],
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeUrlStringsPlusSearchMatch": {
"type": "object",
"properties": {
"include": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"type": "string",
"example": "apple.com"
}
}
},
"example": {
"mode": "SMART",
"content": [
"apple.com",
"www.apple.com",
"https://www.apple.com"
]
},
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"type": "string",
"example": "amazon.com"
}
}
},
"example": {
"mode": "SMART",
"content": [
"amazon.com",
"http://linkedin.com/company/amazon"
]
},
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeNameStringsPlusSearchMatch": {
"type": "object",
"properties": {
"include": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"type": "string",
"example": "Apple"
}
}
},
"example": {
"mode": "SMART",
"content": [
"Apple"
]
},
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"type": "string",
"example": "Amazon"
}
}
},
"example": {
"mode": "SMART",
"content": [
"Amazon"
]
},
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeIndustriesPlusSearchMatch": {
"type": "object",
"properties": {
"include": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndustryEnum"
}
}
},
"example": {
"mode": "WORD",
"content": [
"retail"
]
},
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IndustryEnum"
}
}
},
"example": {
"mode": "WORD",
"content": [
"construction"
]
},
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeProductAndServicesPlusSearchMatch": {
"type": "object",
"properties": {
"include": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"type": "string",
"example": "e-commerce"
}
}
},
"example": {
"mode": "SMART",
"content": [
"e-commerce"
]
},
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"type": "string",
"example": "construction"
}
}
},
"example": {
"mode": "SMART",
"content": [
"construction"
]
},
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeTechnologiesPlusSearchMatch": {
"type": "object",
"properties": {
"include": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"type": "string",
"example": "java"
}
}
},
"example": {
"mode": "WORD",
"content": [
"java"
]
},
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"type": "string",
"example": "Python"
}
}
},
"example": {
"mode": "WORD",
"content": [
"Python"
]
},
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeSocialMediaEnums": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocialMediaEnum"
},
"example": [
"LINKEDIN"
],
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocialMediaEnum"
},
"example": [
"FACEBOOK"
],
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeCompanyTypeEnums": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompanyTypeEnum"
},
"example": [
"PRIVATELY_HELD"
],
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompanyTypeEnum"
},
"example": [
"SELF_OWNED"
],
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeLanguageEnums": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LanguageEnum"
},
"example": [
"english"
],
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LanguageEnum"
},
"example": [
"spanish"
],
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeFullNameStringsPlusSearchMatch": {
"type": "object",
"properties": {
"include": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"type": "string",
"example": "David Bowie"
}
}
},
"example": {
"mode": "SMART",
"content": [
"David Bowie"
]
},
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"type": "string",
"example": "Roger Waters"
}
}
},
"example": {
"mode": "SMART",
"content": [
"Roger Waters"
]
},
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeContactSocialMediaLinkStrings": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"type": "string",
"example": "https://www.facebook.com/joneslisap"
},
"example": [
"https://www.facebook.com/joneslisap"
],
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "array",
"items": {
"type": "string",
"example": "https://www.facebook.com/garry.martin.503"
},
"example": [
"https://www.facebook.com/garry.martin.503"
],
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeCompanyIdStrings": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"type": "string",
"example": "931fc1a0-1ed5-baf8-0dd2-a068a0fd0430"
},
"example": [
"931fc1a0-1ed5-baf8-0dd2-a068a0fd0430"
],
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "array",
"items": {
"type": "string",
"example": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
},
"example": [
"a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
],
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeJobTitleStringsPlusSearchMatch": {
"type": "object",
"properties": {
"include": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"type": "string",
"example": "founder"
}
}
},
"example": {
"mode": "SMART",
"content": [
"founder"
]
},
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"type": "string",
"example": "senior"
}
}
},
"example": {
"mode": "SMART",
"content": [
"senior"
]
},
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeContactLocationStrings": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"type": "string",
"example": "United States"
},
"example": [
"United States"
],
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "array",
"items": {
"type": "string",
"example": "Canada"
},
"example": [
"Canada"
],
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeContactLinkedinStrings": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"type": "string",
"example": "https://www.linkedin.com/in/jane-smith-87654321"
},
"example": [
"https://www.linkedin.com/in/jane-smith-87654321"
],
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "array",
"items": {
"type": "string",
"example": "https://www.linkedin.com/in/john-doe-12345678"
},
"example": [
"https://www.linkedin.com/in/john-doe-12345678"
],
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeContactSeniorityLevelEnums": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeniorityLevelEnum"
},
"example": [
"founder"
],
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeniorityLevelEnum"
},
"example": [
"head"
],
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeContactDepartmentAndFunctionEnums": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DepartmentAndFunctionEnum"
},
"example": [
"product_management"
],
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DepartmentAndFunctionEnum"
},
"example": [
"product_operations"
],
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeSkillStringsPlusSearchMatch": {
"type": "object",
"properties": {
"include": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"type": "string",
"example": "teamwork"
}
}
},
"example": {
"mode": "SMART",
"content": [
"teamwork"
]
},
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"type": "string",
"example": "public speaking"
}
}
},
"example": {
"mode": "SMART",
"content": [
"public speaking"
]
},
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeCertificationStringsPlusSearchMatch": {
"type": "object",
"properties": {
"include": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"type": "string",
"example": "Scrum Master Certification (CSM)"
}
}
},
"example": {
"mode": "SMART",
"content": [
"Scrum Master Certification (CSM)"
]
},
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"type": "string",
"example": "Meta Front-End Developer Certificate"
}
}
},
"example": {
"mode": "SMART",
"content": [
"Meta Front-End Developer Certificate"
]
},
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludePeopleKeywordsContact": {
"type": "object",
"properties": {
"include": {
"$ref": "#/components/schemas/PeopleKeywordDataContact",
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"$ref": "#/components/schemas/PeopleKeywordDataContact",
"description": "Values a record must NOT match."
}
}
},
"PeopleKeywordDataContact": {
"type": "object",
"properties": {
"sources": {
"type": "array",
"description": "A maximum of 5 sources is allowed.",
"maxItems": 5,
"items": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"source": {
"type": "string",
"enum": [
"ORGANIZATION",
"TEST_SCORE",
"AWARD",
"WORK_HISTORY_DESCRIPTION",
"PUBLICATION",
"SUMMARY",
"PATENT",
"VOLUNTEERING",
"HEADLINE",
"EDUCATION_DESCRIPTION",
"COURSE",
"PROJECTS",
"SKILL",
"LANGUAGE_SKILL",
"CERTIFICATION"
]
}
},
"example": {
"mode": "SMART",
"source": "ORGANIZATION"
}
}
},
"content": {
"type": "array",
"items": {
"type": "string",
"example": "software"
},
"example": [
"software",
"development"
],
"description": "The search values (max 300 per array)."
}
}
},
"IncludeExcludeContactSocialMediaEnums": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocialMediaEnum"
},
"example": [
"LINKEDIN"
],
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SocialMediaEnum"
},
"example": [
"FACEBOOK"
],
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeContactLanguageEnumsPlusSearchMatch": {
"type": "object",
"properties": {
"include": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactLanguageEnum"
}
}
},
"example": {
"mode": "SMART",
"content": [
"english"
]
},
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactLanguageEnum"
}
}
},
"example": {
"mode": "SMART",
"content": [
"spanish"
]
},
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeEducationSchoolIdStrings": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"type": "string",
"example": "49c9a269-b00e-28ac-eeb6-f74d3fd32a00"
},
"example": [
"49c9a269-b00e-28ac-eeb6-f74d3fd32a00"
],
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "array",
"items": {
"type": "string",
"example": "3f8a1e57-2c9b-4d6a-b1e0-8c4f2a9d7e33"
},
"example": [
"3f8a1e57-2c9b-4d6a-b1e0-8c4f2a9d7e33"
],
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeEducationDegreeStringsPlusSearchMatch": {
"type": "object",
"properties": {
"include": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"type": "string",
"example": "Marketing digital"
}
}
},
"example": {
"mode": "SMART",
"content": [
"Marketing digital"
]
},
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"type": "string",
"example": "Biology"
}
}
},
"example": {
"mode": "SMART",
"content": [
"Biology"
]
},
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeEducationFieldOfStudyStringsPlusSearchMatch": {
"type": "object",
"properties": {
"include": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"type": "string",
"example": "digital communication"
}
}
},
"example": {
"mode": "SMART",
"content": [
"digital communication"
]
},
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"content": {
"type": "array",
"items": {
"type": "string",
"example": "chemistry"
}
}
},
"example": {
"mode": "SMART",
"content": [
"chemistry"
]
},
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeContactProfileBadgeEnums": {
"type": "object",
"properties": {
"include": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfileBadgeEnum"
},
"example": [
"CREATOR",
"HIRING"
],
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfileBadgeEnum"
},
"example": [
"OPEN_TO_WORK"
],
"description": "Values a record must NOT match."
}
}
},
"IncludeExcludeCompanyKeywordsAccount": {
"type": "object",
"properties": {
"include": {
"$ref": "#/components/schemas/CompanyKeywordDataAccount",
"description": "Values a record MUST match (subject to any/all logic)."
},
"exclude": {
"$ref": "#/components/schemas/CompanyKeywordDataAccount",
"description": "Values a record must NOT match."
}
}
},
"CompanyKeywordDataAccount": {
"type": "object",
"properties": {
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/components/schemas/SearchMatchModeEnum"
},
"source": {
"type": "string",
"enum": [
"NAME",
"KEYWORD",
"SEO",
"DESCRIPTION",
"INDUSTRY"
]
}
},
"example": {
"mode": "SMART",
"source": "NAME"
}
},
"description": "Which sources to search, each with its own include/exclude term sets."
},
"content": {
"type": "array",
"items": {
"type": "string",
"example": "retail"
},
"example": [
"retail"
],
"description": "The search values (max 300 per array)."
}
}
},
"SingleRange": {
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "Lower bound (inclusive). Omit for open start."
},
"end": {
"type": "number",
"description": "Upper bound (inclusive). Omit for open end."
}
}
},
"SingleRangeEmployeeSize": {
"type": "object",
"properties": {
"start": {
"type": "number",
"example": 1,
"description": "Lower bound (inclusive). Omit for open start."
},
"end": {
"type": "number",
"example": 10,
"description": "Upper bound (inclusive). Omit for open end."
}
}
},
"SingleRangeRetailSize": {
"type": "object",
"properties": {
"start": {
"type": "number",
"example": 1,
"description": "Lower bound (inclusive). Omit for open start."
},
"end": {
"type": "number",
"example": 10,
"description": "Upper bound (inclusive). Omit for open end."
}
}
},
"SingleRangeRevenue": {
"type": "object",
"properties": {
"start": {
"type": "number",
"example": 0,
"description": "Lower bound (inclusive). Omit for open start."
},
"end": {
"type": "number",
"example": 99999,
"description": "Upper bound (inclusive). Omit for open end."
}
}
},
"SingleRangeLanguage": {
"type": "object",
"properties": {
"start": {
"type": "number",
"example": 1,
"description": "Lower bound (inclusive). Omit for open start."
},
"end": {
"type": "number",
"example": 5,
"description": "Upper bound (inclusive). Omit for open end."
}
}
},
"SingleRangeContactLanguage": {
"type": "object",
"properties": {
"start": {
"type": "number",
"example": 1,
"description": "Lower bound (inclusive). Omit for open start."
},
"end": {
"type": "number",
"example": 5,
"description": "Upper bound (inclusive). Omit for open end."
}
}
},
"SingleRangeFundingTotalAmount": {
"type": "object",
"properties": {
"start": {
"type": "number",
"example": 100000,
"description": "Lower bound (inclusive). Omit for open start."
},
"end": {
"type": "number",
"example": 500000,
"description": "Upper bound (inclusive). Omit for open end."
}
}
},
"SingleRangeFundingLastAmount": {
"type": "object",
"properties": {
"start": {
"type": "number",
"example": 50000,
"description": "Lower bound (inclusive). Omit for open start."
},
"end": {
"type": "number",
"example": 200000,
"description": "Upper bound (inclusive). Omit for open end."
}
}
},
"SingleRangeTimeStamp": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "Lower bound (inclusive). Omit for open start."
},
"end": {
"type": "string",
"description": "Upper bound (inclusive). Omit for open end."
}
},
"description": "The start and end dates in Timestamp format (in milliseconds)"
},
"RevenueWithTypeCompany": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"ALL",
"NONE",
"RANGE"
],
"description": "The type of revenue filter."
},
"range": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SingleRangeRevenue"
},
"description": "Array of range objects with start and end values."
}
},
"example": {
"type": "RANGE",
"range": [
{
"start": 0,
"end": 99999
}
]
}
},
"FoundedYearWithType": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"ALL",
"NONE",
"RANGE"
],
"description": "The type of founded year filter."
},
"range": {
"$ref": "#/components/schemas/SingleRange",
"description": "Range object with start and end values. Required when type is RANGE."
}
},
"example": {
"type": "RANGE",
"range": {
"start": 2000,
"end": 2020
}
}
},
"EducationDateRange": {
"type": "object",
"properties": {
"start": {
"type": "number",
"description": "Lower bound (inclusive). Omit for open start."
},
"end": {
"type": "number",
"description": "Upper bound (inclusive). Omit for open end."
},
"present": {
"type": "boolean",
"description": "`true` = currently studying (no end date)."
}
}
},
"SocialMediaEnum": {
"type": "string",
"enum": [
"FACEBOOK",
"INSTAGRAM",
"TWITTER",
"LINKEDIN"
]
},
"SearchMatchModeEnum": {
"type": "string",
"enum": [
"SMART",
"WORD",
"STRICT"
]
},
"CompanyTypeEnum": {
"type": "string",
"enum": [
"PRIVATELY_HELD",
"SELF_OWNED",
"SELF_EMPLOYED",
"PARTNERSHIP",
"PUBLIC_COMPANY",
"NON_PROFIT",
"EDUCATIONAL",
"GOVERNMENT_AGENCY"
]
},
"IndustryEnum": {
"type": "string",
"enum": [
"alternative medicine",
"animation and post-production",
"artists and writers",
"aviation and aerospace component manufacturing",
"biotechnology research",
"capital markets",
"chemical manufacturing",
"education administration programs",
"entertainment providers",
"environmental services",
"events services",
"fundraising",
"hospitality",
"information services",
"international affairs",
"investment banking",
"it services and it consulting",
"law enforcement",
"law practice",
"legislative offices",
"movies, videos, and sound",
"oil and gas",
"online audio and video media",
"packaging and containers manufacturing",
"performing arts",
"pharmaceutical manufacturing",
"printing services",
"professional training and coaching",
"real estate",
"research services",
"software development",
"strategic management services",
"truck transportation",
"wellness and fitness services",
"wholesale",
"wireless services",
"mining",
"photography",
"accounting",
"airlines and aviation",
"armed forces",
"automation machinery manufacturing",
"banking",
"broadcast media production and distribution",
"business consulting and services",
"civic and social organizations",
"civil engineering",
"computer games",
"computer hardware manufacturing",
"computers and electronics manufacturing",
"construction",
"consumer services",
"design services",
"e-learning providers",
"facilities services",
"financial services",
"fisheries",
"food and beverage manufacturing",
"gambling facilities and casinos",
"glass, ceramics and concrete manufacturing",
"government relations services",
"higher education",
"investment management",
"libraries",
"machinery manufacturing",
"media production",
"medical equipment manufacturing",
"mobile gaming apps",
"nanotechnology research",
"non-profit organizations",
"outsourcing and offshoring consulting",
"philanthropic fundraising services",
"political organizations",
"public relations and communications services",
"recreational facilities",
"religious institutions",
"restaurants",
"retail",
"retail apparel and fashion",
"retail art supplies",
"semiconductor manufacturing",
"staffing and recruiting",
"technology, information and internet",
"think tanks",
"translation and localization",
"travel arrangements",
"venture capital and private equity principals",
"veterinary services",
"warehousing and storage",
"wholesale building materials",
"wholesale import and export",
"writing and editing",
"legal services",
"manufacturing",
"musicians",
"market research",
"administration of justice",
"advertising services",
"alternative dispute resolution",
"appliances, electrical, and electronics manufacturing",
"architecture and planning",
"beverage manufacturing",
"book and periodical publishing",
"computer and network security",
"computer networking products",
"dairy product manufacturing",
"defense and space manufacturing",
"executive offices",
"farming",
"food and beverage services",
"freight and package transportation",
"furniture and home furnishings manufacturing",
"government administration",
"graphic design",
"hospitals and health care",
"human resources services",
"individual and family services",
"industrial machinery manufacturing",
"insurance",
"international trade and development",
"leasing non-residential real estate",
"maritime transportation",
"medical practices",
"mental health care",
"motor vehicle manufacturing",
"museums, historical sites, and zoos",
"newspaper publishing",
"paper and forest product manufacturing",
"personal care product manufacturing",
"plastics manufacturing",
"primary and secondary education",
"public policy offices",
"public safety",
"railroad equipment manufacturing",
"ranching",
"renewable energy semiconductor manufacturing",
"retail groceries",
"retail luxury goods and jewelry",
"retail office equipment",
"security and investigations",
"shipbuilding",
"spectator sports",
"sporting goods manufacturing",
"telecommunications",
"textile manufacturing",
"tobacco manufacturing",
"transportation, logistics, supply chain and storage",
"utilities"
]
},
"SeniorityLevelEnum": {
"type": "string",
"enum": [
"founder",
"owner",
"partner",
"c_suite",
"vp",
"director",
"head",
"manager",
"senior",
"mid-level",
"entry",
"intern"
]
},
"LanguageEnum": {
"type": "string",
"enum": [
"english",
"spanish",
"french",
"portuguese",
"german",
"dutch",
"italian",
"chinese",
"turkish",
"polish",
"russian",
"swedish",
"arabic",
"indonesian",
"danish",
"czech",
"norwegian",
"japanese",
"korean",
"romanian",
"ukrainian",
"thai",
"hindi",
"malay",
"tagalog",
"vietnamese",
"finnish",
"persian",
"greek",
"hungarian",
"bengali",
"marathi",
"telugu",
"panjabi",
"serbian",
"slovak",
"croatian",
"lithuanian",
"latvian",
"albanian",
"icelandic",
"armenian",
"bosnian",
"tamil",
"javanese",
"malayalam",
"kannada",
"burmese"
]
},
"ContactLanguageEnum": {
"type": "string",
"enum": [
"english",
"spanish",
"french",
"portuguese",
"german",
"dutch",
"italian",
"chinese",
"turkish",
"polish",
"russian",
"swedish",
"arabic",
"indonesian",
"danish",
"czech",
"norwegian",
"japanese",
"korean",
"romanian",
"ukrainian",
"thai",
"hindi",
"malay",
"tagalog",
"vietnamese",
"finnish",
"persian",
"greek",
"hungarian",
"bengali",
"marathi",
"telugu",
"panjabi",
"serbian",
"slovak",
"croatian",
"lithuanian",
"latvian",
"albanian",
"icelandic",
"armenian",
"bosnian",
"tamil",
"javanese",
"malayalam",
"kannada",
"burmese"
]
},
"DepartmentAndFunctionEnum": {
"type": "string",
"enum": [
"accounting",
"accounting_management",
"accounts_payable",
"accounts_receivable",
"bookkeeping",
"consolidation_accounting",
"cost_accounting",
"external_audit_and_assurance",
"financial_reporting",
"fixed_asset_accounting",
"general_ledger_and_close",
"other_accounting",
"payroll_accounting",
"revenue_accounting",
"tax_accounting",
"administrative",
"administrative_assistant",
"calendar_travel_coordination",
"data_entry_and_clerical",
"document_and_mail_services",
"executive_assistant",
"facility_administration",
"front_desk_reception",
"meeting_and_event_coordination",
"office_management",
"other_administrative",
"personal_assistance",
"records_management",
"virtual_assistant_remote_admin",
"agriculture_forestry_and_animal_care",
"agricultural_operations",
"crop_production",
"environmental_and_natural_resource_management",
"farming_and_ranching",
"fisheries_and_aquaculture",
"forestry_and_conservation",
"livestock_and_animal_care",
"other_agriculture_forestry_and_animal_care",
"arts_entertainment_and_performance",
"acting_and_performance",
"cultural_and_museum_programming",
"dance_and_choreography",
"directing_and_producing",
"film_and_screen_production",
"live_entertainment_production",
"music_and_singing",
"other_arts_entertainment_and_performance",
"talent_and_casting",
"theatre_and_stage_production",
"beauty_and_personal_care",
"barbering",
"cosmetology_general",
"esthetics_and_skin_care",
"hair_styling",
"makeup_artistry",
"massage_and_bodywork",
"nail_care",
"other_beauty_and_personal_care",
"salon_and_spa_management",
"business_development",
"bids_proposals_and_capture_management",
"channel_development",
"corporate_development",
"corporate_strategy",
"country_management",
"franchise_development",
"international_expansion",
"market_development",
"new_ventures_and_corporate_innovation",
"other_business_development",
"partnerships_and_alliances",
"strategic_business_development",
"community_and_social_services",
"advocacy_public_policy",
"case_management",
"child_family_services",
"community_health_services",
"community_outreach",
"counseling",
"crisis_intervention",
"family_caregiving",
"fundraising_development",
"grants_management",
"nonprofit_program_management",
"other_community_and_social_services",
"philanthropy_and_foundation_relations",
"rehabilitation_services",
"religious_spiritual_services",
"social_work",
"volunteer_coordination",
"consulting",
"financial_consulting",
"human_capital_consulting",
"implementation_consulting",
"it_consulting",
"management_consulting",
"marketing_and_sales_consulting",
"operations_consulting",
"other_consulting",
"risk_consulting",
"solutions_consulting",
"strategy_consulting",
"supply_chain_consulting",
"sustainability_esg_consulting",
"transformation_consulting",
"customer_success_and_support",
"call_center",
"customer_community_management",
"customer_education",
"customer_experience",
"customer_onboarding",
"customer_retention",
"customer_success",
"customer_success_operations",
"customer_support",
"customer_support_operations",
"implementation_services",
"other_customer_success_and_support",
"professional_services_and_customer_delivery",
"renewals_management",
"technical_support",
"design",
"brand_design",
"design_management",
"design_operations",
"fashion_and_apparel_design",
"fine_arts_illustration",
"floristry",
"graphic_design",
"industrial_design",
"interaction_design",
"interior_and_environmental_design",
"lighting_design",
"motion_design",
"other_design",
"photography_visual_storytelling",
"product_design",
"service_design",
"ui_ux",
"web_design",
"education",
"academic_affairs",
"admissions_enrollment",
"adult_and_continuing_education",
"alumni_development",
"assessment_and_accreditation",
"career_services",
"corporate_training_enablement",
"curriculum_development",
"early_childhood_education",
"education_policy",
"education_technology",
"higher_education_faculty",
"instructional_design",
"k12_instruction",
"library_services",
"online_learning_and_elearning",
"other_education",
"school_leadership_and_administration",
"special_education",
"student_affairs",
"tutoring_and_test_preparation",
"vocational_and_technical_education",
"energy_mining_and_utilities",
"energy_and_utilities_operations",
"grid_transmission_and_distribution_operations",
"mining_and_extractive_operations",
"oil_and_gas_operations",
"other_energy_mining_and_utilities",
"power_generation_operations",
"water_and_waste_operations",
"engineering_technical",
"aerospace_engineering",
"artificial_intelligence_machine_learning",
"bioengineering",
"business_intelligence",
"cad_and_drafting",
"chemical_engineering",
"civil_and_structural_engineering",
"data_engineering",
"data_science",
"devops",
"electrical_engineering",
"embedded_and_firmware_engineering",
"engineering_management",
"engineering_ops_sre",
"engineering_technician",
"environmental_engineering",
"geospatial_and_gis",
"hardware_engineering_electronics",
"industrial_engineering",
"manufacturing_and_process_engineering",
"marine_and_naval_engineering",
"materials_engineering",
"mechanical_engineering",
"mobile_development",
"other_engineering_technical",
"platform_engineering",
"robotics_and_automation",
"software_development",
"surveying_and_geomatics",
"systems_engineering",
"finance",
"asset_and_wealth_management",
"commercial_banking",
"corporate_finance",
"credit_and_lending",
"financial_planning_analysis",
"financial_risk_management",
"financial_strategy",
"financial_systems",
"fraud_and_financial_crime",
"insurance_actuarial_and_underwriting",
"internal_audit_control",
"investment_banking_and_capital_markets",
"investor_relations",
"mergers_acquisitions",
"other_finance",
"pricing_and_revenue_management",
"project_finance",
"real_estate_finance",
"securities_and_commodities_trading",
"tax_strategy_and_planning",
"treasury",
"general_management",
"executive_leadership_and_general_management",
"hospitality_food_and_guest_services",
"casino_and_gaming_operations",
"culinary_and_kitchen_operations",
"event_hospitality_and_catering",
"food_and_beverage_service",
"guest_services_and_concierge",
"hospitality_management",
"hospitality_revenue_management",
"hotel_and_lodging_operations",
"housekeeping_and_accommodation_services",
"other_hospitality_food_and_guest_services",
"restaurant_operations",
"travel_and_tourism_services",
"human_resources",
"compensation_benefits",
"diversity_equity_inclusion",
"employee_experience",
"employee_labor_relations",
"employee_wellbeing",
"employer_branding",
"global_mobility",
"hr_business_partner",
"hr_compliance",
"hr_generalist_and_administration",
"human_resource_information_system",
"leadership_development",
"learning_development",
"organizational_development",
"other_human_resources",
"people_analytics",
"people_operations",
"recruiting_talent_acquisition",
"succession_planning",
"talent_management",
"workforce_management",
"workforce_planning",
"information_technology",
"business_continuity_disaster_recovery",
"business_service_management_itsm",
"cloud_engineering",
"cybersecurity",
"cybersecurity_operations",
"data_center",
"data_governance",
"data_warehouse",
"database_administration",
"digital_transformation",
"emerging_technology_innovation",
"end_user_support",
"enterprise_applications_erp_crm",
"enterprise_architecture",
"identity_and_access_management",
"infrastructure",
"integration_and_middleware",
"it_asset_management",
"it_governance_risk_and_compliance",
"it_strategy",
"it_training",
"it_vendor_management",
"network_operations_center",
"networking",
"observability_and_monitoring",
"other_information_technology",
"retail_store_systems",
"solution_architecture",
"technology_operations",
"telecommunications",
"virtualization",
"legal",
"antitrust_and_competition",
"claims_and_disputes",
"commercial_transactions",
"compliance",
"contracts",
"corporate_and_securities_law",
"corporate_secretary",
"ediscovery",
"ethics_and_investigations",
"governance",
"immigration_law",
"intellectual_property_patent",
"judiciary_and_courts",
"labor_and_employment_law",
"legal_counsel",
"legal_operations",
"legal_support_and_paralegal",
"litigation",
"other_legal",
"privacy",
"regulatory_affairs",
"regulatory_law",
"manufacturing_and_production",
"food_and_beverage_production",
"industrial_production_management",
"manufacturing_and_plant_operations",
"materials_and_fabrication",
"other_manufacturing_and_production",
"process_and_machine_operations",
"production_and_assembly",
"marketing",
"account_based_marketing",
"advertising",
"affiliate_marketing",
"brand_management",
"community_marketing",
"content_marketing",
"conversion_rate_optimization",
"customer_marketing",
"demand_generation",
"digital_marketing",
"ecommerce_marketing",
"event_marketing",
"field_marketing",
"growth_marketing",
"influencer_creator_marketing",
"lead_generation",
"lifecycle_and_crm_marketing",
"marketing_analytics_insights",
"marketing_automation",
"marketing_communications",
"marketing_management",
"marketing_operations",
"other_marketing",
"paid_search_and_performance_marketing",
"partner_and_channel_marketing",
"product_marketing",
"search_engine_optimization",
"social_media_marketing",
"technical_marketing",
"media_and_communication",
"broadcast_production",
"content_strategy",
"copywriting",
"corporate_communications",
"creative_writing_authoring",
"crisis_communications",
"digital_content_production",
"editorial",
"foreign_affairs",
"government_affairs",
"internal_communications",
"journalism_reporting",
"media_relations",
"multimedia_audiovisual",
"other_media_and_communication",
"podcast_and_audio_production",
"public_affairs",
"public_relations",
"publishing",
"speechwriting",
"technical_writing",
"translation_localization",
"medical_health",
"anesthesiology",
"athletic_training",
"audiology",
"behavioral_and_mental_health",
"cardiology",
"chiropractics",
"clinical_systems",
"complementary_and_alternative_medicine",
"dentistry",
"dermatology",
"emergency_medicine",
"epidemiology",
"exercise_physiology",
"gastroenterology",
"health_information_management_and_medical_coding",
"health_promotion_and_clinical_wellness",
"healthcare_operations",
"home_health_and_long_term_care",
"infectious_disease",
"laboratory_and_diagnostics",
"medical_administration",
"medical_education_training",
"neurology",
"nursing",
"nutrition_dietetics",
"obstetrics_gynecology",
"occupational_health",
"occupational_therapy",
"oncology",
"ophthalmology",
"optometry",
"orthopedics",
"other_medical_health",
"pathology",
"patient_care_support",
"pediatrics",
"pharmacy",
"physical_therapy",
"physicians_and_general_medicine",
"primary_care_family_and_internal_medicine",
"psychiatry",
"psychology",
"public_health",
"radiology",
"respiratory_therapy",
"speech_language_pathology",
"sports_medicine",
"surgery",
"urology",
"veterinary_medicine",
"military_and_protective_services",
"corrections",
"customs_and_border_security",
"emergency_management",
"emergency_response",
"enlisted_operations",
"fire_and_rescue",
"intelligence_security",
"investigations",
"law_enforcement",
"loss_prevention",
"officer_command",
"other_military_and_protective_services",
"private_security",
"protective_intelligence",
"security_operations",
"operations",
"business_operations",
"event_management_production",
"field_operations",
"health_safety_and_environment",
"inventory_and_materials_management",
"operational_excellence_and_process_improvement",
"other_operations",
"service_delivery",
"shared_services",
"store_operations",
"supply_chain",
"product_management",
"general_product_management",
"growth_product_management",
"other_product_management",
"platform_product_management",
"product_analytics",
"product_development",
"product_discovery",
"product_operations",
"product_owner",
"product_portfolio_management",
"product_strategy",
"technical_product_management",
"program_and_project_management",
"change_management",
"construction_project_management",
"delivery_management",
"implementation_project_management",
"monitoring_evaluation_and_learning",
"other_program_and_project_management",
"pmo",
"portfolio_management",
"program_management",
"project_controls_and_planning",
"project_management",
"scrum_master_agile_coach",
"technical_program_management",
"transformation_program_management",
"public_administration_and_government",
"defense_policy",
"diplomacy_and_foreign_service",
"elected_office_and_legislative_affairs",
"government_program_administration",
"other_public_administration_and_government",
"public_administration_and_civil_service",
"public_finance_and_tax_administration",
"public_policy_and_policy_analysis",
"regulatory_and_inspection_services",
"urban_and_regional_planning",
"purchasing",
"category_management",
"contract_management",
"direct_materials_procurement",
"indirect_procurement",
"other_purchasing",
"procurement",
"procurement_analytics",
"purchasing_operations",
"spend_analysis",
"strategic_sourcing",
"supplier_relationship_management",
"vendor_management",
"quality_assurance",
"manufacturing_quality",
"other_quality_assurance",
"quality_audit",
"quality_control",
"quality_management",
"regulatory_quality",
"software_testing",
"supplier_quality",
"test_automation",
"test_engineering",
"validation",
"real_estate",
"acquisitions_and_dispositions",
"brokerage_and_real_estate_sales",
"commercial_real_estate",
"leasing",
"other_real_estate",
"property_management",
"real_estate_asset_management",
"real_estate_development",
"real_estate_investment",
"real_estate_operations",
"residential_real_estate",
"tenant_relations",
"valuation_and_appraisal",
"workplace_real_estate",
"research",
"academic_research",
"clinical_research",
"clinical_trials",
"competitive_intelligence",
"consumer_insights",
"economic_affairs",
"laboratory_research",
"market_research",
"medical_research",
"operations_research",
"other_research",
"policy_research",
"qualitative_research",
"quantitative_research",
"research_development",
"research_operations",
"scientific_research",
"social_and_behavioral_research",
"user_research",
"sales",
"account_executive_and_new_business_sales",
"account_management",
"channel_sales",
"commercial_operations",
"enterprise_sales",
"field_outside_sales",
"inside_sales",
"insurance_sales_and_brokerage",
"other_sales",
"partner_sales",
"retail_merchandising",
"retail_sales",
"revenue_operations",
"sales_compensation_and_planning",
"sales_development",
"sales_enablement",
"sales_engineering",
"sales_management",
"sales_operations",
"sales_training",
"strategic_and_key_accounts",
"territory_sales",
"skilled_trades_construction_and_maintenance",
"automotive_service_and_repair",
"building_and_grounds_services",
"construction_estimating",
"construction_operations",
"construction_trades",
"electrical_trades",
"facilities_management",
"field_service_technical",
"heavy_equipment_operation",
"installation_and_repair",
"maintenance_reliability_and_mro",
"mechanical_and_hvac_trades",
"other_skilled_trades_construction_and_maintenance",
"plumbing_and_pipefitting",
"sports_and_recreation",
"fitness_and_personal_training",
"other_sports_and_recreation",
"professional_athletes",
"recreation_and_leisure_services",
"sports_coaching",
"sports_management_and_operations",
"sports_officiating",
"sports_science_and_performance_coaching",
"transportation_and_logistics",
"cabin_crew_and_inflight_services",
"dispatch_and_transport_coordination",
"fleet_management",
"flight_operations_and_pilots",
"import_export_and_customs",
"logistics",
"maritime_and_deck_operations",
"order_management_and_fulfillment",
"other_transportation_and_logistics",
"road_and_rail_transport",
"transportation_operations",
"warehouse_operations",
"unknown"
]
},
"ProfileBadgeEnum": {
"type": "string",
"enum": [
"VERIFIED",
"PREMIUM",
"OPEN_TO_WORK",
"INFLUENCER",
"CREATOR",
"HIRING"
]
},
"TimeFrameEnum": {
"type": "string",
"enum": [
"ONE",
"SIX",
"THREE",
"TWELVE",
"TWENTY_FOUR"
]
},
"CompanyDepartmentEnum": {
"type": "string",
"enum": [
"program_and_project_management",
"education",
"purchasing",
"accounting",
"sales",
"research",
"operations",
"customer_success_and_support",
"legal",
"product_management",
"media_and_communication",
"real_estate",
"quality_assurance",
"consulting",
"arts_and_design",
"healthcare_services",
"entrepreneurship",
"engineering",
"community_and_social_services",
"marketing",
"information_technology",
"business_development",
"administrative",
"military_and_protective_services",
"finance",
"human_resources",
"support"
]
},
"YearAndMonthDuration": {
"type": "object",
"properties": {
"min": {
"type": "object",
"properties": {
"year": {
"type": "number"
},
"month": {
"type": "number"
}
},
"example": {
"year": 5,
"month": 6
},
"description": "Minimum duration as `{year, month}`."
},
"max": {
"type": "object",
"properties": {
"year": {
"type": "number"
},
"month": {
"type": "number"
}
},
"example": {
"year": 10,
"month": 0
},
"description": "Maximum duration as `{year, month}`."
}
}
},
"CompanyMetrics": {
"type": "object",
"properties": {
"employee": {
"type": "array",
"items": {
"type": "object",
"properties": {
"function": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompanyDepartmentEnum"
}
},
"start": {
"type": "number",
"description": "Minimum head-count"
},
"end": {
"type": "number",
"description": "Maximum head-count"
}
}
},
"description": "Current absolute head-count per department: array of `{function[], start, end}` β e.g. companies with 10β100 people in `sales`. For change over time use `growth` (percent-based)."
},
"growth": {
"type": "array",
"items": {
"type": "object",
"properties": {
"function": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompanyDepartmentEnum"
}
},
"start": {
"type": "number",
"description": "min percentage"
},
"end": {
"type": "number",
"description": "max percentage"
},
"timeFrame": {
"$ref": "#/components/schemas/TimeFrameEnum",
"description": "Number of months"
}
}
},
"description": "Percent headcount growth per department: array of `{function[], start, end, timeFrame}`."
}
}
},
"RangeWithTypeEmployeeSize": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"RANGE"
],
"description": "The type of range filter"
},
"range": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SingleRangeEmployeeSize"
},
"description": "Array of employee size ranges"
}
},
"example": {
"type": "RANGE",
"range": [
{
"start": 1,
"end": 10
},
{
"start": 100,
"end": 500
}
]
}
},
"RangeWithTypeRetailSize": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"RANGE"
],
"description": "The type of range filter"
},
"range": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SingleRangeRetailSize"
},
"description": "Array of retail size ranges"
}
},
"example": {
"type": "RANGE",
"range": [
{
"start": 1,
"end": 10
}
]
}
}
},
"securitySchemes": {
"Header": {
"type": "apiKey",
"in": "header",
"name": "X-TOKEN"
}
}
},
"security": [
{
"Header": []
}
]
}
````