higherdata-sdk 0.5.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/index.d.ts +1018 -130
  2. package/dist/index.js +2378 -437
  3. package/package.json +2 -2
package/dist/index.js CHANGED
@@ -73,9 +73,11 @@ var TOOL_NAMES = [
73
73
  "lookup.person",
74
74
  "search.companies",
75
75
  "search.count",
76
+ "search.count_people",
76
77
  "search.facets",
77
78
  "search.filters_from_text",
78
79
  "search.people",
80
+ "search.preview_company_count",
79
81
  "searches.list",
80
82
  "searches.save",
81
83
  "suppress.add",
@@ -271,7 +273,7 @@ var TOOL_CATALOG = [
271
273
  },
272
274
  {
273
275
  "name": "account.limits",
274
- "description": "Returns the current plan rate limits, concurrency and monthly email verification allowance.",
276
+ "description": "Returns the current plan rate limits, concurrency and available purchased verify credit balance.",
275
277
  "risk": "read",
276
278
  "scopes": [],
277
279
  "input": {
@@ -456,7 +458,7 @@ var TOOL_CATALOG = [
456
458
  },
457
459
  {
458
460
  "name": "account.usage",
459
- "description": "Returns monthly activity, the email verification allowance and its reset time.",
461
+ "description": "Returns monthly activity, the available purchased verify credit balance.",
460
462
  "risk": "read",
461
463
  "scopes": [],
462
464
  "input": {
@@ -1919,7 +1921,7 @@ var TOOL_CATALOG = [
1919
1921
  },
1920
1922
  {
1921
1923
  "name": "email.find",
1922
- "description": "Find a person's work email from company pattern evidence. Tries at most three candidates in order and stops at the first deliverable. Dry run only plans candidates. Use the returned requestId to read or continue pending work.",
1924
+ "description": "Find a person's work email from company pattern evidence. Tries at most three candidates in order and stops at the first deliverable. At zero verify credits, returns the best available pattern guess marked unverified. Dry run only plans candidates. Use the returned requestId to read or continue pending work.",
1923
1925
  "risk": "read",
1924
1926
  "scopes": [
1925
1927
  "data:read"
@@ -1930,6 +1932,11 @@ var TOOL_CATALOG = [
1930
1932
  {
1931
1933
  "type": "object",
1932
1934
  "properties": {
1935
+ "personId": {
1936
+ "description": "Stable person id to attach the verified email to.",
1937
+ "type": "string",
1938
+ "pattern": "^hdp_[0-9a-f]{32}$"
1939
+ },
1933
1940
  "firstName": {
1934
1941
  "type": "string",
1935
1942
  "minLength": 1,
@@ -1968,6 +1975,11 @@ var TOOL_CATALOG = [
1968
1975
  "minLength": 1,
1969
1976
  "maxLength": 240
1970
1977
  },
1978
+ "linkedinUrl": {
1979
+ "description": "LinkedIn company page URL.",
1980
+ "type": "string",
1981
+ "maxLength": 2048
1982
+ },
1971
1983
  "city": {
1972
1984
  "description": "City of the headquarters.",
1973
1985
  "type": "string",
@@ -2517,7 +2529,7 @@ var TOOL_CATALOG = [
2517
2529
  }
2518
2530
  },
2519
2531
  "additionalProperties": false,
2520
- "description": "Company to match. Supply an id, a domain, or a name."
2532
+ "description": "Company to match. Supply an id, a domain, a LinkedIn URL, or a name."
2521
2533
  }
2522
2534
  },
2523
2535
  "required": [
@@ -2547,7 +2559,7 @@ var TOOL_CATALOG = [
2547
2559
  },
2548
2560
  {
2549
2561
  "name": "email.verify",
2550
- "description": "Verify one email address. Dry run spends nothing. Returns a requestId for pending work; call this tool with requestId to read or continue it. Verification results use deliverable, undeliverable, risky or unknown.",
2562
+ "description": "Verify one email address not already held for a contact. API callers may explicitly pass force to verify an existing address. Provider answers use purchased verify credits; cached answers are free. Dry run spends nothing. Returns a requestId for pending work; call this tool with requestId to read or continue it. Verification results use deliverable, undeliverable, risky or unknown.",
2551
2563
  "risk": "read",
2552
2564
  "scopes": [
2553
2565
  "data:read"
@@ -2558,12 +2570,21 @@ var TOOL_CATALOG = [
2558
2570
  {
2559
2571
  "type": "object",
2560
2572
  "properties": {
2573
+ "personId": {
2574
+ "description": "Stable person id to attach the verified email to.",
2575
+ "type": "string",
2576
+ "pattern": "^hdp_[0-9a-f]{32}$"
2577
+ },
2561
2578
  "email": {
2562
2579
  "type": "string",
2563
2580
  "maxLength": 320,
2564
2581
  "format": "email",
2565
2582
  "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
2566
2583
  "description": "Work email address to verify."
2584
+ },
2585
+ "force": {
2586
+ "description": "API override to verify an address already held for a contact. Not offered in the UI.",
2587
+ "type": "boolean"
2567
2588
  }
2568
2589
  },
2569
2590
  "required": [
@@ -2772,7 +2793,7 @@ var TOOL_CATALOG = [
2772
2793
  },
2773
2794
  {
2774
2795
  "name": "enrich.company",
2775
- "description": "Compare a company record with HigherData Core, using stable id, exact domain, then exact name and location. Name matches always require review. Dry run returns comparisons without recording them. Insights fields and filters require the Insights or Unlimited plan.",
2796
+ "description": "Compare a company record with HigherData Core, using stable id, LinkedIn URL, exact domain, then exact name and location. Name matches always require review. Dry run returns comparisons without recording them. Insights fields and filters require the Insights or Complete plan.",
2776
2797
  "risk": "write_local",
2777
2798
  "scopes": [
2778
2799
  "data:read",
@@ -2799,6 +2820,11 @@ var TOOL_CATALOG = [
2799
2820
  "minLength": 1,
2800
2821
  "maxLength": 240
2801
2822
  },
2823
+ "linkedinUrl": {
2824
+ "description": "LinkedIn company page URL.",
2825
+ "type": "string",
2826
+ "maxLength": 2048
2827
+ },
2802
2828
  "city": {
2803
2829
  "description": "City of the headquarters.",
2804
2830
  "type": "string",
@@ -3348,7 +3374,7 @@ var TOOL_CATALOG = [
3348
3374
  }
3349
3375
  },
3350
3376
  "additionalProperties": false,
3351
- "description": "Company to match. Supply an id, a domain, or a name."
3377
+ "description": "Company to match. Supply an id, a domain, a LinkedIn URL, or a name."
3352
3378
  }
3353
3379
  },
3354
3380
  {
@@ -3422,8 +3448,7 @@ var TOOL_CATALOG = [
3422
3448
  "linkedinUrl": {
3423
3449
  "description": "LinkedIn person profile URL.",
3424
3450
  "type": "string",
3425
- "maxLength": 2048,
3426
- "format": "uri"
3451
+ "maxLength": 2048
3427
3452
  },
3428
3453
  "name": {
3429
3454
  "description": "Person's full name.",
@@ -3432,7 +3457,7 @@ var TOOL_CATALOG = [
3432
3457
  "maxLength": 240
3433
3458
  },
3434
3459
  "company": {
3435
- "description": "Company this person works at. Supply an id, a domain, or a name.",
3460
+ "description": "Company this person works at. Supply an id, a domain, a LinkedIn URL, or a name.",
3436
3461
  "type": "object",
3437
3462
  "properties": {
3438
3463
  "id": {
@@ -3452,6 +3477,11 @@ var TOOL_CATALOG = [
3452
3477
  "minLength": 1,
3453
3478
  "maxLength": 240
3454
3479
  },
3480
+ "linkedinUrl": {
3481
+ "description": "LinkedIn company page URL.",
3482
+ "type": "string",
3483
+ "maxLength": 2048
3484
+ },
3455
3485
  "city": {
3456
3486
  "description": "City of the headquarters.",
3457
3487
  "type": "string",
@@ -5738,7 +5768,7 @@ var TOOL_CATALOG = [
5738
5768
  }
5739
5769
  },
5740
5770
  "personNames": {
5741
- "description": "Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents.",
5771
+ "description": "Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters.",
5742
5772
  "minItems": 1,
5743
5773
  "maxItems": 5,
5744
5774
  "type": "array",
@@ -6106,6 +6136,28 @@ var TOOL_CATALOG = [
6106
6136
  "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
6107
6137
  }
6108
6138
  },
6139
+ "sort": {
6140
+ "description": "Sort by primary company employee estimate, largest or smallest first. Unknown sizes come last. Available from the November 2026 release.",
6141
+ "type": "string",
6142
+ "enum": [
6143
+ "company_size_desc",
6144
+ "company_size_asc"
6145
+ ]
6146
+ },
6147
+ "firstName": {
6148
+ "description": "First name tokens, using accent-folded fuzzy matching. Requires companyId.",
6149
+ "type": "string",
6150
+ "minLength": 1,
6151
+ "maxLength": 120,
6152
+ "pattern": "\\S"
6153
+ },
6154
+ "lastName": {
6155
+ "description": "Last name tokens, using accent-folded fuzzy matching. Requires companyId.",
6156
+ "type": "string",
6157
+ "minLength": 1,
6158
+ "maxLength": 120,
6159
+ "pattern": "\\S"
6160
+ },
6109
6161
  "companyId": {
6110
6162
  "description": "Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters.",
6111
6163
  "type": "string",
@@ -6220,7 +6272,7 @@ var TOOL_CATALOG = [
6220
6272
  },
6221
6273
  {
6222
6274
  "name": "lists.export",
6223
- "description": "Export a saved list as paged CSV or JSONL with opaque ids. CSV escapes spreadsheet formulas. Pages contain at most 50 records.Insights fields and filters require the Insights or Unlimited plan.",
6275
+ "description": "Export a saved list as paged CSV or JSONL with opaque ids. CSV escapes spreadsheet formulas. Pages contain at most 50 records.Insights fields and filters require the Insights or Complete plan.",
6224
6276
  "risk": "read",
6225
6277
  "scopes": [
6226
6278
  "data:read"
@@ -6409,7 +6461,7 @@ var TOOL_CATALOG = [
6409
6461
  },
6410
6462
  {
6411
6463
  "name": "lookup.company",
6412
- "description": "Look up a company by exactly one domain, exact name (optionally with location), or opaque hdo_ id. Returns bounded candidates and ambiguity metadata. Insights fields and filters require the Insights or Unlimited plan.",
6464
+ "description": "Look up a company by exactly one domain, exact or near name (optionally with location), LinkedIn company page URL, or opaque hdo_ id, or up to 100 ids. Returns bounded candidates and ambiguity metadata. Insights fields and filters require the Insights or Complete plan.",
6413
6465
  "risk": "read",
6414
6466
  "scopes": [
6415
6467
  "data:read"
@@ -6434,7 +6486,7 @@ var TOOL_CATALOG = [
6434
6486
  "maximum": 5
6435
6487
  },
6436
6488
  "excludeListId": {
6437
- "description": "Saved list whose members are left out of the result.",
6489
+ "description": "Ignore one suppression list for this call only, tenant owner only. Allowed kinds: customers, open_deals, competitors, partners, employees, custom. Do not contact, opt-out and global erasure rules cannot be lifted.",
6438
6490
  "type": "string",
6439
6491
  "format": "uuid",
6440
6492
  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
@@ -6477,7 +6529,7 @@ var TOOL_CATALOG = [
6477
6529
  "maximum": 5
6478
6530
  },
6479
6531
  "excludeListId": {
6480
- "description": "Saved list whose members are left out of the result.",
6532
+ "description": "Ignore one suppression list for this call only, tenant owner only. Allowed kinds: customers, open_deals, competitors, partners, employees, custom. Do not contact, opt-out and global erasure rules cannot be lifted.",
6481
6533
  "type": "string",
6482
6534
  "format": "uuid",
6483
6535
  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
@@ -6497,7 +6549,7 @@ var TOOL_CATALOG = [
6497
6549
  "description": "Opaque company id (hdo_)."
6498
6550
  },
6499
6551
  "excludeListId": {
6500
- "description": "Saved list whose members are left out of the result.",
6552
+ "description": "Ignore one suppression list for this call only, tenant owner only. Allowed kinds: customers, open_deals, competitors, partners, employees, custom. Do not contact, opt-out and global erasure rules cannot be lifted.",
6501
6553
  "type": "string",
6502
6554
  "format": "uuid",
6503
6555
  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
@@ -6507,6 +6559,59 @@ var TOOL_CATALOG = [
6507
6559
  "id"
6508
6560
  ],
6509
6561
  "additionalProperties": false
6562
+ },
6563
+ {
6564
+ "type": "object",
6565
+ "properties": {
6566
+ "ids": {
6567
+ "minItems": 1,
6568
+ "maxItems": 100,
6569
+ "type": "array",
6570
+ "items": {
6571
+ "type": "string",
6572
+ "pattern": "^hdo_[0-9a-f]{32}$",
6573
+ "description": "Opaque company id (hdo_)."
6574
+ },
6575
+ "description": "Look up up to 100 opaque company ids in one call."
6576
+ },
6577
+ "excludeListId": {
6578
+ "description": "Ignore one suppression list for this call only, tenant owner only. Allowed kinds: customers, open_deals, competitors, partners, employees, custom. Do not contact, opt-out and global erasure rules cannot be lifted.",
6579
+ "type": "string",
6580
+ "format": "uuid",
6581
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
6582
+ }
6583
+ },
6584
+ "required": [
6585
+ "ids"
6586
+ ],
6587
+ "additionalProperties": false
6588
+ },
6589
+ {
6590
+ "type": "object",
6591
+ "properties": {
6592
+ "linkedinUrl": {
6593
+ "type": "string",
6594
+ "maxLength": 2048,
6595
+ "description": "LinkedIn company page URL."
6596
+ },
6597
+ "candidateLimit": {
6598
+ "default": 5,
6599
+ "description": "Maximum candidates to return.",
6600
+ "type": "integer",
6601
+ "minimum": 1,
6602
+ "maximum": 5
6603
+ },
6604
+ "excludeListId": {
6605
+ "description": "Ignore one suppression list for this call only, tenant owner only. Allowed kinds: customers, open_deals, competitors, partners, employees, custom. Do not contact, opt-out and global erasure rules cannot be lifted.",
6606
+ "type": "string",
6607
+ "format": "uuid",
6608
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
6609
+ }
6610
+ },
6611
+ "required": [
6612
+ "linkedinUrl"
6613
+ ],
6614
+ "additionalProperties": false
6510
6615
  }
6511
6616
  ]
6512
6617
  }
@@ -6522,6 +6627,12 @@ var TOOL_CATALOG = [
6522
6627
  "$schema": "https://json-schema.org/draft/2020-12/schema",
6523
6628
  "type": "object",
6524
6629
  "properties": {
6630
+ "excludeListId": {
6631
+ "description": "Ignore one suppression list for this call only, tenant owner only. Allowed kinds: customers, open_deals, competitors, partners, employees, custom. Do not contact, opt-out and global erasure rules cannot be lifted.",
6632
+ "type": "string",
6633
+ "format": "uuid",
6634
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
6635
+ },
6525
6636
  "companyId": {
6526
6637
  "description": "Select a company from a previous ambiguous company-scoped lookup.",
6527
6638
  "type": "string",
@@ -6542,7 +6653,7 @@ var TOOL_CATALOG = [
6542
6653
  },
6543
6654
  {
6544
6655
  "name": "lookup.person",
6545
- "description": "Look up a person by exactly one work email, international phone, exact or prefix name, LinkedIn profile URL or opaque hdp_ id. Names may be narrowed by company name or domain. Matching includes people without email or a current company. ",
6656
+ "description": "Look up a person by exactly one work email, international phone, token-matched name, LinkedIn profile URL or opaque hdp_ id. Names may be narrowed by company name or domain. Matching includes people without email or a current company. ",
6546
6657
  "risk": "read",
6547
6658
  "scopes": [
6548
6659
  "data:read"
@@ -6568,7 +6679,7 @@ var TOOL_CATALOG = [
6568
6679
  "maximum": 5
6569
6680
  },
6570
6681
  "excludeListId": {
6571
- "description": "Saved list whose members are left out of the result.",
6682
+ "description": "Ignore one suppression list for this call only, tenant owner only. Allowed kinds: customers, open_deals, competitors, partners, employees, custom. Do not contact, opt-out and global erasure rules cannot be lifted.",
6572
6683
  "type": "string",
6573
6684
  "format": "uuid",
6574
6685
  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
@@ -6595,7 +6706,7 @@ var TOOL_CATALOG = [
6595
6706
  "maximum": 5
6596
6707
  },
6597
6708
  "excludeListId": {
6598
- "description": "Saved list whose members are left out of the result.",
6709
+ "description": "Ignore one suppression list for this call only, tenant owner only. Allowed kinds: customers, open_deals, competitors, partners, employees, custom. Do not contact, opt-out and global erasure rules cannot be lifted.",
6599
6710
  "type": "string",
6600
6711
  "format": "uuid",
6601
6712
  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
@@ -6635,7 +6746,7 @@ var TOOL_CATALOG = [
6635
6746
  "maximum": 20
6636
6747
  },
6637
6748
  "excludeListId": {
6638
- "description": "Saved list whose members are left out of the result.",
6749
+ "description": "Ignore one suppression list for this call only, tenant owner only. Allowed kinds: customers, open_deals, competitors, partners, employees, custom. Do not contact, opt-out and global erasure rules cannot be lifted.",
6639
6750
  "type": "string",
6640
6751
  "format": "uuid",
6641
6752
  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
@@ -6652,7 +6763,6 @@ var TOOL_CATALOG = [
6652
6763
  "linkedinUrl": {
6653
6764
  "type": "string",
6654
6765
  "maxLength": 2048,
6655
- "format": "uri",
6656
6766
  "description": "LinkedIn person profile URL."
6657
6767
  },
6658
6768
  "candidateLimit": {
@@ -6663,7 +6773,7 @@ var TOOL_CATALOG = [
6663
6773
  "maximum": 5
6664
6774
  },
6665
6775
  "excludeListId": {
6666
- "description": "Saved list whose members are left out of the result.",
6776
+ "description": "Ignore one suppression list for this call only, tenant owner only. Allowed kinds: customers, open_deals, competitors, partners, employees, custom. Do not contact, opt-out and global erasure rules cannot be lifted.",
6667
6777
  "type": "string",
6668
6778
  "format": "uuid",
6669
6779
  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
@@ -6690,10 +6800,14 @@ var TOOL_CATALOG = [
6690
6800
  "maximum": 5
6691
6801
  },
6692
6802
  "excludeListId": {
6693
- "description": "Saved list whose members are left out of the result.",
6803
+ "description": "Ignore one suppression list for this call only, tenant owner only. Allowed kinds: customers, open_deals, competitors, partners, employees, custom. Do not contact, opt-out and global erasure rules cannot be lifted.",
6694
6804
  "type": "string",
6695
6805
  "format": "uuid",
6696
6806
  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
6807
+ },
6808
+ "includeEmployment": {
6809
+ "description": "Include current and past jobs for this person, with suppression applied to each job.",
6810
+ "type": "boolean"
6697
6811
  }
6698
6812
  },
6699
6813
  "required": [
@@ -6706,7 +6820,7 @@ var TOOL_CATALOG = [
6706
6820
  },
6707
6821
  {
6708
6822
  "name": "search.companies",
6709
- "description": "Find companies in HigherData Core using explicit filters. Optional domain uses exact website-host matching and ranks root sites first. Pages contain at most 50 records and opaque ids. Insights fields and filters require the Insights or Unlimited plan.",
6823
+ "description": "Find companies in HigherData Core using explicit filters. Optional domain uses exact website-host matching and ranks root sites first. Interactive pages contain at most 50 records. A download (download: true) contains at most 500 records and opaque ids. Insights fields and filters require the Insights or Complete plan.",
6710
6824
  "risk": "read",
6711
6825
  "scopes": [
6712
6826
  "data:read"
@@ -7057,10 +7171,10 @@ var TOOL_CATALOG = [
7057
7171
  },
7058
7172
  "limit": {
7059
7173
  "default": 50,
7060
- "description": "Maximum records in this page.",
7174
+ "description": "Maximum records in this page. Interactive search accepts at most 50. A download (download true) accepts at most 500.",
7061
7175
  "type": "integer",
7062
7176
  "minimum": 1,
7063
- "maximum": 50
7177
+ "maximum": 500
7064
7178
  },
7065
7179
  "cursor": {
7066
7180
  "description": "Cursor from the previous page. Omit it for the first page.",
@@ -7750,10 +7864,14 @@ var TOOL_CATALOG = [
7750
7864
  "additionalProperties": false
7751
7865
  },
7752
7866
  "excludeListId": {
7753
- "description": "Saved list whose members are left out of the result.",
7867
+ "description": "Ignore one suppression list for this call only, tenant owner only. Allowed kinds: customers, open_deals, competitors, partners, employees, custom. Do not contact, opt-out and global erasure rules cannot be lifted.",
7754
7868
  "type": "string",
7755
7869
  "format": "uuid",
7756
7870
  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
7871
+ },
7872
+ "download": {
7873
+ "description": "Set true to download a page. Interactive search stays at 50 records. The server reads this flag from the request, not from a plan or role.",
7874
+ "type": "boolean"
7757
7875
  }
7758
7876
  },
7759
7877
  "additionalProperties": false
@@ -8796,8 +8914,8 @@ var TOOL_CATALOG = [
8796
8914
  }
8797
8915
  },
8798
8916
  {
8799
- "name": "search.facets",
8800
- "description": "Read release-built country, state, industry, NAICS, funding, department, seniority and role family values from HigherData Core, with optional country-scoped company, person or job city suggestions. Eligible plans also receive technology product suggestions.",
8917
+ "name": "search.count_people",
8918
+ "description": "Count people once by primary current job before suppression using release-built aggregates; search results may match other current jobs. Names and email use exact indexed counts. Unsupported refinements return an unavailable count, never a total that ignores them. exact: true explicitly requests one capped detailed count of matching people; never use it for live filtering.",
8801
8919
  "risk": "read",
8802
8920
  "scopes": [
8803
8921
  "data:read"
@@ -8806,159 +8924,1213 @@ var TOOL_CATALOG = [
8806
8924
  "$schema": "https://json-schema.org/draft/2020-12/schema",
8807
8925
  "type": "object",
8808
8926
  "properties": {
8809
- "cities": {
8810
- "description": "Get only city suggestions for these countries; omit this field for other suggestions. Person and job cities require a company country or industry.",
8927
+ "filters": {
8811
8928
  "type": "object",
8812
8929
  "properties": {
8813
- "location": {
8930
+ "companyNames": {
8931
+ "description": "Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes.",
8932
+ "minItems": 1,
8933
+ "maxItems": 5,
8934
+ "type": "array",
8935
+ "items": {
8936
+ "type": "string",
8937
+ "minLength": 1,
8938
+ "maxLength": 120,
8939
+ "pattern": "\\S"
8940
+ }
8941
+ },
8942
+ "excludeCompanyNames": {
8943
+ "description": "Company name prefixes to leave out.",
8944
+ "minItems": 1,
8945
+ "maxItems": 5,
8946
+ "type": "array",
8947
+ "items": {
8948
+ "type": "string",
8949
+ "minLength": 1,
8950
+ "maxLength": 120,
8951
+ "pattern": "\\S"
8952
+ }
8953
+ },
8954
+ "domain": {
8955
+ "description": "Company website domain. Exact host matching; root sites rank first.",
8814
8956
  "type": "string",
8815
- "enum": [
8816
- "company",
8817
- "person",
8818
- "job"
8819
- ],
8820
- "description": "Location whose city suggestions should be read."
8957
+ "minLength": 1,
8958
+ "maxLength": 320
8821
8959
  },
8822
8960
  "countryCodes": {
8961
+ "description": "Two-letter country codes to include.",
8823
8962
  "minItems": 1,
8824
- "maxItems": 5,
8963
+ "maxItems": 50,
8825
8964
  "type": "array",
8826
8965
  "items": {
8827
8966
  "type": "string",
8828
- "pattern": "^[A-Z]{2}$"
8829
- },
8830
- "description": "One to five location country codes for city suggestions."
8967
+ "pattern": "^\\s*[a-z]{2}\\s*$"
8968
+ }
8831
8969
  },
8832
- "companyCountryCodes": {
8833
- "description": "One to five company HQ countries to prune person or job suggestions.",
8970
+ "stateCodes": {
8971
+ "description": "State or region codes to include.",
8834
8972
  "minItems": 1,
8835
- "maxItems": 5,
8973
+ "maxItems": 50,
8836
8974
  "type": "array",
8837
8975
  "items": {
8838
8976
  "type": "string",
8839
- "pattern": "^[A-Z]{2}$"
8977
+ "minLength": 1,
8978
+ "maxLength": 120,
8979
+ "pattern": "\\S"
8840
8980
  }
8841
8981
  },
8842
8982
  "industries": {
8843
- "description": "One to five company industries to prune person or job suggestions.",
8983
+ "description": "Industries to include.",
8844
8984
  "minItems": 1,
8845
- "maxItems": 5,
8985
+ "maxItems": 50,
8846
8986
  "type": "array",
8847
8987
  "items": {
8848
8988
  "type": "string",
8849
8989
  "minLength": 1,
8850
- "maxLength": 120
8990
+ "maxLength": 120,
8991
+ "pattern": "\\S"
8851
8992
  }
8852
- }
8853
- },
8854
- "required": [
8855
- "location",
8856
- "countryCodes"
8857
- ],
8858
- "additionalProperties": false
8859
- }
8860
- },
8861
- "additionalProperties": false
8862
- }
8863
- },
8864
- {
8865
- "name": "search.filters_from_text",
8866
- "description": "Turn a sentence into proposed editable filters with a short explanation. Does not execute a search.",
8867
- "risk": "read",
8868
- "scopes": [
8869
- "data:read"
8870
- ],
8871
- "input": {
8872
- "$schema": "https://json-schema.org/draft/2020-12/schema",
8873
- "type": "object",
8874
- "properties": {
8875
- "text": {
8876
- "type": "string",
8877
- "minLength": 1,
8878
- "maxLength": 4e3,
8879
- "description": "Sentence to turn into filters."
8880
- },
8881
- "kind": {
8882
- "default": "companies",
8883
- "description": "Whether the sentence describes companies or people.",
8884
- "type": "string",
8885
- "enum": [
8886
- "companies",
8887
- "people"
8888
- ]
8889
- }
8890
- },
8891
- "required": [
8892
- "text"
8893
- ],
8894
- "additionalProperties": false
8895
- }
8896
- },
8897
- {
8898
- "name": "search.people",
8899
- "description": "Find people in HigherData Core, with 1 to 5 positive company HQ country codes or industries required unless a company id, company name, domain or indexed email scopes the search. Person names require a company scope. Person, job and company location use distinct filters; each city filter requires its corresponding country. Company-scoped contacts also support legacy contactLocation filters. Pages contain at most 50 people and opaque ids. ",
8900
- "risk": "read",
8901
- "scopes": [
8902
- "data:read"
8903
- ],
8904
- "input": {
8905
- "$schema": "https://json-schema.org/draft/2020-12/schema",
8906
- "type": "object",
8907
- "properties": {
8908
- "companyNames": {
8909
- "description": "Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes.",
8910
- "minItems": 1,
8911
- "maxItems": 5,
8912
- "type": "array",
8913
- "items": {
8914
- "type": "string",
8915
- "minLength": 1,
8916
- "maxLength": 120,
8917
- "pattern": "\\S"
8918
- }
8919
- },
8920
- "excludeCompanyNames": {
8921
- "description": "Company name prefixes to leave out.",
8922
- "minItems": 1,
8923
- "maxItems": 5,
8924
- "type": "array",
8925
- "items": {
8926
- "type": "string",
8927
- "minLength": 1,
8928
- "maxLength": 120,
8929
- "pattern": "\\S"
8930
- }
8931
- },
8932
- "domain": {
8933
- "description": "Company website domain. Exact host matching; root sites rank first.",
8934
- "type": "string",
8935
- "minLength": 1,
8936
- "maxLength": 320
8937
- },
8938
- "countryCodes": {
8939
- "description": "Two-letter country codes to include.",
8940
- "minItems": 1,
8941
- "maxItems": 50,
8942
- "type": "array",
8943
- "items": {
8944
- "type": "string",
8945
- "pattern": "^\\s*[a-z]{2}\\s*$"
8946
- }
8947
- },
8948
- "stateCodes": {
8949
- "description": "State or region codes to include.",
8950
- "minItems": 1,
8951
- "maxItems": 50,
8952
- "type": "array",
8953
- "items": {
8954
- "type": "string",
8955
- "minLength": 1,
8956
- "maxLength": 120,
8957
- "pattern": "\\S"
8958
- }
8959
- },
8960
- "industries": {
8961
- "description": "Industries to include.",
8993
+ },
8994
+ "excludeCountryCodes": {
8995
+ "description": "Two-letter country codes to leave out.",
8996
+ "minItems": 1,
8997
+ "maxItems": 50,
8998
+ "type": "array",
8999
+ "items": {
9000
+ "type": "string",
9001
+ "pattern": "^\\s*[a-z]{2}\\s*$"
9002
+ }
9003
+ },
9004
+ "excludeStateCodes": {
9005
+ "description": "State or region codes to leave out.",
9006
+ "minItems": 1,
9007
+ "maxItems": 50,
9008
+ "type": "array",
9009
+ "items": {
9010
+ "type": "string",
9011
+ "minLength": 1,
9012
+ "maxLength": 120,
9013
+ "pattern": "\\S"
9014
+ }
9015
+ },
9016
+ "excludeIndustries": {
9017
+ "description": "Industries to leave out.",
9018
+ "minItems": 1,
9019
+ "maxItems": 50,
9020
+ "type": "array",
9021
+ "items": {
9022
+ "type": "string",
9023
+ "minLength": 1,
9024
+ "maxLength": 120,
9025
+ "pattern": "\\S"
9026
+ }
9027
+ },
9028
+ "employeeCountMin": {
9029
+ "description": "Lowest employee count to include.",
9030
+ "type": "integer",
9031
+ "minimum": 0,
9032
+ "maximum": 9007199254740991
9033
+ },
9034
+ "employeeCountMax": {
9035
+ "description": "Highest employee count to include.",
9036
+ "type": "integer",
9037
+ "minimum": 0,
9038
+ "maximum": 9007199254740991
9039
+ },
9040
+ "revenueMinUsd": {
9041
+ "description": "Lowest annual revenue to include, in US dollars.",
9042
+ "type": "integer",
9043
+ "minimum": 0,
9044
+ "maximum": 9007199254740991
9045
+ },
9046
+ "revenueMaxUsd": {
9047
+ "description": "Highest annual revenue to include, in US dollars.",
9048
+ "type": "integer",
9049
+ "minimum": 0,
9050
+ "maximum": 9007199254740991
9051
+ },
9052
+ "naics2022Codes": {
9053
+ "description": "NAICS 2022 codes to include.",
9054
+ "minItems": 1,
9055
+ "maxItems": 50,
9056
+ "type": "array",
9057
+ "items": {
9058
+ "type": "string",
9059
+ "pattern": "^[0-9]{6}$"
9060
+ }
9061
+ },
9062
+ "excludeNaics2022Codes": {
9063
+ "description": "NAICS 2022 codes to leave out.",
9064
+ "minItems": 1,
9065
+ "maxItems": 50,
9066
+ "type": "array",
9067
+ "items": {
9068
+ "type": "string",
9069
+ "pattern": "^[0-9]{6}$"
9070
+ }
9071
+ },
9072
+ "fundingTypes": {
9073
+ "description": "Funding round types to include.",
9074
+ "minItems": 1,
9075
+ "maxItems": 50,
9076
+ "type": "array",
9077
+ "items": {
9078
+ "type": "string",
9079
+ "minLength": 1,
9080
+ "maxLength": 120,
9081
+ "pattern": "\\S"
9082
+ }
9083
+ },
9084
+ "excludeFundingTypes": {
9085
+ "description": "Funding round types to leave out.",
9086
+ "minItems": 1,
9087
+ "maxItems": 50,
9088
+ "type": "array",
9089
+ "items": {
9090
+ "type": "string",
9091
+ "minLength": 1,
9092
+ "maxLength": 120,
9093
+ "pattern": "\\S"
9094
+ }
9095
+ },
9096
+ "keywords": {
9097
+ "description": "Keywords to match. A company can match any of them.",
9098
+ "minItems": 1,
9099
+ "maxItems": 50,
9100
+ "type": "array",
9101
+ "items": {
9102
+ "type": "string",
9103
+ "minLength": 1,
9104
+ "maxLength": 120,
9105
+ "pattern": "\\S"
9106
+ }
9107
+ },
9108
+ "requiredKeywords": {
9109
+ "description": "Keywords the company must match.",
9110
+ "minItems": 1,
9111
+ "maxItems": 50,
9112
+ "type": "array",
9113
+ "items": {
9114
+ "type": "string",
9115
+ "minLength": 1,
9116
+ "maxLength": 120,
9117
+ "pattern": "\\S"
9118
+ }
9119
+ },
9120
+ "requiredKeywordGroups": {
9121
+ "description": "Keyword groups. The company must match every group, and any keyword inside a group.",
9122
+ "maxItems": 10,
9123
+ "type": "array",
9124
+ "items": {
9125
+ "minItems": 1,
9126
+ "maxItems": 50,
9127
+ "type": "array",
9128
+ "items": {
9129
+ "type": "string",
9130
+ "minLength": 1,
9131
+ "maxLength": 120,
9132
+ "pattern": "\\S"
9133
+ }
9134
+ }
9135
+ },
9136
+ "excludeKeywords": {
9137
+ "description": "Keywords that remove a company.",
9138
+ "minItems": 1,
9139
+ "maxItems": 50,
9140
+ "type": "array",
9141
+ "items": {
9142
+ "type": "string",
9143
+ "minLength": 1,
9144
+ "maxLength": 120,
9145
+ "pattern": "\\S"
9146
+ }
9147
+ },
9148
+ "websiteAvailability": {
9149
+ "description": "Whether the company has a website.",
9150
+ "type": "string",
9151
+ "enum": [
9152
+ "any",
9153
+ "available",
9154
+ "missing"
9155
+ ]
9156
+ },
9157
+ "linkedinAvailability": {
9158
+ "description": "Whether the company has a LinkedIn page.",
9159
+ "type": "string",
9160
+ "enum": [
9161
+ "any",
9162
+ "available",
9163
+ "missing"
9164
+ ]
9165
+ },
9166
+ "fundingDateAfter": {
9167
+ "description": "Include funding on or after this date.",
9168
+ "type": "string",
9169
+ "format": "date",
9170
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
9171
+ },
9172
+ "fundingDateBefore": {
9173
+ "description": "Include funding on or before this date.",
9174
+ "type": "string",
9175
+ "format": "date",
9176
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
9177
+ },
9178
+ "excludeOrganizationIds": {
9179
+ "description": "Opaque company ids (hdo_) to leave out.",
9180
+ "maxItems": 1e3,
9181
+ "type": "array",
9182
+ "items": {
9183
+ "type": "string",
9184
+ "pattern": "^hdo_[0-9a-f]{32}$",
9185
+ "description": "Opaque company id (hdo_)."
9186
+ }
9187
+ },
9188
+ "excludeDomains": {
9189
+ "description": "Website domains to leave out.",
9190
+ "maxItems": 1e3,
9191
+ "type": "array",
9192
+ "items": {
9193
+ "type": "string",
9194
+ "minLength": 1,
9195
+ "maxLength": 320
9196
+ }
9197
+ },
9198
+ "personNames": {
9199
+ "description": "Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters.",
9200
+ "minItems": 1,
9201
+ "maxItems": 5,
9202
+ "type": "array",
9203
+ "items": {
9204
+ "type": "string",
9205
+ "minLength": 1,
9206
+ "maxLength": 120,
9207
+ "pattern": "\\S"
9208
+ }
9209
+ },
9210
+ "email": {
9211
+ "description": "Exact work email address, matched through the email index.",
9212
+ "type": "string",
9213
+ "maxLength": 320,
9214
+ "format": "email",
9215
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
9216
+ },
9217
+ "personCities": {
9218
+ "description": "Person cities to include. Requires personCountryCodes.",
9219
+ "minItems": 1,
9220
+ "maxItems": 50,
9221
+ "type": "array",
9222
+ "items": {
9223
+ "type": "string",
9224
+ "minLength": 1,
9225
+ "maxLength": 120,
9226
+ "pattern": "\\S"
9227
+ }
9228
+ },
9229
+ "excludePersonCities": {
9230
+ "description": "Person cities to leave out. Requires personCountryCodes.",
9231
+ "minItems": 1,
9232
+ "maxItems": 50,
9233
+ "type": "array",
9234
+ "items": {
9235
+ "type": "string",
9236
+ "minLength": 1,
9237
+ "maxLength": 120,
9238
+ "pattern": "\\S"
9239
+ }
9240
+ },
9241
+ "personStateCodes": {
9242
+ "description": "Person state or region codes to include.",
9243
+ "minItems": 1,
9244
+ "maxItems": 50,
9245
+ "type": "array",
9246
+ "items": {
9247
+ "type": "string",
9248
+ "minLength": 1,
9249
+ "maxLength": 120,
9250
+ "pattern": "\\S"
9251
+ }
9252
+ },
9253
+ "excludePersonStateCodes": {
9254
+ "description": "Person state or region codes to leave out.",
9255
+ "minItems": 1,
9256
+ "maxItems": 50,
9257
+ "type": "array",
9258
+ "items": {
9259
+ "type": "string",
9260
+ "minLength": 1,
9261
+ "maxLength": 120,
9262
+ "pattern": "\\S"
9263
+ }
9264
+ },
9265
+ "personCountryCodes": {
9266
+ "description": "Person country codes to include.",
9267
+ "minItems": 1,
9268
+ "maxItems": 50,
9269
+ "type": "array",
9270
+ "items": {
9271
+ "type": "string",
9272
+ "pattern": "^\\s*[a-z]{2}\\s*$"
9273
+ }
9274
+ },
9275
+ "excludePersonCountryCodes": {
9276
+ "description": "Person country codes to leave out.",
9277
+ "minItems": 1,
9278
+ "maxItems": 50,
9279
+ "type": "array",
9280
+ "items": {
9281
+ "type": "string",
9282
+ "pattern": "^\\s*[a-z]{2}\\s*$"
9283
+ }
9284
+ },
9285
+ "jobCities": {
9286
+ "description": "Job cities to include. Requires jobCountryCodes.",
9287
+ "minItems": 1,
9288
+ "maxItems": 50,
9289
+ "type": "array",
9290
+ "items": {
9291
+ "type": "string",
9292
+ "minLength": 1,
9293
+ "maxLength": 120,
9294
+ "pattern": "\\S"
9295
+ }
9296
+ },
9297
+ "excludeJobCities": {
9298
+ "description": "Job cities to leave out. Requires jobCountryCodes.",
9299
+ "minItems": 1,
9300
+ "maxItems": 50,
9301
+ "type": "array",
9302
+ "items": {
9303
+ "type": "string",
9304
+ "minLength": 1,
9305
+ "maxLength": 120,
9306
+ "pattern": "\\S"
9307
+ }
9308
+ },
9309
+ "jobStateCodes": {
9310
+ "description": "Job state or region codes to include.",
9311
+ "minItems": 1,
9312
+ "maxItems": 50,
9313
+ "type": "array",
9314
+ "items": {
9315
+ "type": "string",
9316
+ "minLength": 1,
9317
+ "maxLength": 120,
9318
+ "pattern": "\\S"
9319
+ }
9320
+ },
9321
+ "excludeJobStateCodes": {
9322
+ "description": "Job state or region codes to leave out.",
9323
+ "minItems": 1,
9324
+ "maxItems": 50,
9325
+ "type": "array",
9326
+ "items": {
9327
+ "type": "string",
9328
+ "minLength": 1,
9329
+ "maxLength": 120,
9330
+ "pattern": "\\S"
9331
+ }
9332
+ },
9333
+ "jobCountryCodes": {
9334
+ "description": "Job country codes to include.",
9335
+ "minItems": 1,
9336
+ "maxItems": 50,
9337
+ "type": "array",
9338
+ "items": {
9339
+ "type": "string",
9340
+ "pattern": "^\\s*[a-z]{2}\\s*$"
9341
+ }
9342
+ },
9343
+ "excludeJobCountryCodes": {
9344
+ "description": "Job country codes to leave out.",
9345
+ "minItems": 1,
9346
+ "maxItems": 50,
9347
+ "type": "array",
9348
+ "items": {
9349
+ "type": "string",
9350
+ "pattern": "^\\s*[a-z]{2}\\s*$"
9351
+ }
9352
+ },
9353
+ "companyCities": {
9354
+ "description": "Company HQ cities to include. Requires countryCodes.",
9355
+ "minItems": 1,
9356
+ "maxItems": 50,
9357
+ "type": "array",
9358
+ "items": {
9359
+ "type": "string",
9360
+ "minLength": 1,
9361
+ "maxLength": 120,
9362
+ "pattern": "\\S"
9363
+ }
9364
+ },
9365
+ "excludeCompanyCities": {
9366
+ "description": "Company HQ cities to leave out. Requires countryCodes.",
9367
+ "minItems": 1,
9368
+ "maxItems": 50,
9369
+ "type": "array",
9370
+ "items": {
9371
+ "type": "string",
9372
+ "minLength": 1,
9373
+ "maxLength": 120,
9374
+ "pattern": "\\S"
9375
+ }
9376
+ },
9377
+ "companyFoundedYearMin": {
9378
+ "description": "Earliest company founding year.",
9379
+ "type": "integer",
9380
+ "minimum": 0,
9381
+ "maximum": 9007199254740991
9382
+ },
9383
+ "companyFoundedYearMax": {
9384
+ "description": "Latest company founding year.",
9385
+ "type": "integer",
9386
+ "minimum": 0,
9387
+ "maximum": 9007199254740991
9388
+ },
9389
+ "jobStartDateAfter": {
9390
+ "description": "Include jobs started on or after this date.",
9391
+ "type": "string",
9392
+ "format": "date",
9393
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
9394
+ },
9395
+ "jobStartDateBefore": {
9396
+ "description": "Include jobs started on or before this date.",
9397
+ "type": "string",
9398
+ "format": "date",
9399
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
9400
+ },
9401
+ "titleKeywords": {
9402
+ "description": "Job title keywords to match. A person can match any of them.",
9403
+ "minItems": 1,
9404
+ "maxItems": 50,
9405
+ "type": "array",
9406
+ "items": {
9407
+ "type": "string",
9408
+ "minLength": 1,
9409
+ "maxLength": 120,
9410
+ "pattern": "\\S"
9411
+ }
9412
+ },
9413
+ "requiredTitleKeywords": {
9414
+ "description": "Job title keywords the person must match.",
9415
+ "minItems": 1,
9416
+ "maxItems": 50,
9417
+ "type": "array",
9418
+ "items": {
9419
+ "type": "string",
9420
+ "minLength": 1,
9421
+ "maxLength": 120,
9422
+ "pattern": "\\S"
9423
+ }
9424
+ },
9425
+ "requiredTitleKeywordGroups": {
9426
+ "description": "Job title keyword groups. The person must match every group, and any keyword inside a group.",
9427
+ "maxItems": 10,
9428
+ "type": "array",
9429
+ "items": {
9430
+ "minItems": 1,
9431
+ "maxItems": 50,
9432
+ "type": "array",
9433
+ "items": {
9434
+ "type": "string",
9435
+ "minLength": 1,
9436
+ "maxLength": 120,
9437
+ "pattern": "\\S"
9438
+ }
9439
+ }
9440
+ },
9441
+ "excludeTitleKeywords": {
9442
+ "description": "Job title keywords that remove a person.",
9443
+ "minItems": 1,
9444
+ "maxItems": 50,
9445
+ "type": "array",
9446
+ "items": {
9447
+ "type": "string",
9448
+ "minLength": 1,
9449
+ "maxLength": 120,
9450
+ "pattern": "\\S"
9451
+ }
9452
+ },
9453
+ "jobFunctions": {
9454
+ "description": "Job functions to include.",
9455
+ "minItems": 1,
9456
+ "maxItems": 50,
9457
+ "type": "array",
9458
+ "items": {
9459
+ "type": "string",
9460
+ "minLength": 1,
9461
+ "maxLength": 120,
9462
+ "pattern": "\\S"
9463
+ }
9464
+ },
9465
+ "excludeJobFunctions": {
9466
+ "description": "Job functions to leave out.",
9467
+ "minItems": 1,
9468
+ "maxItems": 50,
9469
+ "type": "array",
9470
+ "items": {
9471
+ "type": "string",
9472
+ "minLength": 1,
9473
+ "maxLength": 120,
9474
+ "pattern": "\\S"
9475
+ }
9476
+ },
9477
+ "jobLevels": {
9478
+ "description": "Job levels to include.",
9479
+ "minItems": 1,
9480
+ "maxItems": 50,
9481
+ "type": "array",
9482
+ "items": {
9483
+ "type": "string",
9484
+ "minLength": 1,
9485
+ "maxLength": 120,
9486
+ "pattern": "\\S"
9487
+ }
9488
+ },
9489
+ "excludeJobLevels": {
9490
+ "description": "Job levels to leave out.",
9491
+ "minItems": 1,
9492
+ "maxItems": 50,
9493
+ "type": "array",
9494
+ "items": {
9495
+ "type": "string",
9496
+ "minLength": 1,
9497
+ "maxLength": 120,
9498
+ "pattern": "\\S"
9499
+ }
9500
+ },
9501
+ "gtmRoleFamilies": {
9502
+ "description": "Go-to-market role families to include.",
9503
+ "minItems": 1,
9504
+ "maxItems": 50,
9505
+ "type": "array",
9506
+ "items": {
9507
+ "type": "string",
9508
+ "minLength": 1,
9509
+ "maxLength": 120,
9510
+ "pattern": "\\S"
9511
+ }
9512
+ },
9513
+ "excludeGtmRoleFamilies": {
9514
+ "description": "Go-to-market role families to leave out.",
9515
+ "minItems": 1,
9516
+ "maxItems": 50,
9517
+ "type": "array",
9518
+ "items": {
9519
+ "type": "string",
9520
+ "minLength": 1,
9521
+ "maxLength": 120,
9522
+ "pattern": "\\S"
9523
+ }
9524
+ },
9525
+ "requireVerifiedEmail": {
9526
+ "description": "When true, only people with a verified work email are returned.",
9527
+ "type": "boolean"
9528
+ },
9529
+ "emailAvailability": {
9530
+ "description": "Whether the person has an email address.",
9531
+ "type": "string",
9532
+ "enum": [
9533
+ "any",
9534
+ "available",
9535
+ "missing"
9536
+ ]
9537
+ },
9538
+ "phoneAvailability": {
9539
+ "description": "Whether the person has a phone number.",
9540
+ "type": "string",
9541
+ "enum": [
9542
+ "any",
9543
+ "available",
9544
+ "missing"
9545
+ ]
9546
+ },
9547
+ "excludePersonIds": {
9548
+ "description": "Opaque person ids (hdp_) to leave out.",
9549
+ "maxItems": 1e3,
9550
+ "type": "array",
9551
+ "items": {
9552
+ "type": "string",
9553
+ "pattern": "^hdp_[0-9a-f]{32}$",
9554
+ "description": "Opaque person id (hdp_)."
9555
+ }
9556
+ },
9557
+ "excludeEmails": {
9558
+ "description": "Email addresses to leave out.",
9559
+ "maxItems": 1e3,
9560
+ "type": "array",
9561
+ "items": {
9562
+ "type": "string",
9563
+ "format": "email",
9564
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
9565
+ }
9566
+ },
9567
+ "firstName": {
9568
+ "description": "First name tokens, using accent-folded fuzzy matching. Requires companyId.",
9569
+ "type": "string",
9570
+ "minLength": 1,
9571
+ "maxLength": 120,
9572
+ "pattern": "\\S"
9573
+ },
9574
+ "lastName": {
9575
+ "description": "Last name tokens, using accent-folded fuzzy matching. Requires companyId.",
9576
+ "type": "string",
9577
+ "minLength": 1,
9578
+ "maxLength": 120,
9579
+ "pattern": "\\S"
9580
+ },
9581
+ "companyId": {
9582
+ "description": "Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters.",
9583
+ "type": "string",
9584
+ "pattern": "^hdo_[0-9a-f]{32}$"
9585
+ },
9586
+ "contactLocation": {
9587
+ "description": "Contact location filters. Requires companyId.",
9588
+ "type": "object",
9589
+ "properties": {
9590
+ "countryCodes": {
9591
+ "description": "Person or job location country codes.",
9592
+ "minItems": 1,
9593
+ "maxItems": 50,
9594
+ "type": "array",
9595
+ "items": {
9596
+ "type": "string",
9597
+ "pattern": "^\\s*[a-z]{2}\\s*$"
9598
+ }
9599
+ },
9600
+ "stateCodes": {
9601
+ "description": "Person or job location state codes.",
9602
+ "minItems": 1,
9603
+ "maxItems": 50,
9604
+ "type": "array",
9605
+ "items": {
9606
+ "type": "string",
9607
+ "minLength": 1,
9608
+ "maxLength": 120,
9609
+ "pattern": "\\S"
9610
+ }
9611
+ },
9612
+ "cities": {
9613
+ "description": "Person or job location cities.",
9614
+ "minItems": 1,
9615
+ "maxItems": 50,
9616
+ "type": "array",
9617
+ "items": {
9618
+ "type": "string",
9619
+ "minLength": 1,
9620
+ "maxLength": 120,
9621
+ "pattern": "\\S"
9622
+ }
9623
+ }
9624
+ },
9625
+ "additionalProperties": false
9626
+ }
9627
+ },
9628
+ "additionalProperties": false,
9629
+ "description": "People filters to count."
9630
+ },
9631
+ "exact": {
9632
+ "default": false,
9633
+ "description": "Explicitly request a detailed count when an indexed count is unavailable. Never enable for live filtering.",
9634
+ "type": "boolean"
9635
+ }
9636
+ },
9637
+ "required": [
9638
+ "filters"
9639
+ ],
9640
+ "additionalProperties": false
9641
+ }
9642
+ },
9643
+ {
9644
+ "name": "search.facets",
9645
+ "description": "Read release-built country, state, industry, NAICS, funding, department, seniority and role family values from HigherData Core, with optional country-scoped company, person or job city suggestions. Eligible plans also receive technology product suggestions.",
9646
+ "risk": "read",
9647
+ "scopes": [
9648
+ "data:read"
9649
+ ],
9650
+ "input": {
9651
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
9652
+ "type": "object",
9653
+ "properties": {
9654
+ "cities": {
9655
+ "description": "Get only city suggestions for these countries; omit this field for other suggestions. Person and job cities require a company country or industry.",
9656
+ "type": "object",
9657
+ "properties": {
9658
+ "location": {
9659
+ "type": "string",
9660
+ "enum": [
9661
+ "company",
9662
+ "person",
9663
+ "job"
9664
+ ],
9665
+ "description": "Location whose city suggestions should be read."
9666
+ },
9667
+ "countryCodes": {
9668
+ "minItems": 1,
9669
+ "maxItems": 5,
9670
+ "type": "array",
9671
+ "items": {
9672
+ "type": "string",
9673
+ "pattern": "^[A-Z]{2}$"
9674
+ },
9675
+ "description": "One to five location country codes for city suggestions."
9676
+ },
9677
+ "companyCountryCodes": {
9678
+ "description": "One to five company HQ countries to prune person or job suggestions.",
9679
+ "minItems": 1,
9680
+ "maxItems": 5,
9681
+ "type": "array",
9682
+ "items": {
9683
+ "type": "string",
9684
+ "pattern": "^[A-Z]{2}$"
9685
+ }
9686
+ },
9687
+ "industries": {
9688
+ "description": "One to five company industries to prune person or job suggestions.",
9689
+ "minItems": 1,
9690
+ "maxItems": 5,
9691
+ "type": "array",
9692
+ "items": {
9693
+ "type": "string",
9694
+ "minLength": 1,
9695
+ "maxLength": 120
9696
+ }
9697
+ }
9698
+ },
9699
+ "required": [
9700
+ "location",
9701
+ "countryCodes"
9702
+ ],
9703
+ "additionalProperties": false
9704
+ }
9705
+ },
9706
+ "additionalProperties": false
9707
+ }
9708
+ },
9709
+ {
9710
+ "name": "search.filters_from_text",
9711
+ "description": "Turn a sentence into proposed editable filters with a short explanation. Does not execute a search.",
9712
+ "risk": "read",
9713
+ "scopes": [
9714
+ "data:read"
9715
+ ],
9716
+ "input": {
9717
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
9718
+ "type": "object",
9719
+ "properties": {
9720
+ "text": {
9721
+ "type": "string",
9722
+ "minLength": 1,
9723
+ "maxLength": 4e3,
9724
+ "description": "Sentence to turn into filters."
9725
+ },
9726
+ "kind": {
9727
+ "default": "companies",
9728
+ "description": "Whether the sentence describes companies or people.",
9729
+ "type": "string",
9730
+ "enum": [
9731
+ "companies",
9732
+ "people"
9733
+ ]
9734
+ }
9735
+ },
9736
+ "required": [
9737
+ "text"
9738
+ ],
9739
+ "additionalProperties": false
9740
+ }
9741
+ },
9742
+ {
9743
+ "name": "search.people",
9744
+ "description": "Find people in HigherData Core, with 1 to 5 positive company HQ country codes or industries required unless a company id, company name, domain or indexed email scopes the search. Unscoped person names use indexed tokens and bounded, ranked pages. Person, job and company location use distinct filters; each city filter requires its corresponding country. Company-scoped contacts also support legacy contactLocation filters. Interactive pages contain at most 50 people. A download (download: true) contains at most 500 people and opaque ids. ",
9745
+ "risk": "read",
9746
+ "scopes": [
9747
+ "data:read"
9748
+ ],
9749
+ "input": {
9750
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
9751
+ "type": "object",
9752
+ "properties": {
9753
+ "companyNames": {
9754
+ "description": "Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes.",
9755
+ "minItems": 1,
9756
+ "maxItems": 5,
9757
+ "type": "array",
9758
+ "items": {
9759
+ "type": "string",
9760
+ "minLength": 1,
9761
+ "maxLength": 120,
9762
+ "pattern": "\\S"
9763
+ }
9764
+ },
9765
+ "excludeCompanyNames": {
9766
+ "description": "Company name prefixes to leave out.",
9767
+ "minItems": 1,
9768
+ "maxItems": 5,
9769
+ "type": "array",
9770
+ "items": {
9771
+ "type": "string",
9772
+ "minLength": 1,
9773
+ "maxLength": 120,
9774
+ "pattern": "\\S"
9775
+ }
9776
+ },
9777
+ "domain": {
9778
+ "description": "Company website domain. Exact host matching; root sites rank first.",
9779
+ "type": "string",
9780
+ "minLength": 1,
9781
+ "maxLength": 320
9782
+ },
9783
+ "countryCodes": {
9784
+ "description": "Two-letter country codes to include.",
9785
+ "minItems": 1,
9786
+ "maxItems": 50,
9787
+ "type": "array",
9788
+ "items": {
9789
+ "type": "string",
9790
+ "pattern": "^\\s*[a-z]{2}\\s*$"
9791
+ }
9792
+ },
9793
+ "stateCodes": {
9794
+ "description": "State or region codes to include.",
9795
+ "minItems": 1,
9796
+ "maxItems": 50,
9797
+ "type": "array",
9798
+ "items": {
9799
+ "type": "string",
9800
+ "minLength": 1,
9801
+ "maxLength": 120,
9802
+ "pattern": "\\S"
9803
+ }
9804
+ },
9805
+ "industries": {
9806
+ "description": "Industries to include.",
9807
+ "minItems": 1,
9808
+ "maxItems": 50,
9809
+ "type": "array",
9810
+ "items": {
9811
+ "type": "string",
9812
+ "minLength": 1,
9813
+ "maxLength": 120,
9814
+ "pattern": "\\S"
9815
+ }
9816
+ },
9817
+ "excludeCountryCodes": {
9818
+ "description": "Two-letter country codes to leave out.",
9819
+ "minItems": 1,
9820
+ "maxItems": 50,
9821
+ "type": "array",
9822
+ "items": {
9823
+ "type": "string",
9824
+ "pattern": "^\\s*[a-z]{2}\\s*$"
9825
+ }
9826
+ },
9827
+ "excludeStateCodes": {
9828
+ "description": "State or region codes to leave out.",
9829
+ "minItems": 1,
9830
+ "maxItems": 50,
9831
+ "type": "array",
9832
+ "items": {
9833
+ "type": "string",
9834
+ "minLength": 1,
9835
+ "maxLength": 120,
9836
+ "pattern": "\\S"
9837
+ }
9838
+ },
9839
+ "excludeIndustries": {
9840
+ "description": "Industries to leave out.",
9841
+ "minItems": 1,
9842
+ "maxItems": 50,
9843
+ "type": "array",
9844
+ "items": {
9845
+ "type": "string",
9846
+ "minLength": 1,
9847
+ "maxLength": 120,
9848
+ "pattern": "\\S"
9849
+ }
9850
+ },
9851
+ "employeeCountMin": {
9852
+ "description": "Lowest employee count to include.",
9853
+ "type": "integer",
9854
+ "minimum": 0,
9855
+ "maximum": 9007199254740991
9856
+ },
9857
+ "employeeCountMax": {
9858
+ "description": "Highest employee count to include.",
9859
+ "type": "integer",
9860
+ "minimum": 0,
9861
+ "maximum": 9007199254740991
9862
+ },
9863
+ "revenueMinUsd": {
9864
+ "description": "Lowest annual revenue to include, in US dollars.",
9865
+ "type": "integer",
9866
+ "minimum": 0,
9867
+ "maximum": 9007199254740991
9868
+ },
9869
+ "revenueMaxUsd": {
9870
+ "description": "Highest annual revenue to include, in US dollars.",
9871
+ "type": "integer",
9872
+ "minimum": 0,
9873
+ "maximum": 9007199254740991
9874
+ },
9875
+ "naics2022Codes": {
9876
+ "description": "NAICS 2022 codes to include.",
9877
+ "minItems": 1,
9878
+ "maxItems": 50,
9879
+ "type": "array",
9880
+ "items": {
9881
+ "type": "string",
9882
+ "pattern": "^[0-9]{6}$"
9883
+ }
9884
+ },
9885
+ "excludeNaics2022Codes": {
9886
+ "description": "NAICS 2022 codes to leave out.",
9887
+ "minItems": 1,
9888
+ "maxItems": 50,
9889
+ "type": "array",
9890
+ "items": {
9891
+ "type": "string",
9892
+ "pattern": "^[0-9]{6}$"
9893
+ }
9894
+ },
9895
+ "fundingTypes": {
9896
+ "description": "Funding round types to include.",
9897
+ "minItems": 1,
9898
+ "maxItems": 50,
9899
+ "type": "array",
9900
+ "items": {
9901
+ "type": "string",
9902
+ "minLength": 1,
9903
+ "maxLength": 120,
9904
+ "pattern": "\\S"
9905
+ }
9906
+ },
9907
+ "excludeFundingTypes": {
9908
+ "description": "Funding round types to leave out.",
9909
+ "minItems": 1,
9910
+ "maxItems": 50,
9911
+ "type": "array",
9912
+ "items": {
9913
+ "type": "string",
9914
+ "minLength": 1,
9915
+ "maxLength": 120,
9916
+ "pattern": "\\S"
9917
+ }
9918
+ },
9919
+ "keywords": {
9920
+ "description": "Keywords to match. A company can match any of them.",
9921
+ "minItems": 1,
9922
+ "maxItems": 50,
9923
+ "type": "array",
9924
+ "items": {
9925
+ "type": "string",
9926
+ "minLength": 1,
9927
+ "maxLength": 120,
9928
+ "pattern": "\\S"
9929
+ }
9930
+ },
9931
+ "requiredKeywords": {
9932
+ "description": "Keywords the company must match.",
9933
+ "minItems": 1,
9934
+ "maxItems": 50,
9935
+ "type": "array",
9936
+ "items": {
9937
+ "type": "string",
9938
+ "minLength": 1,
9939
+ "maxLength": 120,
9940
+ "pattern": "\\S"
9941
+ }
9942
+ },
9943
+ "requiredKeywordGroups": {
9944
+ "description": "Keyword groups. The company must match every group, and any keyword inside a group.",
9945
+ "maxItems": 10,
9946
+ "type": "array",
9947
+ "items": {
9948
+ "minItems": 1,
9949
+ "maxItems": 50,
9950
+ "type": "array",
9951
+ "items": {
9952
+ "type": "string",
9953
+ "minLength": 1,
9954
+ "maxLength": 120,
9955
+ "pattern": "\\S"
9956
+ }
9957
+ }
9958
+ },
9959
+ "excludeKeywords": {
9960
+ "description": "Keywords that remove a company.",
9961
+ "minItems": 1,
9962
+ "maxItems": 50,
9963
+ "type": "array",
9964
+ "items": {
9965
+ "type": "string",
9966
+ "minLength": 1,
9967
+ "maxLength": 120,
9968
+ "pattern": "\\S"
9969
+ }
9970
+ },
9971
+ "websiteAvailability": {
9972
+ "description": "Whether the company has a website.",
9973
+ "type": "string",
9974
+ "enum": [
9975
+ "any",
9976
+ "available",
9977
+ "missing"
9978
+ ]
9979
+ },
9980
+ "linkedinAvailability": {
9981
+ "description": "Whether the company has a LinkedIn page.",
9982
+ "type": "string",
9983
+ "enum": [
9984
+ "any",
9985
+ "available",
9986
+ "missing"
9987
+ ]
9988
+ },
9989
+ "fundingDateAfter": {
9990
+ "description": "Include funding on or after this date.",
9991
+ "type": "string",
9992
+ "format": "date",
9993
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
9994
+ },
9995
+ "fundingDateBefore": {
9996
+ "description": "Include funding on or before this date.",
9997
+ "type": "string",
9998
+ "format": "date",
9999
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
10000
+ },
10001
+ "excludeOrganizationIds": {
10002
+ "description": "Opaque company ids (hdo_) to leave out.",
10003
+ "maxItems": 1e3,
10004
+ "type": "array",
10005
+ "items": {
10006
+ "type": "string",
10007
+ "pattern": "^hdo_[0-9a-f]{32}$",
10008
+ "description": "Opaque company id (hdo_)."
10009
+ }
10010
+ },
10011
+ "excludeDomains": {
10012
+ "description": "Website domains to leave out.",
10013
+ "maxItems": 1e3,
10014
+ "type": "array",
10015
+ "items": {
10016
+ "type": "string",
10017
+ "minLength": 1,
10018
+ "maxLength": 320
10019
+ }
10020
+ },
10021
+ "personNames": {
10022
+ "description": "Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters.",
10023
+ "minItems": 1,
10024
+ "maxItems": 5,
10025
+ "type": "array",
10026
+ "items": {
10027
+ "type": "string",
10028
+ "minLength": 1,
10029
+ "maxLength": 120,
10030
+ "pattern": "\\S"
10031
+ }
10032
+ },
10033
+ "email": {
10034
+ "description": "Exact work email address, matched through the email index.",
10035
+ "type": "string",
10036
+ "maxLength": 320,
10037
+ "format": "email",
10038
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
10039
+ },
10040
+ "personCities": {
10041
+ "description": "Person cities to include. Requires personCountryCodes.",
10042
+ "minItems": 1,
10043
+ "maxItems": 50,
10044
+ "type": "array",
10045
+ "items": {
10046
+ "type": "string",
10047
+ "minLength": 1,
10048
+ "maxLength": 120,
10049
+ "pattern": "\\S"
10050
+ }
10051
+ },
10052
+ "excludePersonCities": {
10053
+ "description": "Person cities to leave out. Requires personCountryCodes.",
10054
+ "minItems": 1,
10055
+ "maxItems": 50,
10056
+ "type": "array",
10057
+ "items": {
10058
+ "type": "string",
10059
+ "minLength": 1,
10060
+ "maxLength": 120,
10061
+ "pattern": "\\S"
10062
+ }
10063
+ },
10064
+ "personStateCodes": {
10065
+ "description": "Person state or region codes to include.",
10066
+ "minItems": 1,
10067
+ "maxItems": 50,
10068
+ "type": "array",
10069
+ "items": {
10070
+ "type": "string",
10071
+ "minLength": 1,
10072
+ "maxLength": 120,
10073
+ "pattern": "\\S"
10074
+ }
10075
+ },
10076
+ "excludePersonStateCodes": {
10077
+ "description": "Person state or region codes to leave out.",
10078
+ "minItems": 1,
10079
+ "maxItems": 50,
10080
+ "type": "array",
10081
+ "items": {
10082
+ "type": "string",
10083
+ "minLength": 1,
10084
+ "maxLength": 120,
10085
+ "pattern": "\\S"
10086
+ }
10087
+ },
10088
+ "personCountryCodes": {
10089
+ "description": "Person country codes to include.",
10090
+ "minItems": 1,
10091
+ "maxItems": 50,
10092
+ "type": "array",
10093
+ "items": {
10094
+ "type": "string",
10095
+ "pattern": "^\\s*[a-z]{2}\\s*$"
10096
+ }
10097
+ },
10098
+ "excludePersonCountryCodes": {
10099
+ "description": "Person country codes to leave out.",
10100
+ "minItems": 1,
10101
+ "maxItems": 50,
10102
+ "type": "array",
10103
+ "items": {
10104
+ "type": "string",
10105
+ "pattern": "^\\s*[a-z]{2}\\s*$"
10106
+ }
10107
+ },
10108
+ "jobCities": {
10109
+ "description": "Job cities to include. Requires jobCountryCodes.",
10110
+ "minItems": 1,
10111
+ "maxItems": 50,
10112
+ "type": "array",
10113
+ "items": {
10114
+ "type": "string",
10115
+ "minLength": 1,
10116
+ "maxLength": 120,
10117
+ "pattern": "\\S"
10118
+ }
10119
+ },
10120
+ "excludeJobCities": {
10121
+ "description": "Job cities to leave out. Requires jobCountryCodes.",
10122
+ "minItems": 1,
10123
+ "maxItems": 50,
10124
+ "type": "array",
10125
+ "items": {
10126
+ "type": "string",
10127
+ "minLength": 1,
10128
+ "maxLength": 120,
10129
+ "pattern": "\\S"
10130
+ }
10131
+ },
10132
+ "jobStateCodes": {
10133
+ "description": "Job state or region codes to include.",
8962
10134
  "minItems": 1,
8963
10135
  "maxItems": 50,
8964
10136
  "type": "array",
@@ -8969,8 +10141,20 @@ var TOOL_CATALOG = [
8969
10141
  "pattern": "\\S"
8970
10142
  }
8971
10143
  },
8972
- "excludeCountryCodes": {
8973
- "description": "Two-letter country codes to leave out.",
10144
+ "excludeJobStateCodes": {
10145
+ "description": "Job state or region codes to leave out.",
10146
+ "minItems": 1,
10147
+ "maxItems": 50,
10148
+ "type": "array",
10149
+ "items": {
10150
+ "type": "string",
10151
+ "minLength": 1,
10152
+ "maxLength": 120,
10153
+ "pattern": "\\S"
10154
+ }
10155
+ },
10156
+ "jobCountryCodes": {
10157
+ "description": "Job country codes to include.",
8974
10158
  "minItems": 1,
8975
10159
  "maxItems": 50,
8976
10160
  "type": "array",
@@ -8979,8 +10163,18 @@ var TOOL_CATALOG = [
8979
10163
  "pattern": "^\\s*[a-z]{2}\\s*$"
8980
10164
  }
8981
10165
  },
8982
- "excludeStateCodes": {
8983
- "description": "State or region codes to leave out.",
10166
+ "excludeJobCountryCodes": {
10167
+ "description": "Job country codes to leave out.",
10168
+ "minItems": 1,
10169
+ "maxItems": 50,
10170
+ "type": "array",
10171
+ "items": {
10172
+ "type": "string",
10173
+ "pattern": "^\\s*[a-z]{2}\\s*$"
10174
+ }
10175
+ },
10176
+ "companyCities": {
10177
+ "description": "Company HQ cities to include. Requires countryCodes.",
8984
10178
  "minItems": 1,
8985
10179
  "maxItems": 50,
8986
10180
  "type": "array",
@@ -8991,8 +10185,8 @@ var TOOL_CATALOG = [
8991
10185
  "pattern": "\\S"
8992
10186
  }
8993
10187
  },
8994
- "excludeIndustries": {
8995
- "description": "Industries to leave out.",
10188
+ "excludeCompanyCities": {
10189
+ "description": "Company HQ cities to leave out. Requires countryCodes.",
8996
10190
  "minItems": 1,
8997
10191
  "maxItems": 50,
8998
10192
  "type": "array",
@@ -9003,52 +10197,72 @@ var TOOL_CATALOG = [
9003
10197
  "pattern": "\\S"
9004
10198
  }
9005
10199
  },
9006
- "employeeCountMin": {
9007
- "description": "Lowest employee count to include.",
10200
+ "companyFoundedYearMin": {
10201
+ "description": "Earliest company founding year.",
9008
10202
  "type": "integer",
9009
10203
  "minimum": 0,
9010
10204
  "maximum": 9007199254740991
9011
10205
  },
9012
- "employeeCountMax": {
9013
- "description": "Highest employee count to include.",
10206
+ "companyFoundedYearMax": {
10207
+ "description": "Latest company founding year.",
9014
10208
  "type": "integer",
9015
10209
  "minimum": 0,
9016
10210
  "maximum": 9007199254740991
9017
10211
  },
9018
- "revenueMinUsd": {
9019
- "description": "Lowest annual revenue to include, in US dollars.",
9020
- "type": "integer",
9021
- "minimum": 0,
9022
- "maximum": 9007199254740991
10212
+ "jobStartDateAfter": {
10213
+ "description": "Include jobs started on or after this date.",
10214
+ "type": "string",
10215
+ "format": "date",
10216
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
9023
10217
  },
9024
- "revenueMaxUsd": {
9025
- "description": "Highest annual revenue to include, in US dollars.",
9026
- "type": "integer",
9027
- "minimum": 0,
9028
- "maximum": 9007199254740991
10218
+ "jobStartDateBefore": {
10219
+ "description": "Include jobs started on or before this date.",
10220
+ "type": "string",
10221
+ "format": "date",
10222
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
9029
10223
  },
9030
- "naics2022Codes": {
9031
- "description": "NAICS 2022 codes to include.",
10224
+ "titleKeywords": {
10225
+ "description": "Job title keywords to match. A person can match any of them.",
9032
10226
  "minItems": 1,
9033
10227
  "maxItems": 50,
9034
10228
  "type": "array",
9035
10229
  "items": {
9036
10230
  "type": "string",
9037
- "pattern": "^[0-9]{6}$"
10231
+ "minLength": 1,
10232
+ "maxLength": 120,
10233
+ "pattern": "\\S"
9038
10234
  }
9039
10235
  },
9040
- "excludeNaics2022Codes": {
9041
- "description": "NAICS 2022 codes to leave out.",
10236
+ "requiredTitleKeywords": {
10237
+ "description": "Job title keywords the person must match.",
9042
10238
  "minItems": 1,
9043
10239
  "maxItems": 50,
9044
10240
  "type": "array",
9045
10241
  "items": {
9046
10242
  "type": "string",
9047
- "pattern": "^[0-9]{6}$"
10243
+ "minLength": 1,
10244
+ "maxLength": 120,
10245
+ "pattern": "\\S"
9048
10246
  }
9049
10247
  },
9050
- "fundingTypes": {
9051
- "description": "Funding round types to include.",
10248
+ "requiredTitleKeywordGroups": {
10249
+ "description": "Job title keyword groups. The person must match every group, and any keyword inside a group.",
10250
+ "maxItems": 10,
10251
+ "type": "array",
10252
+ "items": {
10253
+ "minItems": 1,
10254
+ "maxItems": 50,
10255
+ "type": "array",
10256
+ "items": {
10257
+ "type": "string",
10258
+ "minLength": 1,
10259
+ "maxLength": 120,
10260
+ "pattern": "\\S"
10261
+ }
10262
+ }
10263
+ },
10264
+ "excludeTitleKeywords": {
10265
+ "description": "Job title keywords that remove a person.",
9052
10266
  "minItems": 1,
9053
10267
  "maxItems": 50,
9054
10268
  "type": "array",
@@ -9059,8 +10273,8 @@ var TOOL_CATALOG = [
9059
10273
  "pattern": "\\S"
9060
10274
  }
9061
10275
  },
9062
- "excludeFundingTypes": {
9063
- "description": "Funding round types to leave out.",
10276
+ "jobFunctions": {
10277
+ "description": "Job functions to include.",
9064
10278
  "minItems": 1,
9065
10279
  "maxItems": 50,
9066
10280
  "type": "array",
@@ -9071,8 +10285,8 @@ var TOOL_CATALOG = [
9071
10285
  "pattern": "\\S"
9072
10286
  }
9073
10287
  },
9074
- "keywords": {
9075
- "description": "Keywords to match. A company can match any of them.",
10288
+ "excludeJobFunctions": {
10289
+ "description": "Job functions to leave out.",
9076
10290
  "minItems": 1,
9077
10291
  "maxItems": 50,
9078
10292
  "type": "array",
@@ -9083,8 +10297,8 @@ var TOOL_CATALOG = [
9083
10297
  "pattern": "\\S"
9084
10298
  }
9085
10299
  },
9086
- "requiredKeywords": {
9087
- "description": "Keywords the company must match.",
10300
+ "jobLevels": {
10301
+ "description": "Job levels to include.",
9088
10302
  "minItems": 1,
9089
10303
  "maxItems": 50,
9090
10304
  "type": "array",
@@ -9095,24 +10309,20 @@ var TOOL_CATALOG = [
9095
10309
  "pattern": "\\S"
9096
10310
  }
9097
10311
  },
9098
- "requiredKeywordGroups": {
9099
- "description": "Keyword groups. The company must match every group, and any keyword inside a group.",
9100
- "maxItems": 10,
10312
+ "excludeJobLevels": {
10313
+ "description": "Job levels to leave out.",
10314
+ "minItems": 1,
10315
+ "maxItems": 50,
9101
10316
  "type": "array",
9102
10317
  "items": {
9103
- "minItems": 1,
9104
- "maxItems": 50,
9105
- "type": "array",
9106
- "items": {
9107
- "type": "string",
9108
- "minLength": 1,
9109
- "maxLength": 120,
9110
- "pattern": "\\S"
9111
- }
10318
+ "type": "string",
10319
+ "minLength": 1,
10320
+ "maxLength": 120,
10321
+ "pattern": "\\S"
9112
10322
  }
9113
10323
  },
9114
- "excludeKeywords": {
9115
- "description": "Keywords that remove a company.",
10324
+ "gtmRoleFamilies": {
10325
+ "description": "Go-to-market role families to include.",
9116
10326
  "minItems": 1,
9117
10327
  "maxItems": 50,
9118
10328
  "type": "array",
@@ -9123,8 +10333,24 @@ var TOOL_CATALOG = [
9123
10333
  "pattern": "\\S"
9124
10334
  }
9125
10335
  },
9126
- "websiteAvailability": {
9127
- "description": "Whether the company has a website.",
10336
+ "excludeGtmRoleFamilies": {
10337
+ "description": "Go-to-market role families to leave out.",
10338
+ "minItems": 1,
10339
+ "maxItems": 50,
10340
+ "type": "array",
10341
+ "items": {
10342
+ "type": "string",
10343
+ "minLength": 1,
10344
+ "maxLength": 120,
10345
+ "pattern": "\\S"
10346
+ }
10347
+ },
10348
+ "requireVerifiedEmail": {
10349
+ "description": "When true, only people with a verified work email are returned.",
10350
+ "type": "boolean"
10351
+ },
10352
+ "emailAvailability": {
10353
+ "description": "Whether the person has an email address.",
9128
10354
  "type": "string",
9129
10355
  "enum": [
9130
10356
  "any",
@@ -9132,8 +10358,8 @@ var TOOL_CATALOG = [
9132
10358
  "missing"
9133
10359
  ]
9134
10360
  },
9135
- "linkedinAvailability": {
9136
- "description": "Whether the company has a LinkedIn page.",
10361
+ "phoneAvailability": {
10362
+ "description": "Whether the person has a phone number.",
9137
10363
  "type": "string",
9138
10364
  "enum": [
9139
10365
  "any",
@@ -9141,40 +10367,134 @@ var TOOL_CATALOG = [
9141
10367
  "missing"
9142
10368
  ]
9143
10369
  },
9144
- "fundingDateAfter": {
9145
- "description": "Include funding on or after this date.",
9146
- "type": "string",
9147
- "format": "date",
9148
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
9149
- },
9150
- "fundingDateBefore": {
9151
- "description": "Include funding on or before this date.",
9152
- "type": "string",
9153
- "format": "date",
9154
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
10370
+ "excludePersonIds": {
10371
+ "description": "Opaque person ids (hdp_) to leave out.",
10372
+ "maxItems": 1e3,
10373
+ "type": "array",
10374
+ "items": {
10375
+ "type": "string",
10376
+ "pattern": "^hdp_[0-9a-f]{32}$",
10377
+ "description": "Opaque person id (hdp_)."
10378
+ }
9155
10379
  },
9156
- "excludeOrganizationIds": {
9157
- "description": "Opaque company ids (hdo_) to leave out.",
10380
+ "excludeEmails": {
10381
+ "description": "Email addresses to leave out.",
9158
10382
  "maxItems": 1e3,
9159
10383
  "type": "array",
9160
10384
  "items": {
9161
10385
  "type": "string",
9162
- "pattern": "^hdo_[0-9a-f]{32}$",
9163
- "description": "Opaque company id (hdo_)."
10386
+ "format": "email",
10387
+ "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
9164
10388
  }
9165
10389
  },
9166
- "excludeDomains": {
9167
- "description": "Website domains to leave out.",
9168
- "maxItems": 1e3,
9169
- "type": "array",
9170
- "items": {
9171
- "type": "string",
9172
- "minLength": 1,
9173
- "maxLength": 320
9174
- }
10390
+ "sort": {
10391
+ "description": "Sort by primary company employee estimate, largest or smallest first. Unknown sizes come last. Available from the November 2026 release.",
10392
+ "type": "string",
10393
+ "enum": [
10394
+ "company_size_desc",
10395
+ "company_size_asc"
10396
+ ]
10397
+ },
10398
+ "limit": {
10399
+ "default": 50,
10400
+ "description": "Maximum records in this page. Interactive search accepts at most 50. A download (download true) accepts at most 500.",
10401
+ "type": "integer",
10402
+ "minimum": 1,
10403
+ "maximum": 500
10404
+ },
10405
+ "cursor": {
10406
+ "description": "Cursor from the previous page. Omit it for the first page.",
10407
+ "type": "string",
10408
+ "minLength": 1,
10409
+ "maxLength": 2048
10410
+ },
10411
+ "firstName": {
10412
+ "description": "First name tokens, using accent-folded fuzzy matching. Requires companyId.",
10413
+ "type": "string",
10414
+ "minLength": 1,
10415
+ "maxLength": 120,
10416
+ "pattern": "\\S"
10417
+ },
10418
+ "lastName": {
10419
+ "description": "Last name tokens, using accent-folded fuzzy matching. Requires companyId.",
10420
+ "type": "string",
10421
+ "minLength": 1,
10422
+ "maxLength": 120,
10423
+ "pattern": "\\S"
10424
+ },
10425
+ "companyId": {
10426
+ "description": "Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters.",
10427
+ "type": "string",
10428
+ "pattern": "^hdo_[0-9a-f]{32}$"
10429
+ },
10430
+ "contactLocation": {
10431
+ "description": "Contact location filters. Requires companyId.",
10432
+ "type": "object",
10433
+ "properties": {
10434
+ "countryCodes": {
10435
+ "description": "Person or job location country codes.",
10436
+ "minItems": 1,
10437
+ "maxItems": 50,
10438
+ "type": "array",
10439
+ "items": {
10440
+ "type": "string",
10441
+ "pattern": "^\\s*[a-z]{2}\\s*$"
10442
+ }
10443
+ },
10444
+ "stateCodes": {
10445
+ "description": "Person or job location state codes.",
10446
+ "minItems": 1,
10447
+ "maxItems": 50,
10448
+ "type": "array",
10449
+ "items": {
10450
+ "type": "string",
10451
+ "minLength": 1,
10452
+ "maxLength": 120,
10453
+ "pattern": "\\S"
10454
+ }
10455
+ },
10456
+ "cities": {
10457
+ "description": "Person or job location cities.",
10458
+ "minItems": 1,
10459
+ "maxItems": 50,
10460
+ "type": "array",
10461
+ "items": {
10462
+ "type": "string",
10463
+ "minLength": 1,
10464
+ "maxLength": 120,
10465
+ "pattern": "\\S"
10466
+ }
10467
+ }
10468
+ },
10469
+ "additionalProperties": false
10470
+ },
10471
+ "excludeListId": {
10472
+ "description": "Ignore one suppression list for this call only, tenant owner only. Allowed kinds: customers, open_deals, competitors, partners, employees, custom. Do not contact, opt-out and global erasure rules cannot be lifted.",
10473
+ "type": "string",
10474
+ "format": "uuid",
10475
+ "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
9175
10476
  },
9176
- "personNames": {
9177
- "description": "Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents.",
10477
+ "download": {
10478
+ "description": "Set true to download a page. Interactive search stays at 50 records. The server reads this flag from the request, not from a plan or role.",
10479
+ "type": "boolean"
10480
+ }
10481
+ },
10482
+ "additionalProperties": false
10483
+ }
10484
+ },
10485
+ {
10486
+ "name": "search.preview_company_count",
10487
+ "description": "Cheap live company count from the release rollup only, before suppression. Refinements not covered by the rollup produce a baseline.",
10488
+ "risk": "read",
10489
+ "scopes": [
10490
+ "data:read"
10491
+ ],
10492
+ "input": {
10493
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
10494
+ "type": "object",
10495
+ "properties": {
10496
+ "companyNames": {
10497
+ "description": "Company name prefixes. Match any name.",
9178
10498
  "minItems": 1,
9179
10499
  "maxItems": 5,
9180
10500
  "type": "array",
@@ -9185,17 +10505,10 @@ var TOOL_CATALOG = [
9185
10505
  "pattern": "\\S"
9186
10506
  }
9187
10507
  },
9188
- "email": {
9189
- "description": "Exact work email address, matched through the email index.",
9190
- "type": "string",
9191
- "maxLength": 320,
9192
- "format": "email",
9193
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
9194
- },
9195
- "personCities": {
9196
- "description": "Person cities to include. Requires personCountryCodes.",
10508
+ "excludeCompanyNames": {
10509
+ "description": "Company name prefixes to leave out.",
9197
10510
  "minItems": 1,
9198
- "maxItems": 50,
10511
+ "maxItems": 5,
9199
10512
  "type": "array",
9200
10513
  "items": {
9201
10514
  "type": "string",
@@ -9204,20 +10517,24 @@ var TOOL_CATALOG = [
9204
10517
  "pattern": "\\S"
9205
10518
  }
9206
10519
  },
9207
- "excludePersonCities": {
9208
- "description": "Person cities to leave out. Requires personCountryCodes.",
10520
+ "domain": {
10521
+ "description": "Company website domain. Exact host matching; root sites rank first.",
10522
+ "type": "string",
10523
+ "minLength": 1,
10524
+ "maxLength": 320
10525
+ },
10526
+ "countryCodes": {
10527
+ "description": "Two-letter country codes to include.",
9209
10528
  "minItems": 1,
9210
10529
  "maxItems": 50,
9211
10530
  "type": "array",
9212
10531
  "items": {
9213
10532
  "type": "string",
9214
- "minLength": 1,
9215
- "maxLength": 120,
9216
- "pattern": "\\S"
10533
+ "pattern": "^\\s*[a-z]{2}\\s*$"
9217
10534
  }
9218
10535
  },
9219
- "personStateCodes": {
9220
- "description": "Person state or region codes to include.",
10536
+ "stateCodes": {
10537
+ "description": "State or region codes to include.",
9221
10538
  "minItems": 1,
9222
10539
  "maxItems": 50,
9223
10540
  "type": "array",
@@ -9228,8 +10545,8 @@ var TOOL_CATALOG = [
9228
10545
  "pattern": "\\S"
9229
10546
  }
9230
10547
  },
9231
- "excludePersonStateCodes": {
9232
- "description": "Person state or region codes to leave out.",
10548
+ "cities": {
10549
+ "description": "Company HQ cities to include. Requires countryCodes.",
9233
10550
  "minItems": 1,
9234
10551
  "maxItems": 50,
9235
10552
  "type": "array",
@@ -9240,28 +10557,8 @@ var TOOL_CATALOG = [
9240
10557
  "pattern": "\\S"
9241
10558
  }
9242
10559
  },
9243
- "personCountryCodes": {
9244
- "description": "Person country codes to include.",
9245
- "minItems": 1,
9246
- "maxItems": 50,
9247
- "type": "array",
9248
- "items": {
9249
- "type": "string",
9250
- "pattern": "^\\s*[a-z]{2}\\s*$"
9251
- }
9252
- },
9253
- "excludePersonCountryCodes": {
9254
- "description": "Person country codes to leave out.",
9255
- "minItems": 1,
9256
- "maxItems": 50,
9257
- "type": "array",
9258
- "items": {
9259
- "type": "string",
9260
- "pattern": "^\\s*[a-z]{2}\\s*$"
9261
- }
9262
- },
9263
- "jobCities": {
9264
- "description": "Job cities to include. Requires jobCountryCodes.",
10560
+ "excludeCities": {
10561
+ "description": "Company HQ cities to leave out. Requires countryCodes.",
9265
10562
  "minItems": 1,
9266
10563
  "maxItems": 50,
9267
10564
  "type": "array",
@@ -9272,8 +10569,8 @@ var TOOL_CATALOG = [
9272
10569
  "pattern": "\\S"
9273
10570
  }
9274
10571
  },
9275
- "excludeJobCities": {
9276
- "description": "Job cities to leave out. Requires jobCountryCodes.",
10572
+ "postcodes": {
10573
+ "description": "Company HQ postcode prefixes to include.",
9277
10574
  "minItems": 1,
9278
10575
  "maxItems": 50,
9279
10576
  "type": "array",
@@ -9284,8 +10581,8 @@ var TOOL_CATALOG = [
9284
10581
  "pattern": "\\S"
9285
10582
  }
9286
10583
  },
9287
- "jobStateCodes": {
9288
- "description": "Job state or region codes to include.",
10584
+ "excludePostcodes": {
10585
+ "description": "Company HQ postcode prefixes to leave out.",
9289
10586
  "minItems": 1,
9290
10587
  "maxItems": 50,
9291
10588
  "type": "array",
@@ -9296,8 +10593,32 @@ var TOOL_CATALOG = [
9296
10593
  "pattern": "\\S"
9297
10594
  }
9298
10595
  },
9299
- "excludeJobStateCodes": {
9300
- "description": "Job state or region codes to leave out.",
10596
+ "foundedYearMin": {
10597
+ "description": "Earliest company founding year.",
10598
+ "type": "integer",
10599
+ "minimum": 0,
10600
+ "maximum": 9007199254740991
10601
+ },
10602
+ "foundedYearMax": {
10603
+ "description": "Latest company founding year.",
10604
+ "type": "integer",
10605
+ "minimum": 0,
10606
+ "maximum": 9007199254740991
10607
+ },
10608
+ "totalFundingMinUsd": {
10609
+ "description": "Lowest total company funding, in US dollars.",
10610
+ "type": "integer",
10611
+ "minimum": 0,
10612
+ "maximum": 9007199254740991
10613
+ },
10614
+ "totalFundingMaxUsd": {
10615
+ "description": "Highest total company funding, in US dollars.",
10616
+ "type": "integer",
10617
+ "minimum": 0,
10618
+ "maximum": 9007199254740991
10619
+ },
10620
+ "industries": {
10621
+ "description": "Industries to include.",
9301
10622
  "minItems": 1,
9302
10623
  "maxItems": 50,
9303
10624
  "type": "array",
@@ -9308,18 +10629,8 @@ var TOOL_CATALOG = [
9308
10629
  "pattern": "\\S"
9309
10630
  }
9310
10631
  },
9311
- "jobCountryCodes": {
9312
- "description": "Job country codes to include.",
9313
- "minItems": 1,
9314
- "maxItems": 50,
9315
- "type": "array",
9316
- "items": {
9317
- "type": "string",
9318
- "pattern": "^\\s*[a-z]{2}\\s*$"
9319
- }
9320
- },
9321
- "excludeJobCountryCodes": {
9322
- "description": "Job country codes to leave out.",
10632
+ "excludeCountryCodes": {
10633
+ "description": "Two-letter country codes to leave out.",
9323
10634
  "minItems": 1,
9324
10635
  "maxItems": 50,
9325
10636
  "type": "array",
@@ -9328,8 +10639,8 @@ var TOOL_CATALOG = [
9328
10639
  "pattern": "^\\s*[a-z]{2}\\s*$"
9329
10640
  }
9330
10641
  },
9331
- "companyCities": {
9332
- "description": "Company HQ cities to include. Requires countryCodes.",
10642
+ "excludeStateCodes": {
10643
+ "description": "State or region codes to leave out.",
9333
10644
  "minItems": 1,
9334
10645
  "maxItems": 50,
9335
10646
  "type": "array",
@@ -9340,8 +10651,8 @@ var TOOL_CATALOG = [
9340
10651
  "pattern": "\\S"
9341
10652
  }
9342
10653
  },
9343
- "excludeCompanyCities": {
9344
- "description": "Company HQ cities to leave out. Requires countryCodes.",
10654
+ "excludeIndustries": {
10655
+ "description": "Industries to leave out.",
9345
10656
  "minItems": 1,
9346
10657
  "maxItems": 50,
9347
10658
  "type": "array",
@@ -9352,96 +10663,52 @@ var TOOL_CATALOG = [
9352
10663
  "pattern": "\\S"
9353
10664
  }
9354
10665
  },
9355
- "companyFoundedYearMin": {
9356
- "description": "Earliest company founding year.",
10666
+ "employeeCountMin": {
10667
+ "description": "Lowest employee count to include.",
9357
10668
  "type": "integer",
9358
10669
  "minimum": 0,
9359
10670
  "maximum": 9007199254740991
9360
10671
  },
9361
- "companyFoundedYearMax": {
9362
- "description": "Latest company founding year.",
10672
+ "employeeCountMax": {
10673
+ "description": "Highest employee count to include.",
9363
10674
  "type": "integer",
9364
10675
  "minimum": 0,
9365
10676
  "maximum": 9007199254740991
9366
10677
  },
9367
- "jobStartDateAfter": {
9368
- "description": "Include jobs started on or after this date.",
9369
- "type": "string",
9370
- "format": "date",
9371
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
9372
- },
9373
- "jobStartDateBefore": {
9374
- "description": "Include jobs started on or before this date.",
9375
- "type": "string",
9376
- "format": "date",
9377
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
9378
- },
9379
- "titleKeywords": {
9380
- "description": "Job title keywords to match. A person can match any of them.",
9381
- "minItems": 1,
9382
- "maxItems": 50,
9383
- "type": "array",
9384
- "items": {
9385
- "type": "string",
9386
- "minLength": 1,
9387
- "maxLength": 120,
9388
- "pattern": "\\S"
9389
- }
9390
- },
9391
- "requiredTitleKeywords": {
9392
- "description": "Job title keywords the person must match.",
9393
- "minItems": 1,
9394
- "maxItems": 50,
9395
- "type": "array",
9396
- "items": {
9397
- "type": "string",
9398
- "minLength": 1,
9399
- "maxLength": 120,
9400
- "pattern": "\\S"
9401
- }
10678
+ "revenueMinUsd": {
10679
+ "description": "Lowest annual revenue to include, in US dollars.",
10680
+ "type": "integer",
10681
+ "minimum": 0,
10682
+ "maximum": 9007199254740991
9402
10683
  },
9403
- "requiredTitleKeywordGroups": {
9404
- "description": "Job title keyword groups. The person must match every group, and any keyword inside a group.",
9405
- "maxItems": 10,
9406
- "type": "array",
9407
- "items": {
9408
- "minItems": 1,
9409
- "maxItems": 50,
9410
- "type": "array",
9411
- "items": {
9412
- "type": "string",
9413
- "minLength": 1,
9414
- "maxLength": 120,
9415
- "pattern": "\\S"
9416
- }
9417
- }
10684
+ "revenueMaxUsd": {
10685
+ "description": "Highest annual revenue to include, in US dollars.",
10686
+ "type": "integer",
10687
+ "minimum": 0,
10688
+ "maximum": 9007199254740991
9418
10689
  },
9419
- "excludeTitleKeywords": {
9420
- "description": "Job title keywords that remove a person.",
10690
+ "naics2022Codes": {
10691
+ "description": "NAICS 2022 codes to include.",
9421
10692
  "minItems": 1,
9422
10693
  "maxItems": 50,
9423
10694
  "type": "array",
9424
10695
  "items": {
9425
10696
  "type": "string",
9426
- "minLength": 1,
9427
- "maxLength": 120,
9428
- "pattern": "\\S"
10697
+ "pattern": "^[0-9]{6}$"
9429
10698
  }
9430
10699
  },
9431
- "jobFunctions": {
9432
- "description": "Job functions to include.",
10700
+ "excludeNaics2022Codes": {
10701
+ "description": "NAICS 2022 codes to leave out.",
9433
10702
  "minItems": 1,
9434
10703
  "maxItems": 50,
9435
10704
  "type": "array",
9436
10705
  "items": {
9437
10706
  "type": "string",
9438
- "minLength": 1,
9439
- "maxLength": 120,
9440
- "pattern": "\\S"
10707
+ "pattern": "^[0-9]{6}$"
9441
10708
  }
9442
10709
  },
9443
- "excludeJobFunctions": {
9444
- "description": "Job functions to leave out.",
10710
+ "fundingTypes": {
10711
+ "description": "Funding round types to include.",
9445
10712
  "minItems": 1,
9446
10713
  "maxItems": 50,
9447
10714
  "type": "array",
@@ -9452,8 +10719,8 @@ var TOOL_CATALOG = [
9452
10719
  "pattern": "\\S"
9453
10720
  }
9454
10721
  },
9455
- "jobLevels": {
9456
- "description": "Job levels to include.",
10722
+ "excludeFundingTypes": {
10723
+ "description": "Funding round types to leave out.",
9457
10724
  "minItems": 1,
9458
10725
  "maxItems": 50,
9459
10726
  "type": "array",
@@ -9464,8 +10731,8 @@ var TOOL_CATALOG = [
9464
10731
  "pattern": "\\S"
9465
10732
  }
9466
10733
  },
9467
- "excludeJobLevels": {
9468
- "description": "Job levels to leave out.",
10734
+ "keywords": {
10735
+ "description": "Keywords to match. A company can match any of them.",
9469
10736
  "minItems": 1,
9470
10737
  "maxItems": 50,
9471
10738
  "type": "array",
@@ -9476,8 +10743,8 @@ var TOOL_CATALOG = [
9476
10743
  "pattern": "\\S"
9477
10744
  }
9478
10745
  },
9479
- "gtmRoleFamilies": {
9480
- "description": "Go-to-market role families to include.",
10746
+ "requiredKeywords": {
10747
+ "description": "Keywords the company must match.",
9481
10748
  "minItems": 1,
9482
10749
  "maxItems": 50,
9483
10750
  "type": "array",
@@ -9488,8 +10755,24 @@ var TOOL_CATALOG = [
9488
10755
  "pattern": "\\S"
9489
10756
  }
9490
10757
  },
9491
- "excludeGtmRoleFamilies": {
9492
- "description": "Go-to-market role families to leave out.",
10758
+ "requiredKeywordGroups": {
10759
+ "description": "Keyword groups. The company must match every group, and any keyword inside a group.",
10760
+ "maxItems": 10,
10761
+ "type": "array",
10762
+ "items": {
10763
+ "minItems": 1,
10764
+ "maxItems": 50,
10765
+ "type": "array",
10766
+ "items": {
10767
+ "type": "string",
10768
+ "minLength": 1,
10769
+ "maxLength": 120,
10770
+ "pattern": "\\S"
10771
+ }
10772
+ }
10773
+ },
10774
+ "excludeKeywords": {
10775
+ "description": "Keywords that remove a company.",
9493
10776
  "minItems": 1,
9494
10777
  "maxItems": 50,
9495
10778
  "type": "array",
@@ -9500,12 +10783,8 @@ var TOOL_CATALOG = [
9500
10783
  "pattern": "\\S"
9501
10784
  }
9502
10785
  },
9503
- "requireVerifiedEmail": {
9504
- "description": "When true, only people with a verified work email are returned.",
9505
- "type": "boolean"
9506
- },
9507
- "emailAvailability": {
9508
- "description": "Whether the person has an email address.",
10786
+ "websiteAvailability": {
10787
+ "description": "Whether the company has a website.",
9509
10788
  "type": "string",
9510
10789
  "enum": [
9511
10790
  "any",
@@ -9513,8 +10792,8 @@ var TOOL_CATALOG = [
9513
10792
  "missing"
9514
10793
  ]
9515
10794
  },
9516
- "phoneAvailability": {
9517
- "description": "Whether the person has a phone number.",
10795
+ "linkedinAvailability": {
10796
+ "description": "Whether the company has a LinkedIn page.",
9518
10797
  "type": "string",
9519
10798
  "enum": [
9520
10799
  "any",
@@ -9522,90 +10801,718 @@ var TOOL_CATALOG = [
9522
10801
  "missing"
9523
10802
  ]
9524
10803
  },
9525
- "excludePersonIds": {
9526
- "description": "Opaque person ids (hdp_) to leave out.",
10804
+ "fundingDateAfter": {
10805
+ "description": "Include funding on or after this date.",
10806
+ "type": "string",
10807
+ "format": "date",
10808
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
10809
+ },
10810
+ "fundingDateBefore": {
10811
+ "description": "Include funding on or before this date.",
10812
+ "type": "string",
10813
+ "format": "date",
10814
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
10815
+ },
10816
+ "excludeOrganizationIds": {
10817
+ "description": "Opaque company ids (hdo_) to leave out.",
9527
10818
  "maxItems": 1e3,
9528
10819
  "type": "array",
9529
10820
  "items": {
9530
10821
  "type": "string",
9531
- "pattern": "^hdp_[0-9a-f]{32}$",
9532
- "description": "Opaque person id (hdp_)."
10822
+ "pattern": "^hdo_[0-9a-f]{32}$",
10823
+ "description": "Opaque company id (hdo_)."
9533
10824
  }
9534
10825
  },
9535
- "excludeEmails": {
9536
- "description": "Email addresses to leave out.",
10826
+ "excludeDomains": {
10827
+ "description": "Website domains to leave out.",
9537
10828
  "maxItems": 1e3,
9538
10829
  "type": "array",
9539
10830
  "items": {
9540
10831
  "type": "string",
9541
- "format": "email",
9542
- "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
10832
+ "minLength": 1,
10833
+ "maxLength": 320
9543
10834
  }
9544
10835
  },
9545
- "limit": {
9546
- "default": 50,
9547
- "description": "Maximum records in this page.",
9548
- "type": "integer",
9549
- "minimum": 1,
9550
- "maximum": 50
9551
- },
9552
- "cursor": {
9553
- "description": "Cursor from the previous page. Omit it for the first page.",
9554
- "type": "string",
9555
- "minLength": 1,
9556
- "maxLength": 2048
9557
- },
9558
- "companyId": {
9559
- "description": "Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters.",
9560
- "type": "string",
9561
- "pattern": "^hdo_[0-9a-f]{32}$"
9562
- },
9563
- "contactLocation": {
9564
- "description": "Contact location filters. Requires companyId.",
10836
+ "insights": {
10837
+ "description": "Insights filters. Supply at least one.",
9565
10838
  "type": "object",
9566
10839
  "properties": {
9567
- "countryCodes": {
9568
- "description": "Person or job location country codes.",
10840
+ "monthlyOrganicTraffic": {
10841
+ "description": "Monthly organic visits.",
10842
+ "type": "object",
10843
+ "properties": {
10844
+ "min": {
10845
+ "description": "Lower bound, inclusive.",
10846
+ "type": "number",
10847
+ "minimum": 0
10848
+ },
10849
+ "max": {
10850
+ "description": "Upper bound, inclusive.",
10851
+ "type": "number",
10852
+ "minimum": 0
10853
+ }
10854
+ },
10855
+ "additionalProperties": false
10856
+ },
10857
+ "monthlyPaidTraffic": {
10858
+ "description": "Monthly paid visits.",
10859
+ "type": "object",
10860
+ "properties": {
10861
+ "min": {
10862
+ "description": "Lower bound, inclusive.",
10863
+ "type": "number",
10864
+ "minimum": 0
10865
+ },
10866
+ "max": {
10867
+ "description": "Upper bound, inclusive.",
10868
+ "type": "number",
10869
+ "minimum": 0
10870
+ }
10871
+ },
10872
+ "additionalProperties": false
10873
+ },
10874
+ "totalMonthlyTraffic": {
10875
+ "description": "Monthly visits, organic and paid.",
10876
+ "type": "object",
10877
+ "properties": {
10878
+ "min": {
10879
+ "description": "Lower bound, inclusive.",
10880
+ "type": "number",
10881
+ "minimum": 0
10882
+ },
10883
+ "max": {
10884
+ "description": "Upper bound, inclusive.",
10885
+ "type": "number",
10886
+ "minimum": 0
10887
+ }
10888
+ },
10889
+ "additionalProperties": false
10890
+ },
10891
+ "monthlyGoogleAdSpendCents": {
10892
+ "description": "Monthly Google ad spend, in cents.",
10893
+ "type": "object",
10894
+ "properties": {
10895
+ "min": {
10896
+ "description": "Lower bound, inclusive, in cents.",
10897
+ "type": "integer",
10898
+ "minimum": 0,
10899
+ "maximum": 9007199254740991
10900
+ },
10901
+ "max": {
10902
+ "description": "Upper bound, inclusive, in cents.",
10903
+ "type": "integer",
10904
+ "minimum": 0,
10905
+ "maximum": 9007199254740991
10906
+ }
10907
+ },
10908
+ "additionalProperties": false
10909
+ },
10910
+ "lastFundingAmountCents": {
10911
+ "description": "Latest funding round amount, in cents.",
10912
+ "type": "object",
10913
+ "properties": {
10914
+ "min": {
10915
+ "description": "Lower bound, inclusive, in cents.",
10916
+ "type": "integer",
10917
+ "minimum": 0,
10918
+ "maximum": 9007199254740991
10919
+ },
10920
+ "max": {
10921
+ "description": "Upper bound, inclusive, in cents.",
10922
+ "type": "integer",
10923
+ "minimum": 0,
10924
+ "maximum": 9007199254740991
10925
+ }
10926
+ },
10927
+ "additionalProperties": false
10928
+ },
10929
+ "totalFundingAmountCents": {
10930
+ "description": "Total funding raised, in cents.",
10931
+ "type": "object",
10932
+ "properties": {
10933
+ "min": {
10934
+ "description": "Lower bound, inclusive, in cents.",
10935
+ "type": "integer",
10936
+ "minimum": 0,
10937
+ "maximum": 9007199254740991
10938
+ },
10939
+ "max": {
10940
+ "description": "Upper bound, inclusive, in cents.",
10941
+ "type": "integer",
10942
+ "minimum": 0,
10943
+ "maximum": 9007199254740991
10944
+ }
10945
+ },
10946
+ "additionalProperties": false
10947
+ },
10948
+ "employeeGrowthRate": {
10949
+ "description": "Employee growth rate, as reported in the release. Negative values include shrinking teams.",
10950
+ "type": "object",
10951
+ "properties": {
10952
+ "min": {
10953
+ "description": "Lower bound, inclusive, for the reported growth rate.",
10954
+ "type": "number"
10955
+ },
10956
+ "max": {
10957
+ "description": "Upper bound, inclusive, for the reported growth rate.",
10958
+ "type": "number"
10959
+ }
10960
+ },
10961
+ "additionalProperties": false
10962
+ },
10963
+ "accountExecutiveOpenRoles": {
10964
+ "description": "Account executive open roles.",
10965
+ "type": "object",
10966
+ "properties": {
10967
+ "min": {
10968
+ "description": "Minimum open roles, inclusive.",
10969
+ "type": "integer",
10970
+ "minimum": 0,
10971
+ "maximum": 9007199254740991
10972
+ },
10973
+ "max": {
10974
+ "description": "Maximum open roles, inclusive.",
10975
+ "type": "integer",
10976
+ "minimum": 0,
10977
+ "maximum": 9007199254740991
10978
+ }
10979
+ },
10980
+ "additionalProperties": false
10981
+ },
10982
+ "businessDevelopmentOpenRoles": {
10983
+ "description": "Business development open roles.",
10984
+ "type": "object",
10985
+ "properties": {
10986
+ "min": {
10987
+ "description": "Minimum open roles, inclusive.",
10988
+ "type": "integer",
10989
+ "minimum": 0,
10990
+ "maximum": 9007199254740991
10991
+ },
10992
+ "max": {
10993
+ "description": "Maximum open roles, inclusive.",
10994
+ "type": "integer",
10995
+ "minimum": 0,
10996
+ "maximum": 9007199254740991
10997
+ }
10998
+ },
10999
+ "additionalProperties": false
11000
+ },
11001
+ "customerSuccessOpenRoles": {
11002
+ "description": "Customer success open roles.",
11003
+ "type": "object",
11004
+ "properties": {
11005
+ "min": {
11006
+ "description": "Minimum open roles, inclusive.",
11007
+ "type": "integer",
11008
+ "minimum": 0,
11009
+ "maximum": 9007199254740991
11010
+ },
11011
+ "max": {
11012
+ "description": "Maximum open roles, inclusive.",
11013
+ "type": "integer",
11014
+ "minimum": 0,
11015
+ "maximum": 9007199254740991
11016
+ }
11017
+ },
11018
+ "additionalProperties": false
11019
+ },
11020
+ "demandGenerationOpenRoles": {
11021
+ "description": "Demand generation open roles.",
11022
+ "type": "object",
11023
+ "properties": {
11024
+ "min": {
11025
+ "description": "Minimum open roles, inclusive.",
11026
+ "type": "integer",
11027
+ "minimum": 0,
11028
+ "maximum": 9007199254740991
11029
+ },
11030
+ "max": {
11031
+ "description": "Maximum open roles, inclusive.",
11032
+ "type": "integer",
11033
+ "minimum": 0,
11034
+ "maximum": 9007199254740991
11035
+ }
11036
+ },
11037
+ "additionalProperties": false
11038
+ },
11039
+ "devopsOpenRoles": {
11040
+ "description": "DevOps open roles.",
11041
+ "type": "object",
11042
+ "properties": {
11043
+ "min": {
11044
+ "description": "Minimum open roles, inclusive.",
11045
+ "type": "integer",
11046
+ "minimum": 0,
11047
+ "maximum": 9007199254740991
11048
+ },
11049
+ "max": {
11050
+ "description": "Maximum open roles, inclusive.",
11051
+ "type": "integer",
11052
+ "minimum": 0,
11053
+ "maximum": 9007199254740991
11054
+ }
11055
+ },
11056
+ "additionalProperties": false
11057
+ },
11058
+ "grcOpenRoles": {
11059
+ "description": "Governance, risk and compliance open roles.",
11060
+ "type": "object",
11061
+ "properties": {
11062
+ "min": {
11063
+ "description": "Minimum open roles, inclusive.",
11064
+ "type": "integer",
11065
+ "minimum": 0,
11066
+ "maximum": 9007199254740991
11067
+ },
11068
+ "max": {
11069
+ "description": "Maximum open roles, inclusive.",
11070
+ "type": "integer",
11071
+ "minimum": 0,
11072
+ "maximum": 9007199254740991
11073
+ }
11074
+ },
11075
+ "additionalProperties": false
11076
+ },
11077
+ "itOpenRoles": {
11078
+ "description": "IT open roles.",
11079
+ "type": "object",
11080
+ "properties": {
11081
+ "min": {
11082
+ "description": "Minimum open roles, inclusive.",
11083
+ "type": "integer",
11084
+ "minimum": 0,
11085
+ "maximum": 9007199254740991
11086
+ },
11087
+ "max": {
11088
+ "description": "Maximum open roles, inclusive.",
11089
+ "type": "integer",
11090
+ "minimum": 0,
11091
+ "maximum": 9007199254740991
11092
+ }
11093
+ },
11094
+ "additionalProperties": false
11095
+ },
11096
+ "marketingOpenRoles": {
11097
+ "description": "Marketing open roles.",
11098
+ "type": "object",
11099
+ "properties": {
11100
+ "min": {
11101
+ "description": "Minimum open roles, inclusive.",
11102
+ "type": "integer",
11103
+ "minimum": 0,
11104
+ "maximum": 9007199254740991
11105
+ },
11106
+ "max": {
11107
+ "description": "Maximum open roles, inclusive.",
11108
+ "type": "integer",
11109
+ "minimum": 0,
11110
+ "maximum": 9007199254740991
11111
+ }
11112
+ },
11113
+ "additionalProperties": false
11114
+ },
11115
+ "networkInfrastructureOpenRoles": {
11116
+ "description": "Network infrastructure open roles.",
11117
+ "type": "object",
11118
+ "properties": {
11119
+ "min": {
11120
+ "description": "Minimum open roles, inclusive.",
11121
+ "type": "integer",
11122
+ "minimum": 0,
11123
+ "maximum": 9007199254740991
11124
+ },
11125
+ "max": {
11126
+ "description": "Maximum open roles, inclusive.",
11127
+ "type": "integer",
11128
+ "minimum": 0,
11129
+ "maximum": 9007199254740991
11130
+ }
11131
+ },
11132
+ "additionalProperties": false
11133
+ },
11134
+ "operationsOpenRoles": {
11135
+ "description": "Operations open roles.",
11136
+ "type": "object",
11137
+ "properties": {
11138
+ "min": {
11139
+ "description": "Minimum open roles, inclusive.",
11140
+ "type": "integer",
11141
+ "minimum": 0,
11142
+ "maximum": 9007199254740991
11143
+ },
11144
+ "max": {
11145
+ "description": "Maximum open roles, inclusive.",
11146
+ "type": "integer",
11147
+ "minimum": 0,
11148
+ "maximum": 9007199254740991
11149
+ }
11150
+ },
11151
+ "additionalProperties": false
11152
+ },
11153
+ "salesOpenRoles": {
11154
+ "description": "Sales open roles.",
11155
+ "type": "object",
11156
+ "properties": {
11157
+ "min": {
11158
+ "description": "Minimum open roles, inclusive.",
11159
+ "type": "integer",
11160
+ "minimum": 0,
11161
+ "maximum": 9007199254740991
11162
+ },
11163
+ "max": {
11164
+ "description": "Maximum open roles, inclusive.",
11165
+ "type": "integer",
11166
+ "minimum": 0,
11167
+ "maximum": 9007199254740991
11168
+ }
11169
+ },
11170
+ "additionalProperties": false
11171
+ },
11172
+ "securityOpenRoles": {
11173
+ "description": "Security open roles.",
11174
+ "type": "object",
11175
+ "properties": {
11176
+ "min": {
11177
+ "description": "Minimum open roles, inclusive.",
11178
+ "type": "integer",
11179
+ "minimum": 0,
11180
+ "maximum": 9007199254740991
11181
+ },
11182
+ "max": {
11183
+ "description": "Maximum open roles, inclusive.",
11184
+ "type": "integer",
11185
+ "minimum": 0,
11186
+ "maximum": 9007199254740991
11187
+ }
11188
+ },
11189
+ "additionalProperties": false
11190
+ },
11191
+ "appStoreRating": {
11192
+ "description": "Apple App Store rating, from 0 to 5.",
11193
+ "type": "object",
11194
+ "properties": {
11195
+ "min": {
11196
+ "description": "Minimum rating, inclusive, from 0 to 5.",
11197
+ "type": "number",
11198
+ "minimum": 0,
11199
+ "maximum": 5
11200
+ },
11201
+ "max": {
11202
+ "description": "Maximum rating, inclusive, from 0 to 5.",
11203
+ "type": "number",
11204
+ "minimum": 0,
11205
+ "maximum": 5
11206
+ }
11207
+ },
11208
+ "additionalProperties": false
11209
+ },
11210
+ "playStoreRating": {
11211
+ "description": "Google Play rating, from 0 to 5.",
11212
+ "type": "object",
11213
+ "properties": {
11214
+ "min": {
11215
+ "description": "Minimum rating, inclusive, from 0 to 5.",
11216
+ "type": "number",
11217
+ "minimum": 0,
11218
+ "maximum": 5
11219
+ },
11220
+ "max": {
11221
+ "description": "Maximum rating, inclusive, from 0 to 5.",
11222
+ "type": "number",
11223
+ "minimum": 0,
11224
+ "maximum": 5
11225
+ }
11226
+ },
11227
+ "additionalProperties": false
11228
+ },
11229
+ "crmTechnology": {
11230
+ "description": "CRM product names. Match any reported product, ignoring case and surrounding spaces.",
11231
+ "minItems": 1,
11232
+ "maxItems": 100,
11233
+ "type": "array",
11234
+ "items": {
11235
+ "type": "string",
11236
+ "minLength": 1,
11237
+ "maxLength": 200
11238
+ }
11239
+ },
11240
+ "excludeCrmTechnology": {
11241
+ "description": "Exclude CRM product names. Companies with no reported product remain included.",
11242
+ "minItems": 1,
11243
+ "maxItems": 100,
11244
+ "type": "array",
11245
+ "items": {
11246
+ "type": "string",
11247
+ "minLength": 1,
11248
+ "maxLength": 200
11249
+ }
11250
+ },
11251
+ "marketingAutomationTechnology": {
11252
+ "description": "Marketing automation product names. Match any reported product, ignoring case and surrounding spaces.",
11253
+ "minItems": 1,
11254
+ "maxItems": 100,
11255
+ "type": "array",
11256
+ "items": {
11257
+ "type": "string",
11258
+ "minLength": 1,
11259
+ "maxLength": 200
11260
+ }
11261
+ },
11262
+ "excludeMarketingAutomationTechnology": {
11263
+ "description": "Exclude Marketing automation product names. Companies with no reported product remain included.",
11264
+ "minItems": 1,
11265
+ "maxItems": 100,
11266
+ "type": "array",
11267
+ "items": {
11268
+ "type": "string",
11269
+ "minLength": 1,
11270
+ "maxLength": 200
11271
+ }
11272
+ },
11273
+ "abmTechnology": {
11274
+ "description": "ABM product names. Match any reported product, ignoring case and surrounding spaces.",
9569
11275
  "minItems": 1,
9570
- "maxItems": 50,
11276
+ "maxItems": 100,
9571
11277
  "type": "array",
9572
11278
  "items": {
9573
11279
  "type": "string",
9574
- "pattern": "^\\s*[a-z]{2}\\s*$"
11280
+ "minLength": 1,
11281
+ "maxLength": 200
9575
11282
  }
9576
11283
  },
9577
- "stateCodes": {
9578
- "description": "Person or job location state codes.",
11284
+ "excludeAbmTechnology": {
11285
+ "description": "Exclude ABM product names. Companies with no reported product remain included.",
9579
11286
  "minItems": 1,
9580
- "maxItems": 50,
11287
+ "maxItems": 100,
9581
11288
  "type": "array",
9582
11289
  "items": {
9583
11290
  "type": "string",
9584
11291
  "minLength": 1,
9585
- "maxLength": 120,
9586
- "pattern": "\\S"
11292
+ "maxLength": 200
9587
11293
  }
9588
11294
  },
9589
- "cities": {
9590
- "description": "Person or job location cities.",
11295
+ "salesAutomationTechnology": {
11296
+ "description": "Sales automation product names. Match any reported product, ignoring case and surrounding spaces.",
9591
11297
  "minItems": 1,
9592
- "maxItems": 50,
11298
+ "maxItems": 100,
9593
11299
  "type": "array",
9594
11300
  "items": {
9595
11301
  "type": "string",
9596
11302
  "minLength": 1,
9597
- "maxLength": 120,
9598
- "pattern": "\\S"
11303
+ "maxLength": 200
11304
+ }
11305
+ },
11306
+ "excludeSalesAutomationTechnology": {
11307
+ "description": "Exclude Sales automation product names. Companies with no reported product remain included.",
11308
+ "minItems": 1,
11309
+ "maxItems": 100,
11310
+ "type": "array",
11311
+ "items": {
11312
+ "type": "string",
11313
+ "minLength": 1,
11314
+ "maxLength": 200
11315
+ }
11316
+ },
11317
+ "analyticsTechnology": {
11318
+ "description": "Analytics product names. Match any reported product, ignoring case and surrounding spaces.",
11319
+ "minItems": 1,
11320
+ "maxItems": 100,
11321
+ "type": "array",
11322
+ "items": {
11323
+ "type": "string",
11324
+ "minLength": 1,
11325
+ "maxLength": 200
11326
+ }
11327
+ },
11328
+ "excludeAnalyticsTechnology": {
11329
+ "description": "Exclude Analytics product names. Companies with no reported product remain included.",
11330
+ "minItems": 1,
11331
+ "maxItems": 100,
11332
+ "type": "array",
11333
+ "items": {
11334
+ "type": "string",
11335
+ "minLength": 1,
11336
+ "maxLength": 200
11337
+ }
11338
+ },
11339
+ "cmsTechnology": {
11340
+ "description": "CMS product names. Match any reported product, ignoring case and surrounding spaces.",
11341
+ "minItems": 1,
11342
+ "maxItems": 100,
11343
+ "type": "array",
11344
+ "items": {
11345
+ "type": "string",
11346
+ "minLength": 1,
11347
+ "maxLength": 200
11348
+ }
11349
+ },
11350
+ "excludeCmsTechnology": {
11351
+ "description": "Exclude CMS product names. Companies with no reported product remain included.",
11352
+ "minItems": 1,
11353
+ "maxItems": 100,
11354
+ "type": "array",
11355
+ "items": {
11356
+ "type": "string",
11357
+ "minLength": 1,
11358
+ "maxLength": 200
11359
+ }
11360
+ },
11361
+ "cloudProviderTechnology": {
11362
+ "description": "Cloud provider product names. Match any reported product, ignoring case and surrounding spaces.",
11363
+ "minItems": 1,
11364
+ "maxItems": 100,
11365
+ "type": "array",
11366
+ "items": {
11367
+ "type": "string",
11368
+ "minLength": 1,
11369
+ "maxLength": 200
11370
+ }
11371
+ },
11372
+ "excludeCloudProviderTechnology": {
11373
+ "description": "Exclude Cloud provider product names. Companies with no reported product remain included.",
11374
+ "minItems": 1,
11375
+ "maxItems": 100,
11376
+ "type": "array",
11377
+ "items": {
11378
+ "type": "string",
11379
+ "minLength": 1,
11380
+ "maxLength": 200
11381
+ }
11382
+ },
11383
+ "ecommerceTechnology": {
11384
+ "description": "Ecommerce product names. Match any reported product, ignoring case and surrounding spaces.",
11385
+ "minItems": 1,
11386
+ "maxItems": 100,
11387
+ "type": "array",
11388
+ "items": {
11389
+ "type": "string",
11390
+ "minLength": 1,
11391
+ "maxLength": 200
11392
+ }
11393
+ },
11394
+ "excludeEcommerceTechnology": {
11395
+ "description": "Exclude Ecommerce product names. Companies with no reported product remain included.",
11396
+ "minItems": 1,
11397
+ "maxItems": 100,
11398
+ "type": "array",
11399
+ "items": {
11400
+ "type": "string",
11401
+ "minLength": 1,
11402
+ "maxLength": 200
11403
+ }
11404
+ },
11405
+ "erpTechnology": {
11406
+ "description": "ERP product names. Match any reported product, ignoring case and surrounding spaces.",
11407
+ "minItems": 1,
11408
+ "maxItems": 100,
11409
+ "type": "array",
11410
+ "items": {
11411
+ "type": "string",
11412
+ "minLength": 1,
11413
+ "maxLength": 200
11414
+ }
11415
+ },
11416
+ "excludeErpTechnology": {
11417
+ "description": "Exclude ERP product names. Companies with no reported product remain included.",
11418
+ "minItems": 1,
11419
+ "maxItems": 100,
11420
+ "type": "array",
11421
+ "items": {
11422
+ "type": "string",
11423
+ "minLength": 1,
11424
+ "maxLength": 200
11425
+ }
11426
+ },
11427
+ "applicationSecurityTechnology": {
11428
+ "description": "Application security product names. Match any reported product, ignoring case and surrounding spaces.",
11429
+ "minItems": 1,
11430
+ "maxItems": 100,
11431
+ "type": "array",
11432
+ "items": {
11433
+ "type": "string",
11434
+ "minLength": 1,
11435
+ "maxLength": 200
11436
+ }
11437
+ },
11438
+ "excludeApplicationSecurityTechnology": {
11439
+ "description": "Exclude Application security product names. Companies with no reported product remain included.",
11440
+ "minItems": 1,
11441
+ "maxItems": 100,
11442
+ "type": "array",
11443
+ "items": {
11444
+ "type": "string",
11445
+ "minLength": 1,
11446
+ "maxLength": 200
11447
+ }
11448
+ },
11449
+ "cloudSecurityTechnology": {
11450
+ "description": "Cloud security product names. Match any reported product, ignoring case and surrounding spaces.",
11451
+ "minItems": 1,
11452
+ "maxItems": 100,
11453
+ "type": "array",
11454
+ "items": {
11455
+ "type": "string",
11456
+ "minLength": 1,
11457
+ "maxLength": 200
11458
+ }
11459
+ },
11460
+ "excludeCloudSecurityTechnology": {
11461
+ "description": "Exclude Cloud security product names. Companies with no reported product remain included.",
11462
+ "minItems": 1,
11463
+ "maxItems": 100,
11464
+ "type": "array",
11465
+ "items": {
11466
+ "type": "string",
11467
+ "minLength": 1,
11468
+ "maxLength": 200
11469
+ }
11470
+ },
11471
+ "emailSecurityTechnology": {
11472
+ "description": "Email security product names. Match any reported product, ignoring case and surrounding spaces.",
11473
+ "minItems": 1,
11474
+ "maxItems": 100,
11475
+ "type": "array",
11476
+ "items": {
11477
+ "type": "string",
11478
+ "minLength": 1,
11479
+ "maxLength": 200
11480
+ }
11481
+ },
11482
+ "excludeEmailSecurityTechnology": {
11483
+ "description": "Exclude Email security product names. Companies with no reported product remain included.",
11484
+ "minItems": 1,
11485
+ "maxItems": 100,
11486
+ "type": "array",
11487
+ "items": {
11488
+ "type": "string",
11489
+ "minLength": 1,
11490
+ "maxLength": 200
11491
+ }
11492
+ },
11493
+ "technologyPresent": {
11494
+ "description": "Technology categories the company must have.",
11495
+ "minItems": 1,
11496
+ "maxItems": 10,
11497
+ "type": "array",
11498
+ "items": {
11499
+ "type": "string",
11500
+ "enum": [
11501
+ "crm",
11502
+ "marketingAutomation",
11503
+ "abm",
11504
+ "salesAutomation",
11505
+ "analytics",
11506
+ "cms",
11507
+ "cloudProvider",
11508
+ "ecommerce",
11509
+ "erp",
11510
+ "security"
11511
+ ]
9599
11512
  }
9600
11513
  }
9601
11514
  },
9602
11515
  "additionalProperties": false
9603
- },
9604
- "excludeListId": {
9605
- "description": "Saved list whose members are left out of the result.",
9606
- "type": "string",
9607
- "format": "uuid",
9608
- "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
9609
11516
  }
9610
11517
  },
9611
11518
  "additionalProperties": false
@@ -10988,7 +12895,7 @@ var TOOL_CATALOG = [
10988
12895
  }
10989
12896
  },
10990
12897
  "personNames": {
10991
- "description": "Person name alternatives. Requires a company name, domain or id. Matches first or last name for one token, or first and last name for two tokens, ignoring case and accents.",
12898
+ "description": "Person name alternatives. Add a company name, domain or id for common names and typo matching. Every non-particle token matches in any order, ignoring case, accents and punctuation. Scoped searches allow one edit per token of at least five letters.",
10992
12899
  "minItems": 1,
10993
12900
  "maxItems": 5,
10994
12901
  "type": "array",
@@ -11356,6 +13263,28 @@ var TOOL_CATALOG = [
11356
13263
  "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
11357
13264
  }
11358
13265
  },
13266
+ "sort": {
13267
+ "description": "Sort by primary company employee estimate, largest or smallest first. Unknown sizes come last. Available from the November 2026 release.",
13268
+ "type": "string",
13269
+ "enum": [
13270
+ "company_size_desc",
13271
+ "company_size_asc"
13272
+ ]
13273
+ },
13274
+ "firstName": {
13275
+ "description": "First name tokens, using accent-folded fuzzy matching. Requires companyId.",
13276
+ "type": "string",
13277
+ "minLength": 1,
13278
+ "maxLength": 120,
13279
+ "pattern": "\\S"
13280
+ },
13281
+ "lastName": {
13282
+ "description": "Last name tokens, using accent-folded fuzzy matching. Requires companyId.",
13283
+ "type": "string",
13284
+ "minLength": 1,
13285
+ "maxLength": 120,
13286
+ "pattern": "\\S"
13287
+ },
11359
13288
  "companyId": {
11360
13289
  "description": "Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters.",
11361
13290
  "type": "string",
@@ -11781,23 +13710,35 @@ var TOOL_CATALOG = [
11781
13710
 
11782
13711
  // src/transport.ts
11783
13712
  import { z } from "zod";
11784
- var failure = z.object({ error: z.union([z.string(), z.object({ code: z.string().max(128), message: z.string().max(2048).optional(), retry_after: z.number().nonnegative().finite().optional() })]) });
13713
+ var failure = z.object({ error: z.union([z.string(), z.object({ code: z.string().max(128), message: z.string().max(2048).optional(), billing_href: z.string().max(2048).optional(), retry_after: z.number().nonnegative().finite().optional() })]) });
11785
13714
  var HigherDataError = class extends Error {
11786
- constructor(message, code, status = 0, retryAfter2, requestId) {
13715
+ constructor(message, code, status = 0, retryAfter2, requestId, billingHref) {
11787
13716
  super(message);
11788
13717
  this.code = code;
11789
13718
  this.status = status;
11790
13719
  this.retryAfter = retryAfter2;
11791
13720
  this.requestId = requestId;
13721
+ this.billingHref = billingHref;
11792
13722
  this.name = "HigherDataError";
11793
13723
  }
11794
13724
  code;
11795
13725
  status;
11796
13726
  retryAfter;
11797
13727
  requestId;
13728
+ billingHref;
11798
13729
  };
11799
13730
  var limits = z.object({ maxRetries: z.number().int().min(0).max(5), timeoutMs: z.number().int().min(1).max(3e5), maxRetryDelayMs: z.number().int().min(0).max(3e5) });
11800
13731
  var MAX_RESPONSE = 8 * 1024 * 1024;
13732
+ var DOWNLOAD_PAGE_ROWS = 500;
13733
+ var INTERACTIVE_PAGE_ROWS = 50;
13734
+ function responseByteLimit(path, input) {
13735
+ const name = path.split("?")[0]?.split("/").at(-1);
13736
+ if (name !== "search.companies" && name !== "search.people") return MAX_RESPONSE;
13737
+ if (!input || typeof input !== "object" || Array.isArray(input) || input.download !== true) return MAX_RESPONSE;
13738
+ const limit = input.limit;
13739
+ const rows = typeof limit === "number" && Number.isInteger(limit) && limit >= 1 ? Math.min(limit, DOWNLOAD_PAGE_ROWS) : INTERACTIVE_PAGE_ROWS;
13740
+ return MAX_RESPONSE * Math.ceil(rows / INTERACTIVE_PAGE_ROWS);
13741
+ }
11801
13742
  function retryAfter(response, data, now) {
11802
13743
  const value = response.headers.get("retry-after");
11803
13744
  if (value !== null) {
@@ -11814,9 +13755,9 @@ function retryAfter(response, data, now) {
11814
13755
  }
11815
13756
  function apiError(response, data, now) {
11816
13757
  const parsed = failure.safeParse(data), error = parsed.success ? parsed.data.error : null;
11817
- return new HigherDataError(typeof error === "object" && error?.message ? error.message : "The HigherData API request failed.", typeof error === "string" ? error : error?.code ?? "http_error", response.status, retryAfter(response, data, now), response.headers.get("x-request-id") ?? void 0);
13758
+ return new HigherDataError(typeof error === "object" && error?.message ? error.message : "The HigherData API request failed.", typeof error === "string" ? error : error?.code ?? "http_error", response.status, retryAfter(response, data, now), response.headers.get("x-request-id") ?? void 0, typeof error === "object" ? error?.billing_href : void 0);
11818
13759
  }
11819
- async function responseJson(response) {
13760
+ async function responseJson(response, maxBytes) {
11820
13761
  if (!response.body) throw new HigherDataError("The API returned an invalid response.", "invalid_response");
11821
13762
  const reader = response.body.getReader(), chunks = [];
11822
13763
  let length = 0;
@@ -11825,7 +13766,7 @@ async function responseJson(response) {
11825
13766
  const { done, value } = await reader.read();
11826
13767
  if (done) break;
11827
13768
  length += value.byteLength;
11828
- if (length > MAX_RESPONSE) {
13769
+ if (length > maxBytes) {
11829
13770
  await reader.cancel();
11830
13771
  throw new HigherDataError("The API response exceeded the size limit.", "response_too_large");
11831
13772
  }
@@ -11899,7 +13840,7 @@ var JsonTransport = class {
11899
13840
  const timeout = AbortSignal.timeout(options.timeoutMs ?? this.settings.timeoutMs);
11900
13841
  response = await (this.options.fetch ?? fetch)(url.toString(), { method: "POST", headers, body, redirect: "manual", signal: options.signal ? AbortSignal.any([timeout, options.signal]) : timeout });
11901
13842
  try {
11902
- data = await responseJson(response);
13843
+ data = await responseJson(response, responseByteLimit(path, input));
11903
13844
  } catch (error2) {
11904
13845
  if (response.ok) throw error2;
11905
13846
  data = void 0;