higherdata-sdk 0.4.0 → 0.6.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 +1482 -31
  2. package/dist/index.js +2492 -378
  3. package/package.json +1 -1
package/dist/index.js CHANGED
@@ -34,6 +34,7 @@ var TOOL_NAMES = [
34
34
  "crm.get_enrichment_options",
35
35
  "crm.get_setup",
36
36
  "crm.get_sync_setup",
37
+ "crm.list_enrichment_jobs",
37
38
  "crm.push",
38
39
  "crm.search",
39
40
  "crm.status",
@@ -66,14 +67,17 @@ var TOOL_NAMES = [
66
67
  "lists.get",
67
68
  "lists.refresh",
68
69
  "lists.run",
70
+ "lists.status",
69
71
  "lookup.company",
70
72
  "lookup.find",
71
73
  "lookup.person",
72
74
  "search.companies",
73
75
  "search.count",
76
+ "search.count_people",
74
77
  "search.facets",
75
78
  "search.filters_from_text",
76
79
  "search.people",
80
+ "search.preview_company_count",
77
81
  "searches.list",
78
82
  "searches.save",
79
83
  "suppress.add",
@@ -1138,6 +1142,11 @@ var TOOL_CATALOG = [
1138
1142
  "type": "string",
1139
1143
  "maxLength": 120
1140
1144
  },
1145
+ "domain": {
1146
+ "description": "Exact normalized company domain. Company searches only.",
1147
+ "type": "string",
1148
+ "maxLength": 253
1149
+ },
1141
1150
  "missingField": {
1142
1151
  "description": "Only records with an empty synced property.",
1143
1152
  "type": "string",
@@ -1420,6 +1429,44 @@ var TOOL_CATALOG = [
1420
1429
  "additionalProperties": false
1421
1430
  }
1422
1431
  },
1432
+ {
1433
+ "name": "crm.list_enrichment_jobs",
1434
+ "description": "List your CRM enrichment previews and proposal jobs in this space, newest first. History contains no record samples.",
1435
+ "risk": "read",
1436
+ "scopes": [
1437
+ "crm:write"
1438
+ ],
1439
+ "input": {
1440
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
1441
+ "type": "object",
1442
+ "properties": {
1443
+ "cursor": {
1444
+ "description": "Continuation from the previous history page.",
1445
+ "type": "object",
1446
+ "properties": {
1447
+ "createdAt": {
1448
+ "type": "string",
1449
+ "format": "date-time",
1450
+ "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])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
1451
+ "description": "Creation time of the last job on the previous page."
1452
+ },
1453
+ "id": {
1454
+ "type": "string",
1455
+ "format": "uuid",
1456
+ "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)$",
1457
+ "description": "Id of the last job on the previous page."
1458
+ }
1459
+ },
1460
+ "required": [
1461
+ "createdAt",
1462
+ "id"
1463
+ ],
1464
+ "additionalProperties": false
1465
+ }
1466
+ },
1467
+ "additionalProperties": false
1468
+ }
1469
+ },
1423
1470
  {
1424
1471
  "name": "crm.push",
1425
1472
  "description": "Propose CRM changes for human review. Creates a pending-approval change set. It never dispatches a HubSpot write; approve fields and call changes.apply separately. Dry run returns the proposal only.",
@@ -1820,6 +1867,11 @@ var TOOL_CATALOG = [
1820
1867
  "type": "string",
1821
1868
  "maxLength": 120
1822
1869
  },
1870
+ "domain": {
1871
+ "description": "Exact normalized company domain. Company searches only.",
1872
+ "type": "string",
1873
+ "maxLength": 253
1874
+ },
1823
1875
  "missingField": {
1824
1876
  "description": "Only records with an empty synced property.",
1825
1877
  "type": "string",
@@ -4376,6 +4428,36 @@ var TOOL_CATALOG = [
4376
4428
  "filters": {
4377
4429
  "type": "object",
4378
4430
  "properties": {
4431
+ "companyNames": {
4432
+ "description": "Company name prefixes. Match any name.",
4433
+ "minItems": 1,
4434
+ "maxItems": 5,
4435
+ "type": "array",
4436
+ "items": {
4437
+ "type": "string",
4438
+ "minLength": 1,
4439
+ "maxLength": 120,
4440
+ "pattern": "\\S"
4441
+ }
4442
+ },
4443
+ "excludeCompanyNames": {
4444
+ "description": "Company name prefixes to leave out.",
4445
+ "minItems": 1,
4446
+ "maxItems": 5,
4447
+ "type": "array",
4448
+ "items": {
4449
+ "type": "string",
4450
+ "minLength": 1,
4451
+ "maxLength": 120,
4452
+ "pattern": "\\S"
4453
+ }
4454
+ },
4455
+ "domain": {
4456
+ "description": "Company website domain. Exact host matching; root sites rank first.",
4457
+ "type": "string",
4458
+ "minLength": 1,
4459
+ "maxLength": 320
4460
+ },
4379
4461
  "countryCodes": {
4380
4462
  "description": "Two-letter country codes to include.",
4381
4463
  "minItems": 1,
@@ -4547,9 +4629,7 @@ var TOOL_CATALOG = [
4547
4629
  "type": "array",
4548
4630
  "items": {
4549
4631
  "type": "string",
4550
- "minLength": 1,
4551
- "maxLength": 120,
4552
- "pattern": "\\S"
4632
+ "pattern": "^[0-9]{6}$"
4553
4633
  }
4554
4634
  },
4555
4635
  "excludeNaics2022Codes": {
@@ -4559,9 +4639,7 @@ var TOOL_CATALOG = [
4559
4639
  "type": "array",
4560
4640
  "items": {
4561
4641
  "type": "string",
4562
- "minLength": 1,
4563
- "maxLength": 120,
4564
- "pattern": "\\S"
4642
+ "pattern": "^[0-9]{6}$"
4565
4643
  }
4566
4644
  },
4567
4645
  "fundingTypes": {
@@ -4690,12 +4768,6 @@ var TOOL_CATALOG = [
4690
4768
  "maxLength": 320
4691
4769
  }
4692
4770
  },
4693
- "domain": {
4694
- "description": "Website domain. Matching is exact on the host, and a root site ranks first.",
4695
- "type": "string",
4696
- "minLength": 1,
4697
- "maxLength": 320
4698
- },
4699
4771
  "insights": {
4700
4772
  "description": "Insights filters. Supply at least one.",
4701
4773
  "type": "object",
@@ -5399,6 +5471,36 @@ var TOOL_CATALOG = [
5399
5471
  "filters": {
5400
5472
  "type": "object",
5401
5473
  "properties": {
5474
+ "companyNames": {
5475
+ "description": "Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes.",
5476
+ "minItems": 1,
5477
+ "maxItems": 5,
5478
+ "type": "array",
5479
+ "items": {
5480
+ "type": "string",
5481
+ "minLength": 1,
5482
+ "maxLength": 120,
5483
+ "pattern": "\\S"
5484
+ }
5485
+ },
5486
+ "excludeCompanyNames": {
5487
+ "description": "Company name prefixes to leave out.",
5488
+ "minItems": 1,
5489
+ "maxItems": 5,
5490
+ "type": "array",
5491
+ "items": {
5492
+ "type": "string",
5493
+ "minLength": 1,
5494
+ "maxLength": 120,
5495
+ "pattern": "\\S"
5496
+ }
5497
+ },
5498
+ "domain": {
5499
+ "description": "Company website domain. Exact host matching; root sites rank first.",
5500
+ "type": "string",
5501
+ "minLength": 1,
5502
+ "maxLength": 320
5503
+ },
5402
5504
  "countryCodes": {
5403
5505
  "description": "Two-letter country codes to include.",
5404
5506
  "minItems": 1,
@@ -5498,9 +5600,7 @@ var TOOL_CATALOG = [
5498
5600
  "type": "array",
5499
5601
  "items": {
5500
5602
  "type": "string",
5501
- "minLength": 1,
5502
- "maxLength": 120,
5503
- "pattern": "\\S"
5603
+ "pattern": "^[0-9]{6}$"
5504
5604
  }
5505
5605
  },
5506
5606
  "excludeNaics2022Codes": {
@@ -5510,9 +5610,7 @@ var TOOL_CATALOG = [
5510
5610
  "type": "array",
5511
5611
  "items": {
5512
5612
  "type": "string",
5513
- "minLength": 1,
5514
- "maxLength": 120,
5515
- "pattern": "\\S"
5613
+ "pattern": "^[0-9]{6}$"
5516
5614
  }
5517
5615
  },
5518
5616
  "fundingTypes": {
@@ -5641,6 +5739,25 @@ var TOOL_CATALOG = [
5641
5739
  "maxLength": 320
5642
5740
  }
5643
5741
  },
5742
+ "personNames": {
5743
+ "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.",
5744
+ "minItems": 1,
5745
+ "maxItems": 5,
5746
+ "type": "array",
5747
+ "items": {
5748
+ "type": "string",
5749
+ "minLength": 1,
5750
+ "maxLength": 120,
5751
+ "pattern": "\\S"
5752
+ }
5753
+ },
5754
+ "email": {
5755
+ "description": "Exact work email address, matched through the email index.",
5756
+ "type": "string",
5757
+ "maxLength": 320,
5758
+ "format": "email",
5759
+ "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,}$"
5760
+ },
5644
5761
  "personCities": {
5645
5762
  "description": "Person cities to include. Requires personCountryCodes.",
5646
5763
  "minItems": 1,
@@ -5991,6 +6108,20 @@ var TOOL_CATALOG = [
5991
6108
  "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,}$"
5992
6109
  }
5993
6110
  },
6111
+ "firstName": {
6112
+ "description": "First name tokens, using accent-folded fuzzy matching. Requires companyId.",
6113
+ "type": "string",
6114
+ "minLength": 1,
6115
+ "maxLength": 120,
6116
+ "pattern": "\\S"
6117
+ },
6118
+ "lastName": {
6119
+ "description": "Last name tokens, using accent-folded fuzzy matching. Requires companyId.",
6120
+ "type": "string",
6121
+ "minLength": 1,
6122
+ "maxLength": 120,
6123
+ "pattern": "\\S"
6124
+ },
5994
6125
  "companyId": {
5995
6126
  "description": "Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters.",
5996
6127
  "type": "string",
@@ -6197,7 +6328,7 @@ var TOOL_CATALOG = [
6197
6328
  },
6198
6329
  {
6199
6330
  "name": "lists.refresh",
6200
- "description": "Preview or refresh a static selection or audience in bounded pages. Record and new-record caps stop a refresh before list changes. Dry run reports additions, flags and removals.",
6331
+ "description": "Preview or refresh a static selection or audience in bounded pages. Record caps keep the first matching records that fit. New-record caps can block a refresh before changes. Dry run reports additions, flags and removals.",
6201
6332
  "risk": "write_local",
6202
6333
  "scopes": [
6203
6334
  "data:read",
@@ -6229,7 +6360,7 @@ var TOOL_CATALOG = [
6229
6360
  },
6230
6361
  {
6231
6362
  "name": "lists.run",
6232
- "description": "Queue a bounded static-list data refresh for the current warehouse release when background jobs are configured, or return jobs_unavailable. Runs are idempotent per list and release. Dry run returns the proposed release without writing or dispatching.",
6363
+ "description": "Queue a background preview or refresh. Only one job runs per list. Owners and admins can refresh dynamic lists now, including the current release. Dry run reports the proposed release without queueing.",
6233
6364
  "risk": "write_local",
6234
6365
  "scopes": [
6235
6366
  "data:read",
@@ -6244,6 +6375,15 @@ var TOOL_CATALOG = [
6244
6375
  "format": "uuid",
6245
6376
  "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)$",
6246
6377
  "description": "Saved list id."
6378
+ },
6379
+ "purpose": {
6380
+ "default": "refresh",
6381
+ "description": "Preview counts without changing records, or refresh using the saved caps.",
6382
+ "type": "string",
6383
+ "enum": [
6384
+ "preview",
6385
+ "refresh"
6386
+ ]
6247
6387
  }
6248
6388
  },
6249
6389
  "required": [
@@ -6252,9 +6392,40 @@ var TOOL_CATALOG = [
6252
6392
  "additionalProperties": false
6253
6393
  }
6254
6394
  },
6395
+ {
6396
+ "name": "lists.status",
6397
+ "description": "Read the progress and count-only summary of a background list preview or refresh.",
6398
+ "risk": "read",
6399
+ "scopes": [
6400
+ "data:read"
6401
+ ],
6402
+ "input": {
6403
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
6404
+ "type": "object",
6405
+ "properties": {
6406
+ "id": {
6407
+ "type": "string",
6408
+ "format": "uuid",
6409
+ "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)$",
6410
+ "description": "Saved list id."
6411
+ },
6412
+ "runId": {
6413
+ "type": "string",
6414
+ "format": "uuid",
6415
+ "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)$",
6416
+ "description": "Background run id returned by lists.run."
6417
+ }
6418
+ },
6419
+ "required": [
6420
+ "id",
6421
+ "runId"
6422
+ ],
6423
+ "additionalProperties": false
6424
+ }
6425
+ },
6255
6426
  {
6256
6427
  "name": "lookup.company",
6257
- "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.",
6428
+ "description": "Look up a company by exactly one domain, exact or near name (optionally with location), or opaque hdo_ id. Returns bounded candidates and ambiguity metadata. Insights fields and filters require the Insights or Unlimited plan.",
6258
6429
  "risk": "read",
6259
6430
  "scopes": [
6260
6431
  "data:read"
@@ -6387,7 +6558,7 @@ var TOOL_CATALOG = [
6387
6558
  },
6388
6559
  {
6389
6560
  "name": "lookup.person",
6390
- "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. ",
6561
+ "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. ",
6391
6562
  "risk": "read",
6392
6563
  "scopes": [
6393
6564
  "data:read"
@@ -6560,6 +6731,36 @@ var TOOL_CATALOG = [
6560
6731
  "$schema": "https://json-schema.org/draft/2020-12/schema",
6561
6732
  "type": "object",
6562
6733
  "properties": {
6734
+ "companyNames": {
6735
+ "description": "Company name prefixes. Match any name.",
6736
+ "minItems": 1,
6737
+ "maxItems": 5,
6738
+ "type": "array",
6739
+ "items": {
6740
+ "type": "string",
6741
+ "minLength": 1,
6742
+ "maxLength": 120,
6743
+ "pattern": "\\S"
6744
+ }
6745
+ },
6746
+ "excludeCompanyNames": {
6747
+ "description": "Company name prefixes to leave out.",
6748
+ "minItems": 1,
6749
+ "maxItems": 5,
6750
+ "type": "array",
6751
+ "items": {
6752
+ "type": "string",
6753
+ "minLength": 1,
6754
+ "maxLength": 120,
6755
+ "pattern": "\\S"
6756
+ }
6757
+ },
6758
+ "domain": {
6759
+ "description": "Company website domain. Exact host matching; root sites rank first.",
6760
+ "type": "string",
6761
+ "minLength": 1,
6762
+ "maxLength": 320
6763
+ },
6563
6764
  "countryCodes": {
6564
6765
  "description": "Two-letter country codes to include.",
6565
6766
  "minItems": 1,
@@ -6731,9 +6932,7 @@ var TOOL_CATALOG = [
6731
6932
  "type": "array",
6732
6933
  "items": {
6733
6934
  "type": "string",
6734
- "minLength": 1,
6735
- "maxLength": 120,
6736
- "pattern": "\\S"
6935
+ "pattern": "^[0-9]{6}$"
6737
6936
  }
6738
6937
  },
6739
6938
  "excludeNaics2022Codes": {
@@ -6743,9 +6942,7 @@ var TOOL_CATALOG = [
6743
6942
  "type": "array",
6744
6943
  "items": {
6745
6944
  "type": "string",
6746
- "minLength": 1,
6747
- "maxLength": 120,
6748
- "pattern": "\\S"
6945
+ "pattern": "^[0-9]{6}$"
6749
6946
  }
6750
6947
  },
6751
6948
  "fundingTypes": {
@@ -6887,12 +7084,6 @@ var TOOL_CATALOG = [
6887
7084
  "minLength": 1,
6888
7085
  "maxLength": 2048
6889
7086
  },
6890
- "domain": {
6891
- "description": "Website domain. Matching is exact on the host, and a root site ranks first.",
6892
- "type": "string",
6893
- "minLength": 1,
6894
- "maxLength": 320
6895
- },
6896
7087
  "insights": {
6897
7088
  "description": "Insights filters. Supply at least one.",
6898
7089
  "type": "object",
@@ -7595,6 +7786,36 @@ var TOOL_CATALOG = [
7595
7786
  "$schema": "https://json-schema.org/draft/2020-12/schema",
7596
7787
  "type": "object",
7597
7788
  "properties": {
7789
+ "companyNames": {
7790
+ "description": "Company name prefixes. Match any name.",
7791
+ "minItems": 1,
7792
+ "maxItems": 5,
7793
+ "type": "array",
7794
+ "items": {
7795
+ "type": "string",
7796
+ "minLength": 1,
7797
+ "maxLength": 120,
7798
+ "pattern": "\\S"
7799
+ }
7800
+ },
7801
+ "excludeCompanyNames": {
7802
+ "description": "Company name prefixes to leave out.",
7803
+ "minItems": 1,
7804
+ "maxItems": 5,
7805
+ "type": "array",
7806
+ "items": {
7807
+ "type": "string",
7808
+ "minLength": 1,
7809
+ "maxLength": 120,
7810
+ "pattern": "\\S"
7811
+ }
7812
+ },
7813
+ "domain": {
7814
+ "description": "Company website domain. Exact host matching; root sites rank first.",
7815
+ "type": "string",
7816
+ "minLength": 1,
7817
+ "maxLength": 320
7818
+ },
7598
7819
  "countryCodes": {
7599
7820
  "description": "Two-letter country codes to include.",
7600
7821
  "minItems": 1,
@@ -7766,9 +7987,7 @@ var TOOL_CATALOG = [
7766
7987
  "type": "array",
7767
7988
  "items": {
7768
7989
  "type": "string",
7769
- "minLength": 1,
7770
- "maxLength": 120,
7771
- "pattern": "\\S"
7990
+ "pattern": "^[0-9]{6}$"
7772
7991
  }
7773
7992
  },
7774
7993
  "excludeNaics2022Codes": {
@@ -7778,9 +7997,7 @@ var TOOL_CATALOG = [
7778
7997
  "type": "array",
7779
7998
  "items": {
7780
7999
  "type": "string",
7781
- "minLength": 1,
7782
- "maxLength": 120,
7783
- "pattern": "\\S"
8000
+ "pattern": "^[0-9]{6}$"
7784
8001
  }
7785
8002
  },
7786
8003
  "fundingTypes": {
@@ -7909,12 +8126,6 @@ var TOOL_CATALOG = [
7909
8126
  "maxLength": 320
7910
8127
  }
7911
8128
  },
7912
- "domain": {
7913
- "description": "Website domain. Matching is exact on the host, and a root site ranks first.",
7914
- "type": "string",
7915
- "minLength": 1,
7916
- "maxLength": 320
7917
- },
7918
8129
  "insights": {
7919
8130
  "description": "Insights filters. Supply at least one.",
7920
8131
  "type": "object",
@@ -8601,8 +8812,8 @@ var TOOL_CATALOG = [
8601
8812
  }
8602
8813
  },
8603
8814
  {
8604
- "name": "search.facets",
8605
- "description": "Read available country, state, industry, NAICS and funding filter values from HigherData Core, with optional country-scoped company, person or job city suggestions. Eligible plans also receive technology product suggestions.",
8815
+ "name": "search.count_people",
8816
+ "description": "Count people once by primary current job before suppression using release-built aggregates; search results may match other current jobs. Unsupported refinements return a qualified baseline. exact: true explicitly requests one capped detailed count of matching people; never use it for live filtering.",
8606
8817
  "risk": "read",
8607
8818
  "scopes": [
8608
8819
  "data:read"
@@ -8611,53 +8822,780 @@ var TOOL_CATALOG = [
8611
8822
  "$schema": "https://json-schema.org/draft/2020-12/schema",
8612
8823
  "type": "object",
8613
8824
  "properties": {
8614
- "cities": {
8615
- "description": "Get only city suggestions for these countries; omit this field for other suggestions. Person and job cities require a company country or industry.",
8825
+ "filters": {
8616
8826
  "type": "object",
8617
8827
  "properties": {
8618
- "location": {
8619
- "type": "string",
8620
- "enum": [
8621
- "company",
8622
- "person",
8623
- "job"
8624
- ],
8625
- "description": "Location whose city suggestions should be read."
8626
- },
8627
- "countryCodes": {
8828
+ "companyNames": {
8829
+ "description": "Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes.",
8628
8830
  "minItems": 1,
8629
8831
  "maxItems": 5,
8630
8832
  "type": "array",
8631
8833
  "items": {
8632
8834
  "type": "string",
8633
- "pattern": "^[A-Z]{2}$"
8634
- },
8635
- "description": "One to five location country codes for city suggestions."
8835
+ "minLength": 1,
8836
+ "maxLength": 120,
8837
+ "pattern": "\\S"
8838
+ }
8636
8839
  },
8637
- "companyCountryCodes": {
8638
- "description": "One to five company HQ countries to prune person or job suggestions.",
8840
+ "excludeCompanyNames": {
8841
+ "description": "Company name prefixes to leave out.",
8639
8842
  "minItems": 1,
8640
8843
  "maxItems": 5,
8641
8844
  "type": "array",
8642
8845
  "items": {
8643
8846
  "type": "string",
8644
- "pattern": "^[A-Z]{2}$"
8847
+ "minLength": 1,
8848
+ "maxLength": 120,
8849
+ "pattern": "\\S"
8645
8850
  }
8646
8851
  },
8647
- "industries": {
8648
- "description": "One to five company industries to prune person or job suggestions.",
8852
+ "domain": {
8853
+ "description": "Company website domain. Exact host matching; root sites rank first.",
8854
+ "type": "string",
8855
+ "minLength": 1,
8856
+ "maxLength": 320
8857
+ },
8858
+ "countryCodes": {
8859
+ "description": "Two-letter country codes to include.",
8649
8860
  "minItems": 1,
8650
- "maxItems": 5,
8861
+ "maxItems": 50,
8651
8862
  "type": "array",
8652
8863
  "items": {
8653
8864
  "type": "string",
8654
- "minLength": 1,
8655
- "maxLength": 120
8865
+ "pattern": "^\\s*[a-z]{2}\\s*$"
8656
8866
  }
8657
- }
8658
- },
8659
- "required": [
8660
- "location",
8867
+ },
8868
+ "stateCodes": {
8869
+ "description": "State or region codes to include.",
8870
+ "minItems": 1,
8871
+ "maxItems": 50,
8872
+ "type": "array",
8873
+ "items": {
8874
+ "type": "string",
8875
+ "minLength": 1,
8876
+ "maxLength": 120,
8877
+ "pattern": "\\S"
8878
+ }
8879
+ },
8880
+ "industries": {
8881
+ "description": "Industries to include.",
8882
+ "minItems": 1,
8883
+ "maxItems": 50,
8884
+ "type": "array",
8885
+ "items": {
8886
+ "type": "string",
8887
+ "minLength": 1,
8888
+ "maxLength": 120,
8889
+ "pattern": "\\S"
8890
+ }
8891
+ },
8892
+ "excludeCountryCodes": {
8893
+ "description": "Two-letter country codes to leave out.",
8894
+ "minItems": 1,
8895
+ "maxItems": 50,
8896
+ "type": "array",
8897
+ "items": {
8898
+ "type": "string",
8899
+ "pattern": "^\\s*[a-z]{2}\\s*$"
8900
+ }
8901
+ },
8902
+ "excludeStateCodes": {
8903
+ "description": "State or region codes to leave out.",
8904
+ "minItems": 1,
8905
+ "maxItems": 50,
8906
+ "type": "array",
8907
+ "items": {
8908
+ "type": "string",
8909
+ "minLength": 1,
8910
+ "maxLength": 120,
8911
+ "pattern": "\\S"
8912
+ }
8913
+ },
8914
+ "excludeIndustries": {
8915
+ "description": "Industries to leave out.",
8916
+ "minItems": 1,
8917
+ "maxItems": 50,
8918
+ "type": "array",
8919
+ "items": {
8920
+ "type": "string",
8921
+ "minLength": 1,
8922
+ "maxLength": 120,
8923
+ "pattern": "\\S"
8924
+ }
8925
+ },
8926
+ "employeeCountMin": {
8927
+ "description": "Lowest employee count to include.",
8928
+ "type": "integer",
8929
+ "minimum": 0,
8930
+ "maximum": 9007199254740991
8931
+ },
8932
+ "employeeCountMax": {
8933
+ "description": "Highest employee count to include.",
8934
+ "type": "integer",
8935
+ "minimum": 0,
8936
+ "maximum": 9007199254740991
8937
+ },
8938
+ "revenueMinUsd": {
8939
+ "description": "Lowest annual revenue to include, in US dollars.",
8940
+ "type": "integer",
8941
+ "minimum": 0,
8942
+ "maximum": 9007199254740991
8943
+ },
8944
+ "revenueMaxUsd": {
8945
+ "description": "Highest annual revenue to include, in US dollars.",
8946
+ "type": "integer",
8947
+ "minimum": 0,
8948
+ "maximum": 9007199254740991
8949
+ },
8950
+ "naics2022Codes": {
8951
+ "description": "NAICS 2022 codes to include.",
8952
+ "minItems": 1,
8953
+ "maxItems": 50,
8954
+ "type": "array",
8955
+ "items": {
8956
+ "type": "string",
8957
+ "pattern": "^[0-9]{6}$"
8958
+ }
8959
+ },
8960
+ "excludeNaics2022Codes": {
8961
+ "description": "NAICS 2022 codes to leave out.",
8962
+ "minItems": 1,
8963
+ "maxItems": 50,
8964
+ "type": "array",
8965
+ "items": {
8966
+ "type": "string",
8967
+ "pattern": "^[0-9]{6}$"
8968
+ }
8969
+ },
8970
+ "fundingTypes": {
8971
+ "description": "Funding round types to include.",
8972
+ "minItems": 1,
8973
+ "maxItems": 50,
8974
+ "type": "array",
8975
+ "items": {
8976
+ "type": "string",
8977
+ "minLength": 1,
8978
+ "maxLength": 120,
8979
+ "pattern": "\\S"
8980
+ }
8981
+ },
8982
+ "excludeFundingTypes": {
8983
+ "description": "Funding round types to leave out.",
8984
+ "minItems": 1,
8985
+ "maxItems": 50,
8986
+ "type": "array",
8987
+ "items": {
8988
+ "type": "string",
8989
+ "minLength": 1,
8990
+ "maxLength": 120,
8991
+ "pattern": "\\S"
8992
+ }
8993
+ },
8994
+ "keywords": {
8995
+ "description": "Keywords to match. A company can match any of them.",
8996
+ "minItems": 1,
8997
+ "maxItems": 50,
8998
+ "type": "array",
8999
+ "items": {
9000
+ "type": "string",
9001
+ "minLength": 1,
9002
+ "maxLength": 120,
9003
+ "pattern": "\\S"
9004
+ }
9005
+ },
9006
+ "requiredKeywords": {
9007
+ "description": "Keywords the company must match.",
9008
+ "minItems": 1,
9009
+ "maxItems": 50,
9010
+ "type": "array",
9011
+ "items": {
9012
+ "type": "string",
9013
+ "minLength": 1,
9014
+ "maxLength": 120,
9015
+ "pattern": "\\S"
9016
+ }
9017
+ },
9018
+ "requiredKeywordGroups": {
9019
+ "description": "Keyword groups. The company must match every group, and any keyword inside a group.",
9020
+ "maxItems": 10,
9021
+ "type": "array",
9022
+ "items": {
9023
+ "minItems": 1,
9024
+ "maxItems": 50,
9025
+ "type": "array",
9026
+ "items": {
9027
+ "type": "string",
9028
+ "minLength": 1,
9029
+ "maxLength": 120,
9030
+ "pattern": "\\S"
9031
+ }
9032
+ }
9033
+ },
9034
+ "excludeKeywords": {
9035
+ "description": "Keywords that remove a company.",
9036
+ "minItems": 1,
9037
+ "maxItems": 50,
9038
+ "type": "array",
9039
+ "items": {
9040
+ "type": "string",
9041
+ "minLength": 1,
9042
+ "maxLength": 120,
9043
+ "pattern": "\\S"
9044
+ }
9045
+ },
9046
+ "websiteAvailability": {
9047
+ "description": "Whether the company has a website.",
9048
+ "type": "string",
9049
+ "enum": [
9050
+ "any",
9051
+ "available",
9052
+ "missing"
9053
+ ]
9054
+ },
9055
+ "linkedinAvailability": {
9056
+ "description": "Whether the company has a LinkedIn page.",
9057
+ "type": "string",
9058
+ "enum": [
9059
+ "any",
9060
+ "available",
9061
+ "missing"
9062
+ ]
9063
+ },
9064
+ "fundingDateAfter": {
9065
+ "description": "Include funding on or after this date.",
9066
+ "type": "string",
9067
+ "format": "date",
9068
+ "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])))$"
9069
+ },
9070
+ "fundingDateBefore": {
9071
+ "description": "Include funding on or before this date.",
9072
+ "type": "string",
9073
+ "format": "date",
9074
+ "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])))$"
9075
+ },
9076
+ "excludeOrganizationIds": {
9077
+ "description": "Opaque company ids (hdo_) to leave out.",
9078
+ "maxItems": 1e3,
9079
+ "type": "array",
9080
+ "items": {
9081
+ "type": "string",
9082
+ "pattern": "^hdo_[0-9a-f]{32}$",
9083
+ "description": "Opaque company id (hdo_)."
9084
+ }
9085
+ },
9086
+ "excludeDomains": {
9087
+ "description": "Website domains to leave out.",
9088
+ "maxItems": 1e3,
9089
+ "type": "array",
9090
+ "items": {
9091
+ "type": "string",
9092
+ "minLength": 1,
9093
+ "maxLength": 320
9094
+ }
9095
+ },
9096
+ "personNames": {
9097
+ "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.",
9098
+ "minItems": 1,
9099
+ "maxItems": 5,
9100
+ "type": "array",
9101
+ "items": {
9102
+ "type": "string",
9103
+ "minLength": 1,
9104
+ "maxLength": 120,
9105
+ "pattern": "\\S"
9106
+ }
9107
+ },
9108
+ "email": {
9109
+ "description": "Exact work email address, matched through the email index.",
9110
+ "type": "string",
9111
+ "maxLength": 320,
9112
+ "format": "email",
9113
+ "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,}$"
9114
+ },
9115
+ "personCities": {
9116
+ "description": "Person cities to include. Requires personCountryCodes.",
9117
+ "minItems": 1,
9118
+ "maxItems": 50,
9119
+ "type": "array",
9120
+ "items": {
9121
+ "type": "string",
9122
+ "minLength": 1,
9123
+ "maxLength": 120,
9124
+ "pattern": "\\S"
9125
+ }
9126
+ },
9127
+ "excludePersonCities": {
9128
+ "description": "Person cities to leave out. Requires personCountryCodes.",
9129
+ "minItems": 1,
9130
+ "maxItems": 50,
9131
+ "type": "array",
9132
+ "items": {
9133
+ "type": "string",
9134
+ "minLength": 1,
9135
+ "maxLength": 120,
9136
+ "pattern": "\\S"
9137
+ }
9138
+ },
9139
+ "personStateCodes": {
9140
+ "description": "Person state or region codes to include.",
9141
+ "minItems": 1,
9142
+ "maxItems": 50,
9143
+ "type": "array",
9144
+ "items": {
9145
+ "type": "string",
9146
+ "minLength": 1,
9147
+ "maxLength": 120,
9148
+ "pattern": "\\S"
9149
+ }
9150
+ },
9151
+ "excludePersonStateCodes": {
9152
+ "description": "Person state or region codes to leave out.",
9153
+ "minItems": 1,
9154
+ "maxItems": 50,
9155
+ "type": "array",
9156
+ "items": {
9157
+ "type": "string",
9158
+ "minLength": 1,
9159
+ "maxLength": 120,
9160
+ "pattern": "\\S"
9161
+ }
9162
+ },
9163
+ "personCountryCodes": {
9164
+ "description": "Person country codes to include.",
9165
+ "minItems": 1,
9166
+ "maxItems": 50,
9167
+ "type": "array",
9168
+ "items": {
9169
+ "type": "string",
9170
+ "pattern": "^\\s*[a-z]{2}\\s*$"
9171
+ }
9172
+ },
9173
+ "excludePersonCountryCodes": {
9174
+ "description": "Person country codes to leave out.",
9175
+ "minItems": 1,
9176
+ "maxItems": 50,
9177
+ "type": "array",
9178
+ "items": {
9179
+ "type": "string",
9180
+ "pattern": "^\\s*[a-z]{2}\\s*$"
9181
+ }
9182
+ },
9183
+ "jobCities": {
9184
+ "description": "Job cities to include. Requires jobCountryCodes.",
9185
+ "minItems": 1,
9186
+ "maxItems": 50,
9187
+ "type": "array",
9188
+ "items": {
9189
+ "type": "string",
9190
+ "minLength": 1,
9191
+ "maxLength": 120,
9192
+ "pattern": "\\S"
9193
+ }
9194
+ },
9195
+ "excludeJobCities": {
9196
+ "description": "Job cities to leave out. Requires jobCountryCodes.",
9197
+ "minItems": 1,
9198
+ "maxItems": 50,
9199
+ "type": "array",
9200
+ "items": {
9201
+ "type": "string",
9202
+ "minLength": 1,
9203
+ "maxLength": 120,
9204
+ "pattern": "\\S"
9205
+ }
9206
+ },
9207
+ "jobStateCodes": {
9208
+ "description": "Job state or region codes to include.",
9209
+ "minItems": 1,
9210
+ "maxItems": 50,
9211
+ "type": "array",
9212
+ "items": {
9213
+ "type": "string",
9214
+ "minLength": 1,
9215
+ "maxLength": 120,
9216
+ "pattern": "\\S"
9217
+ }
9218
+ },
9219
+ "excludeJobStateCodes": {
9220
+ "description": "Job state or region codes to leave out.",
9221
+ "minItems": 1,
9222
+ "maxItems": 50,
9223
+ "type": "array",
9224
+ "items": {
9225
+ "type": "string",
9226
+ "minLength": 1,
9227
+ "maxLength": 120,
9228
+ "pattern": "\\S"
9229
+ }
9230
+ },
9231
+ "jobCountryCodes": {
9232
+ "description": "Job country codes to include.",
9233
+ "minItems": 1,
9234
+ "maxItems": 50,
9235
+ "type": "array",
9236
+ "items": {
9237
+ "type": "string",
9238
+ "pattern": "^\\s*[a-z]{2}\\s*$"
9239
+ }
9240
+ },
9241
+ "excludeJobCountryCodes": {
9242
+ "description": "Job country codes to leave out.",
9243
+ "minItems": 1,
9244
+ "maxItems": 50,
9245
+ "type": "array",
9246
+ "items": {
9247
+ "type": "string",
9248
+ "pattern": "^\\s*[a-z]{2}\\s*$"
9249
+ }
9250
+ },
9251
+ "companyCities": {
9252
+ "description": "Company HQ cities to include. Requires countryCodes.",
9253
+ "minItems": 1,
9254
+ "maxItems": 50,
9255
+ "type": "array",
9256
+ "items": {
9257
+ "type": "string",
9258
+ "minLength": 1,
9259
+ "maxLength": 120,
9260
+ "pattern": "\\S"
9261
+ }
9262
+ },
9263
+ "excludeCompanyCities": {
9264
+ "description": "Company HQ cities to leave out. Requires countryCodes.",
9265
+ "minItems": 1,
9266
+ "maxItems": 50,
9267
+ "type": "array",
9268
+ "items": {
9269
+ "type": "string",
9270
+ "minLength": 1,
9271
+ "maxLength": 120,
9272
+ "pattern": "\\S"
9273
+ }
9274
+ },
9275
+ "companyFoundedYearMin": {
9276
+ "description": "Earliest company founding year.",
9277
+ "type": "integer",
9278
+ "minimum": 0,
9279
+ "maximum": 9007199254740991
9280
+ },
9281
+ "companyFoundedYearMax": {
9282
+ "description": "Latest company founding year.",
9283
+ "type": "integer",
9284
+ "minimum": 0,
9285
+ "maximum": 9007199254740991
9286
+ },
9287
+ "jobStartDateAfter": {
9288
+ "description": "Include jobs started on or after this date.",
9289
+ "type": "string",
9290
+ "format": "date",
9291
+ "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])))$"
9292
+ },
9293
+ "jobStartDateBefore": {
9294
+ "description": "Include jobs started on or before this date.",
9295
+ "type": "string",
9296
+ "format": "date",
9297
+ "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])))$"
9298
+ },
9299
+ "titleKeywords": {
9300
+ "description": "Job title keywords to match. A person can match any of them.",
9301
+ "minItems": 1,
9302
+ "maxItems": 50,
9303
+ "type": "array",
9304
+ "items": {
9305
+ "type": "string",
9306
+ "minLength": 1,
9307
+ "maxLength": 120,
9308
+ "pattern": "\\S"
9309
+ }
9310
+ },
9311
+ "requiredTitleKeywords": {
9312
+ "description": "Job title keywords the person must match.",
9313
+ "minItems": 1,
9314
+ "maxItems": 50,
9315
+ "type": "array",
9316
+ "items": {
9317
+ "type": "string",
9318
+ "minLength": 1,
9319
+ "maxLength": 120,
9320
+ "pattern": "\\S"
9321
+ }
9322
+ },
9323
+ "requiredTitleKeywordGroups": {
9324
+ "description": "Job title keyword groups. The person must match every group, and any keyword inside a group.",
9325
+ "maxItems": 10,
9326
+ "type": "array",
9327
+ "items": {
9328
+ "minItems": 1,
9329
+ "maxItems": 50,
9330
+ "type": "array",
9331
+ "items": {
9332
+ "type": "string",
9333
+ "minLength": 1,
9334
+ "maxLength": 120,
9335
+ "pattern": "\\S"
9336
+ }
9337
+ }
9338
+ },
9339
+ "excludeTitleKeywords": {
9340
+ "description": "Job title keywords that remove a person.",
9341
+ "minItems": 1,
9342
+ "maxItems": 50,
9343
+ "type": "array",
9344
+ "items": {
9345
+ "type": "string",
9346
+ "minLength": 1,
9347
+ "maxLength": 120,
9348
+ "pattern": "\\S"
9349
+ }
9350
+ },
9351
+ "jobFunctions": {
9352
+ "description": "Job functions to include.",
9353
+ "minItems": 1,
9354
+ "maxItems": 50,
9355
+ "type": "array",
9356
+ "items": {
9357
+ "type": "string",
9358
+ "minLength": 1,
9359
+ "maxLength": 120,
9360
+ "pattern": "\\S"
9361
+ }
9362
+ },
9363
+ "excludeJobFunctions": {
9364
+ "description": "Job functions to leave out.",
9365
+ "minItems": 1,
9366
+ "maxItems": 50,
9367
+ "type": "array",
9368
+ "items": {
9369
+ "type": "string",
9370
+ "minLength": 1,
9371
+ "maxLength": 120,
9372
+ "pattern": "\\S"
9373
+ }
9374
+ },
9375
+ "jobLevels": {
9376
+ "description": "Job levels to include.",
9377
+ "minItems": 1,
9378
+ "maxItems": 50,
9379
+ "type": "array",
9380
+ "items": {
9381
+ "type": "string",
9382
+ "minLength": 1,
9383
+ "maxLength": 120,
9384
+ "pattern": "\\S"
9385
+ }
9386
+ },
9387
+ "excludeJobLevels": {
9388
+ "description": "Job levels to leave out.",
9389
+ "minItems": 1,
9390
+ "maxItems": 50,
9391
+ "type": "array",
9392
+ "items": {
9393
+ "type": "string",
9394
+ "minLength": 1,
9395
+ "maxLength": 120,
9396
+ "pattern": "\\S"
9397
+ }
9398
+ },
9399
+ "gtmRoleFamilies": {
9400
+ "description": "Go-to-market role families to include.",
9401
+ "minItems": 1,
9402
+ "maxItems": 50,
9403
+ "type": "array",
9404
+ "items": {
9405
+ "type": "string",
9406
+ "minLength": 1,
9407
+ "maxLength": 120,
9408
+ "pattern": "\\S"
9409
+ }
9410
+ },
9411
+ "excludeGtmRoleFamilies": {
9412
+ "description": "Go-to-market role families to leave out.",
9413
+ "minItems": 1,
9414
+ "maxItems": 50,
9415
+ "type": "array",
9416
+ "items": {
9417
+ "type": "string",
9418
+ "minLength": 1,
9419
+ "maxLength": 120,
9420
+ "pattern": "\\S"
9421
+ }
9422
+ },
9423
+ "requireVerifiedEmail": {
9424
+ "description": "When true, only people with a verified work email are returned.",
9425
+ "type": "boolean"
9426
+ },
9427
+ "emailAvailability": {
9428
+ "description": "Whether the person has an email address.",
9429
+ "type": "string",
9430
+ "enum": [
9431
+ "any",
9432
+ "available",
9433
+ "missing"
9434
+ ]
9435
+ },
9436
+ "phoneAvailability": {
9437
+ "description": "Whether the person has a phone number.",
9438
+ "type": "string",
9439
+ "enum": [
9440
+ "any",
9441
+ "available",
9442
+ "missing"
9443
+ ]
9444
+ },
9445
+ "excludePersonIds": {
9446
+ "description": "Opaque person ids (hdp_) to leave out.",
9447
+ "maxItems": 1e3,
9448
+ "type": "array",
9449
+ "items": {
9450
+ "type": "string",
9451
+ "pattern": "^hdp_[0-9a-f]{32}$",
9452
+ "description": "Opaque person id (hdp_)."
9453
+ }
9454
+ },
9455
+ "excludeEmails": {
9456
+ "description": "Email addresses to leave out.",
9457
+ "maxItems": 1e3,
9458
+ "type": "array",
9459
+ "items": {
9460
+ "type": "string",
9461
+ "format": "email",
9462
+ "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,}$"
9463
+ }
9464
+ },
9465
+ "firstName": {
9466
+ "description": "First name tokens, using accent-folded fuzzy matching. Requires companyId.",
9467
+ "type": "string",
9468
+ "minLength": 1,
9469
+ "maxLength": 120,
9470
+ "pattern": "\\S"
9471
+ },
9472
+ "lastName": {
9473
+ "description": "Last name tokens, using accent-folded fuzzy matching. Requires companyId.",
9474
+ "type": "string",
9475
+ "minLength": 1,
9476
+ "maxLength": 120,
9477
+ "pattern": "\\S"
9478
+ },
9479
+ "companyId": {
9480
+ "description": "Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters.",
9481
+ "type": "string",
9482
+ "pattern": "^hdo_[0-9a-f]{32}$"
9483
+ },
9484
+ "contactLocation": {
9485
+ "description": "Contact location filters. Requires companyId.",
9486
+ "type": "object",
9487
+ "properties": {
9488
+ "countryCodes": {
9489
+ "description": "Person or job location country codes.",
9490
+ "minItems": 1,
9491
+ "maxItems": 50,
9492
+ "type": "array",
9493
+ "items": {
9494
+ "type": "string",
9495
+ "pattern": "^\\s*[a-z]{2}\\s*$"
9496
+ }
9497
+ },
9498
+ "stateCodes": {
9499
+ "description": "Person or job location state codes.",
9500
+ "minItems": 1,
9501
+ "maxItems": 50,
9502
+ "type": "array",
9503
+ "items": {
9504
+ "type": "string",
9505
+ "minLength": 1,
9506
+ "maxLength": 120,
9507
+ "pattern": "\\S"
9508
+ }
9509
+ },
9510
+ "cities": {
9511
+ "description": "Person or job location cities.",
9512
+ "minItems": 1,
9513
+ "maxItems": 50,
9514
+ "type": "array",
9515
+ "items": {
9516
+ "type": "string",
9517
+ "minLength": 1,
9518
+ "maxLength": 120,
9519
+ "pattern": "\\S"
9520
+ }
9521
+ }
9522
+ },
9523
+ "additionalProperties": false
9524
+ }
9525
+ },
9526
+ "additionalProperties": false,
9527
+ "description": "People filters to count."
9528
+ },
9529
+ "exact": {
9530
+ "default": false,
9531
+ "description": "Explicitly run a detailed capped count instead of a rollup estimate. Never enable for live filtering.",
9532
+ "type": "boolean"
9533
+ }
9534
+ },
9535
+ "required": [
9536
+ "filters"
9537
+ ],
9538
+ "additionalProperties": false
9539
+ }
9540
+ },
9541
+ {
9542
+ "name": "search.facets",
9543
+ "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.",
9544
+ "risk": "read",
9545
+ "scopes": [
9546
+ "data:read"
9547
+ ],
9548
+ "input": {
9549
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
9550
+ "type": "object",
9551
+ "properties": {
9552
+ "cities": {
9553
+ "description": "Get only city suggestions for these countries; omit this field for other suggestions. Person and job cities require a company country or industry.",
9554
+ "type": "object",
9555
+ "properties": {
9556
+ "location": {
9557
+ "type": "string",
9558
+ "enum": [
9559
+ "company",
9560
+ "person",
9561
+ "job"
9562
+ ],
9563
+ "description": "Location whose city suggestions should be read."
9564
+ },
9565
+ "countryCodes": {
9566
+ "minItems": 1,
9567
+ "maxItems": 5,
9568
+ "type": "array",
9569
+ "items": {
9570
+ "type": "string",
9571
+ "pattern": "^[A-Z]{2}$"
9572
+ },
9573
+ "description": "One to five location country codes for city suggestions."
9574
+ },
9575
+ "companyCountryCodes": {
9576
+ "description": "One to five company HQ countries to prune person or job suggestions.",
9577
+ "minItems": 1,
9578
+ "maxItems": 5,
9579
+ "type": "array",
9580
+ "items": {
9581
+ "type": "string",
9582
+ "pattern": "^[A-Z]{2}$"
9583
+ }
9584
+ },
9585
+ "industries": {
9586
+ "description": "One to five company industries to prune person or job suggestions.",
9587
+ "minItems": 1,
9588
+ "maxItems": 5,
9589
+ "type": "array",
9590
+ "items": {
9591
+ "type": "string",
9592
+ "minLength": 1,
9593
+ "maxLength": 120
9594
+ }
9595
+ }
9596
+ },
9597
+ "required": [
9598
+ "location",
8661
9599
  "countryCodes"
8662
9600
  ],
8663
9601
  "additionalProperties": false
@@ -8679,39 +9617,374 @@ var TOOL_CATALOG = [
8679
9617
  "properties": {
8680
9618
  "text": {
8681
9619
  "type": "string",
8682
- "minLength": 1,
8683
- "maxLength": 4e3,
8684
- "description": "Sentence to turn into filters."
9620
+ "minLength": 1,
9621
+ "maxLength": 4e3,
9622
+ "description": "Sentence to turn into filters."
9623
+ },
9624
+ "kind": {
9625
+ "default": "companies",
9626
+ "description": "Whether the sentence describes companies or people.",
9627
+ "type": "string",
9628
+ "enum": [
9629
+ "companies",
9630
+ "people"
9631
+ ]
9632
+ }
9633
+ },
9634
+ "required": [
9635
+ "text"
9636
+ ],
9637
+ "additionalProperties": false
9638
+ }
9639
+ },
9640
+ {
9641
+ "name": "search.people",
9642
+ "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. Pages contain at most 50 people and opaque ids. ",
9643
+ "risk": "read",
9644
+ "scopes": [
9645
+ "data:read"
9646
+ ],
9647
+ "input": {
9648
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
9649
+ "type": "object",
9650
+ "properties": {
9651
+ "companyNames": {
9652
+ "description": "Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes.",
9653
+ "minItems": 1,
9654
+ "maxItems": 5,
9655
+ "type": "array",
9656
+ "items": {
9657
+ "type": "string",
9658
+ "minLength": 1,
9659
+ "maxLength": 120,
9660
+ "pattern": "\\S"
9661
+ }
9662
+ },
9663
+ "excludeCompanyNames": {
9664
+ "description": "Company name prefixes to leave out.",
9665
+ "minItems": 1,
9666
+ "maxItems": 5,
9667
+ "type": "array",
9668
+ "items": {
9669
+ "type": "string",
9670
+ "minLength": 1,
9671
+ "maxLength": 120,
9672
+ "pattern": "\\S"
9673
+ }
9674
+ },
9675
+ "domain": {
9676
+ "description": "Company website domain. Exact host matching; root sites rank first.",
9677
+ "type": "string",
9678
+ "minLength": 1,
9679
+ "maxLength": 320
9680
+ },
9681
+ "countryCodes": {
9682
+ "description": "Two-letter country codes to include.",
9683
+ "minItems": 1,
9684
+ "maxItems": 50,
9685
+ "type": "array",
9686
+ "items": {
9687
+ "type": "string",
9688
+ "pattern": "^\\s*[a-z]{2}\\s*$"
9689
+ }
9690
+ },
9691
+ "stateCodes": {
9692
+ "description": "State or region codes to include.",
9693
+ "minItems": 1,
9694
+ "maxItems": 50,
9695
+ "type": "array",
9696
+ "items": {
9697
+ "type": "string",
9698
+ "minLength": 1,
9699
+ "maxLength": 120,
9700
+ "pattern": "\\S"
9701
+ }
9702
+ },
9703
+ "industries": {
9704
+ "description": "Industries to include.",
9705
+ "minItems": 1,
9706
+ "maxItems": 50,
9707
+ "type": "array",
9708
+ "items": {
9709
+ "type": "string",
9710
+ "minLength": 1,
9711
+ "maxLength": 120,
9712
+ "pattern": "\\S"
9713
+ }
9714
+ },
9715
+ "excludeCountryCodes": {
9716
+ "description": "Two-letter country codes to leave out.",
9717
+ "minItems": 1,
9718
+ "maxItems": 50,
9719
+ "type": "array",
9720
+ "items": {
9721
+ "type": "string",
9722
+ "pattern": "^\\s*[a-z]{2}\\s*$"
9723
+ }
9724
+ },
9725
+ "excludeStateCodes": {
9726
+ "description": "State or region codes to leave out.",
9727
+ "minItems": 1,
9728
+ "maxItems": 50,
9729
+ "type": "array",
9730
+ "items": {
9731
+ "type": "string",
9732
+ "minLength": 1,
9733
+ "maxLength": 120,
9734
+ "pattern": "\\S"
9735
+ }
9736
+ },
9737
+ "excludeIndustries": {
9738
+ "description": "Industries to leave out.",
9739
+ "minItems": 1,
9740
+ "maxItems": 50,
9741
+ "type": "array",
9742
+ "items": {
9743
+ "type": "string",
9744
+ "minLength": 1,
9745
+ "maxLength": 120,
9746
+ "pattern": "\\S"
9747
+ }
9748
+ },
9749
+ "employeeCountMin": {
9750
+ "description": "Lowest employee count to include.",
9751
+ "type": "integer",
9752
+ "minimum": 0,
9753
+ "maximum": 9007199254740991
9754
+ },
9755
+ "employeeCountMax": {
9756
+ "description": "Highest employee count to include.",
9757
+ "type": "integer",
9758
+ "minimum": 0,
9759
+ "maximum": 9007199254740991
9760
+ },
9761
+ "revenueMinUsd": {
9762
+ "description": "Lowest annual revenue to include, in US dollars.",
9763
+ "type": "integer",
9764
+ "minimum": 0,
9765
+ "maximum": 9007199254740991
9766
+ },
9767
+ "revenueMaxUsd": {
9768
+ "description": "Highest annual revenue to include, in US dollars.",
9769
+ "type": "integer",
9770
+ "minimum": 0,
9771
+ "maximum": 9007199254740991
9772
+ },
9773
+ "naics2022Codes": {
9774
+ "description": "NAICS 2022 codes to include.",
9775
+ "minItems": 1,
9776
+ "maxItems": 50,
9777
+ "type": "array",
9778
+ "items": {
9779
+ "type": "string",
9780
+ "pattern": "^[0-9]{6}$"
9781
+ }
9782
+ },
9783
+ "excludeNaics2022Codes": {
9784
+ "description": "NAICS 2022 codes to leave out.",
9785
+ "minItems": 1,
9786
+ "maxItems": 50,
9787
+ "type": "array",
9788
+ "items": {
9789
+ "type": "string",
9790
+ "pattern": "^[0-9]{6}$"
9791
+ }
9792
+ },
9793
+ "fundingTypes": {
9794
+ "description": "Funding round types 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
+ "excludeFundingTypes": {
9806
+ "description": "Funding round types to leave out.",
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
+ "keywords": {
9818
+ "description": "Keywords to match. A company can match any of them.",
9819
+ "minItems": 1,
9820
+ "maxItems": 50,
9821
+ "type": "array",
9822
+ "items": {
9823
+ "type": "string",
9824
+ "minLength": 1,
9825
+ "maxLength": 120,
9826
+ "pattern": "\\S"
9827
+ }
9828
+ },
9829
+ "requiredKeywords": {
9830
+ "description": "Keywords the company must match.",
9831
+ "minItems": 1,
9832
+ "maxItems": 50,
9833
+ "type": "array",
9834
+ "items": {
9835
+ "type": "string",
9836
+ "minLength": 1,
9837
+ "maxLength": 120,
9838
+ "pattern": "\\S"
9839
+ }
9840
+ },
9841
+ "requiredKeywordGroups": {
9842
+ "description": "Keyword groups. The company must match every group, and any keyword inside a group.",
9843
+ "maxItems": 10,
9844
+ "type": "array",
9845
+ "items": {
9846
+ "minItems": 1,
9847
+ "maxItems": 50,
9848
+ "type": "array",
9849
+ "items": {
9850
+ "type": "string",
9851
+ "minLength": 1,
9852
+ "maxLength": 120,
9853
+ "pattern": "\\S"
9854
+ }
9855
+ }
9856
+ },
9857
+ "excludeKeywords": {
9858
+ "description": "Keywords that remove a company.",
9859
+ "minItems": 1,
9860
+ "maxItems": 50,
9861
+ "type": "array",
9862
+ "items": {
9863
+ "type": "string",
9864
+ "minLength": 1,
9865
+ "maxLength": 120,
9866
+ "pattern": "\\S"
9867
+ }
9868
+ },
9869
+ "websiteAvailability": {
9870
+ "description": "Whether the company has a website.",
9871
+ "type": "string",
9872
+ "enum": [
9873
+ "any",
9874
+ "available",
9875
+ "missing"
9876
+ ]
8685
9877
  },
8686
- "kind": {
8687
- "default": "companies",
8688
- "description": "Whether the sentence describes companies or people.",
9878
+ "linkedinAvailability": {
9879
+ "description": "Whether the company has a LinkedIn page.",
8689
9880
  "type": "string",
8690
9881
  "enum": [
8691
- "companies",
8692
- "people"
9882
+ "any",
9883
+ "available",
9884
+ "missing"
8693
9885
  ]
8694
- }
8695
- },
8696
- "required": [
8697
- "text"
8698
- ],
8699
- "additionalProperties": false
8700
- }
8701
- },
8702
- {
8703
- "name": "search.people",
8704
- "description": "Find people in HigherData Core, with 1 to 5 positive company HQ country codes or industries required unless companyId scopes the search to one company. 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. ",
8705
- "risk": "read",
8706
- "scopes": [
8707
- "data:read"
8708
- ],
8709
- "input": {
8710
- "$schema": "https://json-schema.org/draft/2020-12/schema",
8711
- "type": "object",
8712
- "properties": {
8713
- "countryCodes": {
8714
- "description": "Two-letter country codes to include.",
9886
+ },
9887
+ "fundingDateAfter": {
9888
+ "description": "Include funding on or after this date.",
9889
+ "type": "string",
9890
+ "format": "date",
9891
+ "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])))$"
9892
+ },
9893
+ "fundingDateBefore": {
9894
+ "description": "Include funding on or before this date.",
9895
+ "type": "string",
9896
+ "format": "date",
9897
+ "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])))$"
9898
+ },
9899
+ "excludeOrganizationIds": {
9900
+ "description": "Opaque company ids (hdo_) to leave out.",
9901
+ "maxItems": 1e3,
9902
+ "type": "array",
9903
+ "items": {
9904
+ "type": "string",
9905
+ "pattern": "^hdo_[0-9a-f]{32}$",
9906
+ "description": "Opaque company id (hdo_)."
9907
+ }
9908
+ },
9909
+ "excludeDomains": {
9910
+ "description": "Website domains to leave out.",
9911
+ "maxItems": 1e3,
9912
+ "type": "array",
9913
+ "items": {
9914
+ "type": "string",
9915
+ "minLength": 1,
9916
+ "maxLength": 320
9917
+ }
9918
+ },
9919
+ "personNames": {
9920
+ "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.",
9921
+ "minItems": 1,
9922
+ "maxItems": 5,
9923
+ "type": "array",
9924
+ "items": {
9925
+ "type": "string",
9926
+ "minLength": 1,
9927
+ "maxLength": 120,
9928
+ "pattern": "\\S"
9929
+ }
9930
+ },
9931
+ "email": {
9932
+ "description": "Exact work email address, matched through the email index.",
9933
+ "type": "string",
9934
+ "maxLength": 320,
9935
+ "format": "email",
9936
+ "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,}$"
9937
+ },
9938
+ "personCities": {
9939
+ "description": "Person cities to include. Requires personCountryCodes.",
9940
+ "minItems": 1,
9941
+ "maxItems": 50,
9942
+ "type": "array",
9943
+ "items": {
9944
+ "type": "string",
9945
+ "minLength": 1,
9946
+ "maxLength": 120,
9947
+ "pattern": "\\S"
9948
+ }
9949
+ },
9950
+ "excludePersonCities": {
9951
+ "description": "Person cities to leave out. Requires personCountryCodes.",
9952
+ "minItems": 1,
9953
+ "maxItems": 50,
9954
+ "type": "array",
9955
+ "items": {
9956
+ "type": "string",
9957
+ "minLength": 1,
9958
+ "maxLength": 120,
9959
+ "pattern": "\\S"
9960
+ }
9961
+ },
9962
+ "personStateCodes": {
9963
+ "description": "Person state or region codes to include.",
9964
+ "minItems": 1,
9965
+ "maxItems": 50,
9966
+ "type": "array",
9967
+ "items": {
9968
+ "type": "string",
9969
+ "minLength": 1,
9970
+ "maxLength": 120,
9971
+ "pattern": "\\S"
9972
+ }
9973
+ },
9974
+ "excludePersonStateCodes": {
9975
+ "description": "Person state or region codes to leave out.",
9976
+ "minItems": 1,
9977
+ "maxItems": 50,
9978
+ "type": "array",
9979
+ "items": {
9980
+ "type": "string",
9981
+ "minLength": 1,
9982
+ "maxLength": 120,
9983
+ "pattern": "\\S"
9984
+ }
9985
+ },
9986
+ "personCountryCodes": {
9987
+ "description": "Person country codes to include.",
8715
9988
  "minItems": 1,
8716
9989
  "maxItems": 50,
8717
9990
  "type": "array",
@@ -8720,8 +9993,18 @@ var TOOL_CATALOG = [
8720
9993
  "pattern": "^\\s*[a-z]{2}\\s*$"
8721
9994
  }
8722
9995
  },
8723
- "stateCodes": {
8724
- "description": "State or region codes to include.",
9996
+ "excludePersonCountryCodes": {
9997
+ "description": "Person country codes to leave out.",
9998
+ "minItems": 1,
9999
+ "maxItems": 50,
10000
+ "type": "array",
10001
+ "items": {
10002
+ "type": "string",
10003
+ "pattern": "^\\s*[a-z]{2}\\s*$"
10004
+ }
10005
+ },
10006
+ "jobCities": {
10007
+ "description": "Job cities to include. Requires jobCountryCodes.",
8725
10008
  "minItems": 1,
8726
10009
  "maxItems": 50,
8727
10010
  "type": "array",
@@ -8732,8 +10015,8 @@ var TOOL_CATALOG = [
8732
10015
  "pattern": "\\S"
8733
10016
  }
8734
10017
  },
8735
- "industries": {
8736
- "description": "Industries to include.",
10018
+ "excludeJobCities": {
10019
+ "description": "Job cities to leave out. Requires jobCountryCodes.",
8737
10020
  "minItems": 1,
8738
10021
  "maxItems": 50,
8739
10022
  "type": "array",
@@ -8744,8 +10027,42 @@ var TOOL_CATALOG = [
8744
10027
  "pattern": "\\S"
8745
10028
  }
8746
10029
  },
8747
- "excludeCountryCodes": {
8748
- "description": "Two-letter country codes to leave out.",
10030
+ "jobStateCodes": {
10031
+ "description": "Job state or region codes to include.",
10032
+ "minItems": 1,
10033
+ "maxItems": 50,
10034
+ "type": "array",
10035
+ "items": {
10036
+ "type": "string",
10037
+ "minLength": 1,
10038
+ "maxLength": 120,
10039
+ "pattern": "\\S"
10040
+ }
10041
+ },
10042
+ "excludeJobStateCodes": {
10043
+ "description": "Job state or region codes to leave out.",
10044
+ "minItems": 1,
10045
+ "maxItems": 50,
10046
+ "type": "array",
10047
+ "items": {
10048
+ "type": "string",
10049
+ "minLength": 1,
10050
+ "maxLength": 120,
10051
+ "pattern": "\\S"
10052
+ }
10053
+ },
10054
+ "jobCountryCodes": {
10055
+ "description": "Job country codes to include.",
10056
+ "minItems": 1,
10057
+ "maxItems": 50,
10058
+ "type": "array",
10059
+ "items": {
10060
+ "type": "string",
10061
+ "pattern": "^\\s*[a-z]{2}\\s*$"
10062
+ }
10063
+ },
10064
+ "excludeJobCountryCodes": {
10065
+ "description": "Job country codes to leave out.",
8749
10066
  "minItems": 1,
8750
10067
  "maxItems": 50,
8751
10068
  "type": "array",
@@ -8754,8 +10071,8 @@ var TOOL_CATALOG = [
8754
10071
  "pattern": "^\\s*[a-z]{2}\\s*$"
8755
10072
  }
8756
10073
  },
8757
- "excludeStateCodes": {
8758
- "description": "State or region codes to leave out.",
10074
+ "companyCities": {
10075
+ "description": "Company HQ cities to include. Requires countryCodes.",
8759
10076
  "minItems": 1,
8760
10077
  "maxItems": 50,
8761
10078
  "type": "array",
@@ -8766,8 +10083,8 @@ var TOOL_CATALOG = [
8766
10083
  "pattern": "\\S"
8767
10084
  }
8768
10085
  },
8769
- "excludeIndustries": {
8770
- "description": "Industries to leave out.",
10086
+ "excludeCompanyCities": {
10087
+ "description": "Company HQ cities to leave out. Requires countryCodes.",
8771
10088
  "minItems": 1,
8772
10089
  "maxItems": 50,
8773
10090
  "type": "array",
@@ -8778,32 +10095,32 @@ var TOOL_CATALOG = [
8778
10095
  "pattern": "\\S"
8779
10096
  }
8780
10097
  },
8781
- "employeeCountMin": {
8782
- "description": "Lowest employee count to include.",
10098
+ "companyFoundedYearMin": {
10099
+ "description": "Earliest company founding year.",
8783
10100
  "type": "integer",
8784
10101
  "minimum": 0,
8785
10102
  "maximum": 9007199254740991
8786
10103
  },
8787
- "employeeCountMax": {
8788
- "description": "Highest employee count to include.",
10104
+ "companyFoundedYearMax": {
10105
+ "description": "Latest company founding year.",
8789
10106
  "type": "integer",
8790
10107
  "minimum": 0,
8791
10108
  "maximum": 9007199254740991
8792
10109
  },
8793
- "revenueMinUsd": {
8794
- "description": "Lowest annual revenue to include, in US dollars.",
8795
- "type": "integer",
8796
- "minimum": 0,
8797
- "maximum": 9007199254740991
10110
+ "jobStartDateAfter": {
10111
+ "description": "Include jobs started on or after this date.",
10112
+ "type": "string",
10113
+ "format": "date",
10114
+ "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])))$"
8798
10115
  },
8799
- "revenueMaxUsd": {
8800
- "description": "Highest annual revenue to include, in US dollars.",
8801
- "type": "integer",
8802
- "minimum": 0,
8803
- "maximum": 9007199254740991
10116
+ "jobStartDateBefore": {
10117
+ "description": "Include jobs started on or before this date.",
10118
+ "type": "string",
10119
+ "format": "date",
10120
+ "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])))$"
8804
10121
  },
8805
- "naics2022Codes": {
8806
- "description": "NAICS 2022 codes to include.",
10122
+ "titleKeywords": {
10123
+ "description": "Job title keywords to match. A person can match any of them.",
8807
10124
  "minItems": 1,
8808
10125
  "maxItems": 50,
8809
10126
  "type": "array",
@@ -8814,8 +10131,8 @@ var TOOL_CATALOG = [
8814
10131
  "pattern": "\\S"
8815
10132
  }
8816
10133
  },
8817
- "excludeNaics2022Codes": {
8818
- "description": "NAICS 2022 codes to leave out.",
10134
+ "requiredTitleKeywords": {
10135
+ "description": "Job title keywords the person must match.",
8819
10136
  "minItems": 1,
8820
10137
  "maxItems": 50,
8821
10138
  "type": "array",
@@ -8826,8 +10143,24 @@ var TOOL_CATALOG = [
8826
10143
  "pattern": "\\S"
8827
10144
  }
8828
10145
  },
8829
- "fundingTypes": {
8830
- "description": "Funding round types to include.",
10146
+ "requiredTitleKeywordGroups": {
10147
+ "description": "Job title keyword groups. The person must match every group, and any keyword inside a group.",
10148
+ "maxItems": 10,
10149
+ "type": "array",
10150
+ "items": {
10151
+ "minItems": 1,
10152
+ "maxItems": 50,
10153
+ "type": "array",
10154
+ "items": {
10155
+ "type": "string",
10156
+ "minLength": 1,
10157
+ "maxLength": 120,
10158
+ "pattern": "\\S"
10159
+ }
10160
+ }
10161
+ },
10162
+ "excludeTitleKeywords": {
10163
+ "description": "Job title keywords that remove a person.",
8831
10164
  "minItems": 1,
8832
10165
  "maxItems": 50,
8833
10166
  "type": "array",
@@ -8838,8 +10171,8 @@ var TOOL_CATALOG = [
8838
10171
  "pattern": "\\S"
8839
10172
  }
8840
10173
  },
8841
- "excludeFundingTypes": {
8842
- "description": "Funding round types to leave out.",
10174
+ "jobFunctions": {
10175
+ "description": "Job functions to include.",
8843
10176
  "minItems": 1,
8844
10177
  "maxItems": 50,
8845
10178
  "type": "array",
@@ -8850,8 +10183,8 @@ var TOOL_CATALOG = [
8850
10183
  "pattern": "\\S"
8851
10184
  }
8852
10185
  },
8853
- "keywords": {
8854
- "description": "Keywords to match. A company can match any of them.",
10186
+ "excludeJobFunctions": {
10187
+ "description": "Job functions to leave out.",
8855
10188
  "minItems": 1,
8856
10189
  "maxItems": 50,
8857
10190
  "type": "array",
@@ -8862,8 +10195,8 @@ var TOOL_CATALOG = [
8862
10195
  "pattern": "\\S"
8863
10196
  }
8864
10197
  },
8865
- "requiredKeywords": {
8866
- "description": "Keywords the company must match.",
10198
+ "jobLevels": {
10199
+ "description": "Job levels to include.",
8867
10200
  "minItems": 1,
8868
10201
  "maxItems": 50,
8869
10202
  "type": "array",
@@ -8874,24 +10207,20 @@ var TOOL_CATALOG = [
8874
10207
  "pattern": "\\S"
8875
10208
  }
8876
10209
  },
8877
- "requiredKeywordGroups": {
8878
- "description": "Keyword groups. The company must match every group, and any keyword inside a group.",
8879
- "maxItems": 10,
10210
+ "excludeJobLevels": {
10211
+ "description": "Job levels to leave out.",
10212
+ "minItems": 1,
10213
+ "maxItems": 50,
8880
10214
  "type": "array",
8881
10215
  "items": {
8882
- "minItems": 1,
8883
- "maxItems": 50,
8884
- "type": "array",
8885
- "items": {
8886
- "type": "string",
8887
- "minLength": 1,
8888
- "maxLength": 120,
8889
- "pattern": "\\S"
8890
- }
10216
+ "type": "string",
10217
+ "minLength": 1,
10218
+ "maxLength": 120,
10219
+ "pattern": "\\S"
8891
10220
  }
8892
10221
  },
8893
- "excludeKeywords": {
8894
- "description": "Keywords that remove a company.",
10222
+ "gtmRoleFamilies": {
10223
+ "description": "Go-to-market role families to include.",
8895
10224
  "minItems": 1,
8896
10225
  "maxItems": 50,
8897
10226
  "type": "array",
@@ -8902,8 +10231,24 @@ var TOOL_CATALOG = [
8902
10231
  "pattern": "\\S"
8903
10232
  }
8904
10233
  },
8905
- "websiteAvailability": {
8906
- "description": "Whether the company has a website.",
10234
+ "excludeGtmRoleFamilies": {
10235
+ "description": "Go-to-market role families to leave out.",
10236
+ "minItems": 1,
10237
+ "maxItems": 50,
10238
+ "type": "array",
10239
+ "items": {
10240
+ "type": "string",
10241
+ "minLength": 1,
10242
+ "maxLength": 120,
10243
+ "pattern": "\\S"
10244
+ }
10245
+ },
10246
+ "requireVerifiedEmail": {
10247
+ "description": "When true, only people with a verified work email are returned.",
10248
+ "type": "boolean"
10249
+ },
10250
+ "emailAvailability": {
10251
+ "description": "Whether the person has an email address.",
8907
10252
  "type": "string",
8908
10253
  "enum": [
8909
10254
  "any",
@@ -8911,8 +10256,8 @@ var TOOL_CATALOG = [
8911
10256
  "missing"
8912
10257
  ]
8913
10258
  },
8914
- "linkedinAvailability": {
8915
- "description": "Whether the company has a LinkedIn page.",
10259
+ "phoneAvailability": {
10260
+ "description": "Whether the person has a phone number.",
8916
10261
  "type": "string",
8917
10262
  "enum": [
8918
10263
  "any",
@@ -8920,66 +10265,124 @@ var TOOL_CATALOG = [
8920
10265
  "missing"
8921
10266
  ]
8922
10267
  },
8923
- "fundingDateAfter": {
8924
- "description": "Include funding on or after this date.",
8925
- "type": "string",
8926
- "format": "date",
8927
- "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])))$"
8928
- },
8929
- "fundingDateBefore": {
8930
- "description": "Include funding on or before this date.",
8931
- "type": "string",
8932
- "format": "date",
8933
- "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])))$"
8934
- },
8935
- "excludeOrganizationIds": {
8936
- "description": "Opaque company ids (hdo_) to leave out.",
10268
+ "excludePersonIds": {
10269
+ "description": "Opaque person ids (hdp_) to leave out.",
8937
10270
  "maxItems": 1e3,
8938
10271
  "type": "array",
8939
10272
  "items": {
8940
10273
  "type": "string",
8941
- "pattern": "^hdo_[0-9a-f]{32}$",
8942
- "description": "Opaque company id (hdo_)."
10274
+ "pattern": "^hdp_[0-9a-f]{32}$",
10275
+ "description": "Opaque person id (hdp_)."
8943
10276
  }
8944
10277
  },
8945
- "excludeDomains": {
8946
- "description": "Website domains to leave out.",
10278
+ "excludeEmails": {
10279
+ "description": "Email addresses to leave out.",
8947
10280
  "maxItems": 1e3,
8948
10281
  "type": "array",
8949
10282
  "items": {
8950
10283
  "type": "string",
8951
- "minLength": 1,
8952
- "maxLength": 320
10284
+ "format": "email",
10285
+ "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,}$"
8953
10286
  }
8954
10287
  },
8955
- "personCities": {
8956
- "description": "Person cities to include. Requires personCountryCodes.",
8957
- "minItems": 1,
8958
- "maxItems": 50,
8959
- "type": "array",
8960
- "items": {
8961
- "type": "string",
8962
- "minLength": 1,
8963
- "maxLength": 120,
8964
- "pattern": "\\S"
8965
- }
10288
+ "limit": {
10289
+ "default": 50,
10290
+ "description": "Maximum records in this page.",
10291
+ "type": "integer",
10292
+ "minimum": 1,
10293
+ "maximum": 50
8966
10294
  },
8967
- "excludePersonCities": {
8968
- "description": "Person cities to leave out. Requires personCountryCodes.",
8969
- "minItems": 1,
8970
- "maxItems": 50,
8971
- "type": "array",
8972
- "items": {
8973
- "type": "string",
8974
- "minLength": 1,
8975
- "maxLength": 120,
8976
- "pattern": "\\S"
8977
- }
10295
+ "cursor": {
10296
+ "description": "Cursor from the previous page. Omit it for the first page.",
10297
+ "type": "string",
10298
+ "minLength": 1,
10299
+ "maxLength": 2048
8978
10300
  },
8979
- "personStateCodes": {
8980
- "description": "Person state or region codes to include.",
10301
+ "firstName": {
10302
+ "description": "First name tokens, using accent-folded fuzzy matching. Requires companyId.",
10303
+ "type": "string",
10304
+ "minLength": 1,
10305
+ "maxLength": 120,
10306
+ "pattern": "\\S"
10307
+ },
10308
+ "lastName": {
10309
+ "description": "Last name tokens, using accent-folded fuzzy matching. Requires companyId.",
10310
+ "type": "string",
10311
+ "minLength": 1,
10312
+ "maxLength": 120,
10313
+ "pattern": "\\S"
10314
+ },
10315
+ "companyId": {
10316
+ "description": "Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters.",
10317
+ "type": "string",
10318
+ "pattern": "^hdo_[0-9a-f]{32}$"
10319
+ },
10320
+ "contactLocation": {
10321
+ "description": "Contact location filters. Requires companyId.",
10322
+ "type": "object",
10323
+ "properties": {
10324
+ "countryCodes": {
10325
+ "description": "Person or job location country codes.",
10326
+ "minItems": 1,
10327
+ "maxItems": 50,
10328
+ "type": "array",
10329
+ "items": {
10330
+ "type": "string",
10331
+ "pattern": "^\\s*[a-z]{2}\\s*$"
10332
+ }
10333
+ },
10334
+ "stateCodes": {
10335
+ "description": "Person or job location state codes.",
10336
+ "minItems": 1,
10337
+ "maxItems": 50,
10338
+ "type": "array",
10339
+ "items": {
10340
+ "type": "string",
10341
+ "minLength": 1,
10342
+ "maxLength": 120,
10343
+ "pattern": "\\S"
10344
+ }
10345
+ },
10346
+ "cities": {
10347
+ "description": "Person or job location cities.",
10348
+ "minItems": 1,
10349
+ "maxItems": 50,
10350
+ "type": "array",
10351
+ "items": {
10352
+ "type": "string",
10353
+ "minLength": 1,
10354
+ "maxLength": 120,
10355
+ "pattern": "\\S"
10356
+ }
10357
+ }
10358
+ },
10359
+ "additionalProperties": false
10360
+ },
10361
+ "excludeListId": {
10362
+ "description": "Saved list whose members are left out of the result.",
10363
+ "type": "string",
10364
+ "format": "uuid",
10365
+ "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)$"
10366
+ }
10367
+ },
10368
+ "additionalProperties": false
10369
+ }
10370
+ },
10371
+ {
10372
+ "name": "search.preview_company_count",
10373
+ "description": "Cheap live company count from the release rollup only, before suppression. Refinements not covered by the rollup produce a baseline.",
10374
+ "risk": "read",
10375
+ "scopes": [
10376
+ "data:read"
10377
+ ],
10378
+ "input": {
10379
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
10380
+ "type": "object",
10381
+ "properties": {
10382
+ "companyNames": {
10383
+ "description": "Company name prefixes. Match any name.",
8981
10384
  "minItems": 1,
8982
- "maxItems": 50,
10385
+ "maxItems": 5,
8983
10386
  "type": "array",
8984
10387
  "items": {
8985
10388
  "type": "string",
@@ -8988,10 +10391,10 @@ var TOOL_CATALOG = [
8988
10391
  "pattern": "\\S"
8989
10392
  }
8990
10393
  },
8991
- "excludePersonStateCodes": {
8992
- "description": "Person state or region codes to leave out.",
10394
+ "excludeCompanyNames": {
10395
+ "description": "Company name prefixes to leave out.",
8993
10396
  "minItems": 1,
8994
- "maxItems": 50,
10397
+ "maxItems": 5,
8995
10398
  "type": "array",
8996
10399
  "items": {
8997
10400
  "type": "string",
@@ -9000,8 +10403,14 @@ var TOOL_CATALOG = [
9000
10403
  "pattern": "\\S"
9001
10404
  }
9002
10405
  },
9003
- "personCountryCodes": {
9004
- "description": "Person country codes to include.",
10406
+ "domain": {
10407
+ "description": "Company website domain. Exact host matching; root sites rank first.",
10408
+ "type": "string",
10409
+ "minLength": 1,
10410
+ "maxLength": 320
10411
+ },
10412
+ "countryCodes": {
10413
+ "description": "Two-letter country codes to include.",
9005
10414
  "minItems": 1,
9006
10415
  "maxItems": 50,
9007
10416
  "type": "array",
@@ -9010,18 +10419,20 @@ var TOOL_CATALOG = [
9010
10419
  "pattern": "^\\s*[a-z]{2}\\s*$"
9011
10420
  }
9012
10421
  },
9013
- "excludePersonCountryCodes": {
9014
- "description": "Person country codes to leave out.",
10422
+ "stateCodes": {
10423
+ "description": "State or region codes to include.",
9015
10424
  "minItems": 1,
9016
10425
  "maxItems": 50,
9017
10426
  "type": "array",
9018
10427
  "items": {
9019
10428
  "type": "string",
9020
- "pattern": "^\\s*[a-z]{2}\\s*$"
10429
+ "minLength": 1,
10430
+ "maxLength": 120,
10431
+ "pattern": "\\S"
9021
10432
  }
9022
10433
  },
9023
- "jobCities": {
9024
- "description": "Job cities to include. Requires jobCountryCodes.",
10434
+ "cities": {
10435
+ "description": "Company HQ cities to include. Requires countryCodes.",
9025
10436
  "minItems": 1,
9026
10437
  "maxItems": 50,
9027
10438
  "type": "array",
@@ -9032,8 +10443,8 @@ var TOOL_CATALOG = [
9032
10443
  "pattern": "\\S"
9033
10444
  }
9034
10445
  },
9035
- "excludeJobCities": {
9036
- "description": "Job cities to leave out. Requires jobCountryCodes.",
10446
+ "excludeCities": {
10447
+ "description": "Company HQ cities to leave out. Requires countryCodes.",
9037
10448
  "minItems": 1,
9038
10449
  "maxItems": 50,
9039
10450
  "type": "array",
@@ -9044,8 +10455,8 @@ var TOOL_CATALOG = [
9044
10455
  "pattern": "\\S"
9045
10456
  }
9046
10457
  },
9047
- "jobStateCodes": {
9048
- "description": "Job state or region codes to include.",
10458
+ "postcodes": {
10459
+ "description": "Company HQ postcode prefixes to include.",
9049
10460
  "minItems": 1,
9050
10461
  "maxItems": 50,
9051
10462
  "type": "array",
@@ -9056,8 +10467,8 @@ var TOOL_CATALOG = [
9056
10467
  "pattern": "\\S"
9057
10468
  }
9058
10469
  },
9059
- "excludeJobStateCodes": {
9060
- "description": "Job state or region codes to leave out.",
10470
+ "excludePostcodes": {
10471
+ "description": "Company HQ postcode prefixes to leave out.",
9061
10472
  "minItems": 1,
9062
10473
  "maxItems": 50,
9063
10474
  "type": "array",
@@ -9068,18 +10479,44 @@ var TOOL_CATALOG = [
9068
10479
  "pattern": "\\S"
9069
10480
  }
9070
10481
  },
9071
- "jobCountryCodes": {
9072
- "description": "Job country codes to include.",
10482
+ "foundedYearMin": {
10483
+ "description": "Earliest company founding year.",
10484
+ "type": "integer",
10485
+ "minimum": 0,
10486
+ "maximum": 9007199254740991
10487
+ },
10488
+ "foundedYearMax": {
10489
+ "description": "Latest company founding year.",
10490
+ "type": "integer",
10491
+ "minimum": 0,
10492
+ "maximum": 9007199254740991
10493
+ },
10494
+ "totalFundingMinUsd": {
10495
+ "description": "Lowest total company funding, in US dollars.",
10496
+ "type": "integer",
10497
+ "minimum": 0,
10498
+ "maximum": 9007199254740991
10499
+ },
10500
+ "totalFundingMaxUsd": {
10501
+ "description": "Highest total company funding, in US dollars.",
10502
+ "type": "integer",
10503
+ "minimum": 0,
10504
+ "maximum": 9007199254740991
10505
+ },
10506
+ "industries": {
10507
+ "description": "Industries to include.",
9073
10508
  "minItems": 1,
9074
10509
  "maxItems": 50,
9075
10510
  "type": "array",
9076
10511
  "items": {
9077
10512
  "type": "string",
9078
- "pattern": "^\\s*[a-z]{2}\\s*$"
10513
+ "minLength": 1,
10514
+ "maxLength": 120,
10515
+ "pattern": "\\S"
9079
10516
  }
9080
10517
  },
9081
- "excludeJobCountryCodes": {
9082
- "description": "Job country codes to leave out.",
10518
+ "excludeCountryCodes": {
10519
+ "description": "Two-letter country codes to leave out.",
9083
10520
  "minItems": 1,
9084
10521
  "maxItems": 50,
9085
10522
  "type": "array",
@@ -9088,8 +10525,8 @@ var TOOL_CATALOG = [
9088
10525
  "pattern": "^\\s*[a-z]{2}\\s*$"
9089
10526
  }
9090
10527
  },
9091
- "companyCities": {
9092
- "description": "Company HQ cities to include. Requires countryCodes.",
10528
+ "excludeStateCodes": {
10529
+ "description": "State or region codes to leave out.",
9093
10530
  "minItems": 1,
9094
10531
  "maxItems": 50,
9095
10532
  "type": "array",
@@ -9100,8 +10537,8 @@ var TOOL_CATALOG = [
9100
10537
  "pattern": "\\S"
9101
10538
  }
9102
10539
  },
9103
- "excludeCompanyCities": {
9104
- "description": "Company HQ cities to leave out. Requires countryCodes.",
10540
+ "excludeIndustries": {
10541
+ "description": "Industries to leave out.",
9105
10542
  "minItems": 1,
9106
10543
  "maxItems": 50,
9107
10544
  "type": "array",
@@ -9112,84 +10549,52 @@ var TOOL_CATALOG = [
9112
10549
  "pattern": "\\S"
9113
10550
  }
9114
10551
  },
9115
- "companyFoundedYearMin": {
9116
- "description": "Earliest company founding year.",
10552
+ "employeeCountMin": {
10553
+ "description": "Lowest employee count to include.",
9117
10554
  "type": "integer",
9118
10555
  "minimum": 0,
9119
10556
  "maximum": 9007199254740991
9120
10557
  },
9121
- "companyFoundedYearMax": {
9122
- "description": "Latest company founding year.",
10558
+ "employeeCountMax": {
10559
+ "description": "Highest employee count to include.",
9123
10560
  "type": "integer",
9124
10561
  "minimum": 0,
9125
10562
  "maximum": 9007199254740991
9126
10563
  },
9127
- "jobStartDateAfter": {
9128
- "description": "Include jobs started on or after this date.",
9129
- "type": "string",
9130
- "format": "date",
9131
- "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])))$"
9132
- },
9133
- "jobStartDateBefore": {
9134
- "description": "Include jobs started on or before this date.",
9135
- "type": "string",
9136
- "format": "date",
9137
- "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])))$"
10564
+ "revenueMinUsd": {
10565
+ "description": "Lowest annual revenue to include, in US dollars.",
10566
+ "type": "integer",
10567
+ "minimum": 0,
10568
+ "maximum": 9007199254740991
9138
10569
  },
9139
- "titleKeywords": {
9140
- "description": "Job title keywords to match. A person can match any of them.",
9141
- "minItems": 1,
9142
- "maxItems": 50,
9143
- "type": "array",
9144
- "items": {
9145
- "type": "string",
9146
- "minLength": 1,
9147
- "maxLength": 120,
9148
- "pattern": "\\S"
9149
- }
10570
+ "revenueMaxUsd": {
10571
+ "description": "Highest annual revenue to include, in US dollars.",
10572
+ "type": "integer",
10573
+ "minimum": 0,
10574
+ "maximum": 9007199254740991
9150
10575
  },
9151
- "requiredTitleKeywords": {
9152
- "description": "Job title keywords the person must match.",
10576
+ "naics2022Codes": {
10577
+ "description": "NAICS 2022 codes to include.",
9153
10578
  "minItems": 1,
9154
10579
  "maxItems": 50,
9155
10580
  "type": "array",
9156
10581
  "items": {
9157
10582
  "type": "string",
9158
- "minLength": 1,
9159
- "maxLength": 120,
9160
- "pattern": "\\S"
9161
- }
9162
- },
9163
- "requiredTitleKeywordGroups": {
9164
- "description": "Job title keyword groups. The person must match every group, and any keyword inside a group.",
9165
- "maxItems": 10,
9166
- "type": "array",
9167
- "items": {
9168
- "minItems": 1,
9169
- "maxItems": 50,
9170
- "type": "array",
9171
- "items": {
9172
- "type": "string",
9173
- "minLength": 1,
9174
- "maxLength": 120,
9175
- "pattern": "\\S"
9176
- }
10583
+ "pattern": "^[0-9]{6}$"
9177
10584
  }
9178
10585
  },
9179
- "excludeTitleKeywords": {
9180
- "description": "Job title keywords that remove a person.",
10586
+ "excludeNaics2022Codes": {
10587
+ "description": "NAICS 2022 codes to leave out.",
9181
10588
  "minItems": 1,
9182
10589
  "maxItems": 50,
9183
10590
  "type": "array",
9184
10591
  "items": {
9185
10592
  "type": "string",
9186
- "minLength": 1,
9187
- "maxLength": 120,
9188
- "pattern": "\\S"
10593
+ "pattern": "^[0-9]{6}$"
9189
10594
  }
9190
10595
  },
9191
- "jobFunctions": {
9192
- "description": "Job functions to include.",
10596
+ "fundingTypes": {
10597
+ "description": "Funding round types to include.",
9193
10598
  "minItems": 1,
9194
10599
  "maxItems": 50,
9195
10600
  "type": "array",
@@ -9200,8 +10605,8 @@ var TOOL_CATALOG = [
9200
10605
  "pattern": "\\S"
9201
10606
  }
9202
10607
  },
9203
- "excludeJobFunctions": {
9204
- "description": "Job functions to leave out.",
10608
+ "excludeFundingTypes": {
10609
+ "description": "Funding round types to leave out.",
9205
10610
  "minItems": 1,
9206
10611
  "maxItems": 50,
9207
10612
  "type": "array",
@@ -9212,8 +10617,8 @@ var TOOL_CATALOG = [
9212
10617
  "pattern": "\\S"
9213
10618
  }
9214
10619
  },
9215
- "jobLevels": {
9216
- "description": "Job levels to include.",
10620
+ "keywords": {
10621
+ "description": "Keywords to match. A company can match any of them.",
9217
10622
  "minItems": 1,
9218
10623
  "maxItems": 50,
9219
10624
  "type": "array",
@@ -9224,8 +10629,8 @@ var TOOL_CATALOG = [
9224
10629
  "pattern": "\\S"
9225
10630
  }
9226
10631
  },
9227
- "excludeJobLevels": {
9228
- "description": "Job levels to leave out.",
10632
+ "requiredKeywords": {
10633
+ "description": "Keywords the company must match.",
9229
10634
  "minItems": 1,
9230
10635
  "maxItems": 50,
9231
10636
  "type": "array",
@@ -9236,20 +10641,24 @@ var TOOL_CATALOG = [
9236
10641
  "pattern": "\\S"
9237
10642
  }
9238
10643
  },
9239
- "gtmRoleFamilies": {
9240
- "description": "Go-to-market role families to include.",
9241
- "minItems": 1,
9242
- "maxItems": 50,
10644
+ "requiredKeywordGroups": {
10645
+ "description": "Keyword groups. The company must match every group, and any keyword inside a group.",
10646
+ "maxItems": 10,
9243
10647
  "type": "array",
9244
10648
  "items": {
9245
- "type": "string",
9246
- "minLength": 1,
9247
- "maxLength": 120,
9248
- "pattern": "\\S"
10649
+ "minItems": 1,
10650
+ "maxItems": 50,
10651
+ "type": "array",
10652
+ "items": {
10653
+ "type": "string",
10654
+ "minLength": 1,
10655
+ "maxLength": 120,
10656
+ "pattern": "\\S"
10657
+ }
9249
10658
  }
9250
10659
  },
9251
- "excludeGtmRoleFamilies": {
9252
- "description": "Go-to-market role families to leave out.",
10660
+ "excludeKeywords": {
10661
+ "description": "Keywords that remove a company.",
9253
10662
  "minItems": 1,
9254
10663
  "maxItems": 50,
9255
10664
  "type": "array",
@@ -9260,12 +10669,8 @@ var TOOL_CATALOG = [
9260
10669
  "pattern": "\\S"
9261
10670
  }
9262
10671
  },
9263
- "requireVerifiedEmail": {
9264
- "description": "When true, only people with a verified work email are returned.",
9265
- "type": "boolean"
9266
- },
9267
- "emailAvailability": {
9268
- "description": "Whether the person has an email address.",
10672
+ "websiteAvailability": {
10673
+ "description": "Whether the company has a website.",
9269
10674
  "type": "string",
9270
10675
  "enum": [
9271
10676
  "any",
@@ -9273,8 +10678,8 @@ var TOOL_CATALOG = [
9273
10678
  "missing"
9274
10679
  ]
9275
10680
  },
9276
- "phoneAvailability": {
9277
- "description": "Whether the person has a phone number.",
10681
+ "linkedinAvailability": {
10682
+ "description": "Whether the company has a LinkedIn page.",
9278
10683
  "type": "string",
9279
10684
  "enum": [
9280
10685
  "any",
@@ -9282,90 +10687,718 @@ var TOOL_CATALOG = [
9282
10687
  "missing"
9283
10688
  ]
9284
10689
  },
9285
- "excludePersonIds": {
9286
- "description": "Opaque person ids (hdp_) to leave out.",
9287
- "maxItems": 1e3,
9288
- "type": "array",
9289
- "items": {
9290
- "type": "string",
9291
- "pattern": "^hdp_[0-9a-f]{32}$",
9292
- "description": "Opaque person id (hdp_)."
9293
- }
10690
+ "fundingDateAfter": {
10691
+ "description": "Include funding on or after this date.",
10692
+ "type": "string",
10693
+ "format": "date",
10694
+ "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])))$"
9294
10695
  },
9295
- "excludeEmails": {
9296
- "description": "Email addresses to leave out.",
10696
+ "fundingDateBefore": {
10697
+ "description": "Include funding on or before this date.",
10698
+ "type": "string",
10699
+ "format": "date",
10700
+ "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])))$"
10701
+ },
10702
+ "excludeOrganizationIds": {
10703
+ "description": "Opaque company ids (hdo_) to leave out.",
9297
10704
  "maxItems": 1e3,
9298
10705
  "type": "array",
9299
10706
  "items": {
9300
10707
  "type": "string",
9301
- "format": "email",
9302
- "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,}$"
10708
+ "pattern": "^hdo_[0-9a-f]{32}$",
10709
+ "description": "Opaque company id (hdo_)."
9303
10710
  }
9304
10711
  },
9305
- "limit": {
9306
- "default": 50,
9307
- "description": "Maximum records in this page.",
9308
- "type": "integer",
9309
- "minimum": 1,
9310
- "maximum": 50
9311
- },
9312
- "cursor": {
9313
- "description": "Cursor from the previous page. Omit it for the first page.",
9314
- "type": "string",
9315
- "minLength": 1,
9316
- "maxLength": 2048
9317
- },
9318
- "companyId": {
9319
- "description": "Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters.",
9320
- "type": "string",
9321
- "pattern": "^hdo_[0-9a-f]{32}$"
10712
+ "excludeDomains": {
10713
+ "description": "Website domains to leave out.",
10714
+ "maxItems": 1e3,
10715
+ "type": "array",
10716
+ "items": {
10717
+ "type": "string",
10718
+ "minLength": 1,
10719
+ "maxLength": 320
10720
+ }
9322
10721
  },
9323
- "contactLocation": {
9324
- "description": "Contact location filters. Requires companyId.",
10722
+ "insights": {
10723
+ "description": "Insights filters. Supply at least one.",
9325
10724
  "type": "object",
9326
10725
  "properties": {
9327
- "countryCodes": {
9328
- "description": "Person or job location country codes.",
10726
+ "monthlyOrganicTraffic": {
10727
+ "description": "Monthly organic visits.",
10728
+ "type": "object",
10729
+ "properties": {
10730
+ "min": {
10731
+ "description": "Lower bound, inclusive.",
10732
+ "type": "number",
10733
+ "minimum": 0
10734
+ },
10735
+ "max": {
10736
+ "description": "Upper bound, inclusive.",
10737
+ "type": "number",
10738
+ "minimum": 0
10739
+ }
10740
+ },
10741
+ "additionalProperties": false
10742
+ },
10743
+ "monthlyPaidTraffic": {
10744
+ "description": "Monthly paid visits.",
10745
+ "type": "object",
10746
+ "properties": {
10747
+ "min": {
10748
+ "description": "Lower bound, inclusive.",
10749
+ "type": "number",
10750
+ "minimum": 0
10751
+ },
10752
+ "max": {
10753
+ "description": "Upper bound, inclusive.",
10754
+ "type": "number",
10755
+ "minimum": 0
10756
+ }
10757
+ },
10758
+ "additionalProperties": false
10759
+ },
10760
+ "totalMonthlyTraffic": {
10761
+ "description": "Monthly visits, organic and paid.",
10762
+ "type": "object",
10763
+ "properties": {
10764
+ "min": {
10765
+ "description": "Lower bound, inclusive.",
10766
+ "type": "number",
10767
+ "minimum": 0
10768
+ },
10769
+ "max": {
10770
+ "description": "Upper bound, inclusive.",
10771
+ "type": "number",
10772
+ "minimum": 0
10773
+ }
10774
+ },
10775
+ "additionalProperties": false
10776
+ },
10777
+ "monthlyGoogleAdSpendCents": {
10778
+ "description": "Monthly Google ad spend, in cents.",
10779
+ "type": "object",
10780
+ "properties": {
10781
+ "min": {
10782
+ "description": "Lower bound, inclusive, in cents.",
10783
+ "type": "integer",
10784
+ "minimum": 0,
10785
+ "maximum": 9007199254740991
10786
+ },
10787
+ "max": {
10788
+ "description": "Upper bound, inclusive, in cents.",
10789
+ "type": "integer",
10790
+ "minimum": 0,
10791
+ "maximum": 9007199254740991
10792
+ }
10793
+ },
10794
+ "additionalProperties": false
10795
+ },
10796
+ "lastFundingAmountCents": {
10797
+ "description": "Latest funding round amount, in cents.",
10798
+ "type": "object",
10799
+ "properties": {
10800
+ "min": {
10801
+ "description": "Lower bound, inclusive, in cents.",
10802
+ "type": "integer",
10803
+ "minimum": 0,
10804
+ "maximum": 9007199254740991
10805
+ },
10806
+ "max": {
10807
+ "description": "Upper bound, inclusive, in cents.",
10808
+ "type": "integer",
10809
+ "minimum": 0,
10810
+ "maximum": 9007199254740991
10811
+ }
10812
+ },
10813
+ "additionalProperties": false
10814
+ },
10815
+ "totalFundingAmountCents": {
10816
+ "description": "Total funding raised, in cents.",
10817
+ "type": "object",
10818
+ "properties": {
10819
+ "min": {
10820
+ "description": "Lower bound, inclusive, in cents.",
10821
+ "type": "integer",
10822
+ "minimum": 0,
10823
+ "maximum": 9007199254740991
10824
+ },
10825
+ "max": {
10826
+ "description": "Upper bound, inclusive, in cents.",
10827
+ "type": "integer",
10828
+ "minimum": 0,
10829
+ "maximum": 9007199254740991
10830
+ }
10831
+ },
10832
+ "additionalProperties": false
10833
+ },
10834
+ "employeeGrowthRate": {
10835
+ "description": "Employee growth rate, as reported in the release. Negative values include shrinking teams.",
10836
+ "type": "object",
10837
+ "properties": {
10838
+ "min": {
10839
+ "description": "Lower bound, inclusive, for the reported growth rate.",
10840
+ "type": "number"
10841
+ },
10842
+ "max": {
10843
+ "description": "Upper bound, inclusive, for the reported growth rate.",
10844
+ "type": "number"
10845
+ }
10846
+ },
10847
+ "additionalProperties": false
10848
+ },
10849
+ "accountExecutiveOpenRoles": {
10850
+ "description": "Account executive open roles.",
10851
+ "type": "object",
10852
+ "properties": {
10853
+ "min": {
10854
+ "description": "Minimum open roles, inclusive.",
10855
+ "type": "integer",
10856
+ "minimum": 0,
10857
+ "maximum": 9007199254740991
10858
+ },
10859
+ "max": {
10860
+ "description": "Maximum open roles, inclusive.",
10861
+ "type": "integer",
10862
+ "minimum": 0,
10863
+ "maximum": 9007199254740991
10864
+ }
10865
+ },
10866
+ "additionalProperties": false
10867
+ },
10868
+ "businessDevelopmentOpenRoles": {
10869
+ "description": "Business development open roles.",
10870
+ "type": "object",
10871
+ "properties": {
10872
+ "min": {
10873
+ "description": "Minimum open roles, inclusive.",
10874
+ "type": "integer",
10875
+ "minimum": 0,
10876
+ "maximum": 9007199254740991
10877
+ },
10878
+ "max": {
10879
+ "description": "Maximum open roles, inclusive.",
10880
+ "type": "integer",
10881
+ "minimum": 0,
10882
+ "maximum": 9007199254740991
10883
+ }
10884
+ },
10885
+ "additionalProperties": false
10886
+ },
10887
+ "customerSuccessOpenRoles": {
10888
+ "description": "Customer success open roles.",
10889
+ "type": "object",
10890
+ "properties": {
10891
+ "min": {
10892
+ "description": "Minimum open roles, inclusive.",
10893
+ "type": "integer",
10894
+ "minimum": 0,
10895
+ "maximum": 9007199254740991
10896
+ },
10897
+ "max": {
10898
+ "description": "Maximum open roles, inclusive.",
10899
+ "type": "integer",
10900
+ "minimum": 0,
10901
+ "maximum": 9007199254740991
10902
+ }
10903
+ },
10904
+ "additionalProperties": false
10905
+ },
10906
+ "demandGenerationOpenRoles": {
10907
+ "description": "Demand generation open roles.",
10908
+ "type": "object",
10909
+ "properties": {
10910
+ "min": {
10911
+ "description": "Minimum open roles, inclusive.",
10912
+ "type": "integer",
10913
+ "minimum": 0,
10914
+ "maximum": 9007199254740991
10915
+ },
10916
+ "max": {
10917
+ "description": "Maximum open roles, inclusive.",
10918
+ "type": "integer",
10919
+ "minimum": 0,
10920
+ "maximum": 9007199254740991
10921
+ }
10922
+ },
10923
+ "additionalProperties": false
10924
+ },
10925
+ "devopsOpenRoles": {
10926
+ "description": "DevOps open roles.",
10927
+ "type": "object",
10928
+ "properties": {
10929
+ "min": {
10930
+ "description": "Minimum open roles, inclusive.",
10931
+ "type": "integer",
10932
+ "minimum": 0,
10933
+ "maximum": 9007199254740991
10934
+ },
10935
+ "max": {
10936
+ "description": "Maximum open roles, inclusive.",
10937
+ "type": "integer",
10938
+ "minimum": 0,
10939
+ "maximum": 9007199254740991
10940
+ }
10941
+ },
10942
+ "additionalProperties": false
10943
+ },
10944
+ "grcOpenRoles": {
10945
+ "description": "Governance, risk and compliance open roles.",
10946
+ "type": "object",
10947
+ "properties": {
10948
+ "min": {
10949
+ "description": "Minimum open roles, inclusive.",
10950
+ "type": "integer",
10951
+ "minimum": 0,
10952
+ "maximum": 9007199254740991
10953
+ },
10954
+ "max": {
10955
+ "description": "Maximum open roles, inclusive.",
10956
+ "type": "integer",
10957
+ "minimum": 0,
10958
+ "maximum": 9007199254740991
10959
+ }
10960
+ },
10961
+ "additionalProperties": false
10962
+ },
10963
+ "itOpenRoles": {
10964
+ "description": "IT 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
+ "marketingOpenRoles": {
10983
+ "description": "Marketing 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
+ "networkInfrastructureOpenRoles": {
11002
+ "description": "Network infrastructure 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
+ "operationsOpenRoles": {
11021
+ "description": "Operations 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
+ "salesOpenRoles": {
11040
+ "description": "Sales 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
+ "securityOpenRoles": {
11059
+ "description": "Security 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
+ "appStoreRating": {
11078
+ "description": "Apple App Store rating, from 0 to 5.",
11079
+ "type": "object",
11080
+ "properties": {
11081
+ "min": {
11082
+ "description": "Minimum rating, inclusive, from 0 to 5.",
11083
+ "type": "number",
11084
+ "minimum": 0,
11085
+ "maximum": 5
11086
+ },
11087
+ "max": {
11088
+ "description": "Maximum rating, inclusive, from 0 to 5.",
11089
+ "type": "number",
11090
+ "minimum": 0,
11091
+ "maximum": 5
11092
+ }
11093
+ },
11094
+ "additionalProperties": false
11095
+ },
11096
+ "playStoreRating": {
11097
+ "description": "Google Play rating, from 0 to 5.",
11098
+ "type": "object",
11099
+ "properties": {
11100
+ "min": {
11101
+ "description": "Minimum rating, inclusive, from 0 to 5.",
11102
+ "type": "number",
11103
+ "minimum": 0,
11104
+ "maximum": 5
11105
+ },
11106
+ "max": {
11107
+ "description": "Maximum rating, inclusive, from 0 to 5.",
11108
+ "type": "number",
11109
+ "minimum": 0,
11110
+ "maximum": 5
11111
+ }
11112
+ },
11113
+ "additionalProperties": false
11114
+ },
11115
+ "crmTechnology": {
11116
+ "description": "CRM product names. Match any reported product, ignoring case and surrounding spaces.",
11117
+ "minItems": 1,
11118
+ "maxItems": 100,
11119
+ "type": "array",
11120
+ "items": {
11121
+ "type": "string",
11122
+ "minLength": 1,
11123
+ "maxLength": 200
11124
+ }
11125
+ },
11126
+ "excludeCrmTechnology": {
11127
+ "description": "Exclude CRM product names. Companies with no reported product remain included.",
11128
+ "minItems": 1,
11129
+ "maxItems": 100,
11130
+ "type": "array",
11131
+ "items": {
11132
+ "type": "string",
11133
+ "minLength": 1,
11134
+ "maxLength": 200
11135
+ }
11136
+ },
11137
+ "marketingAutomationTechnology": {
11138
+ "description": "Marketing automation product names. Match any reported product, ignoring case and surrounding spaces.",
11139
+ "minItems": 1,
11140
+ "maxItems": 100,
11141
+ "type": "array",
11142
+ "items": {
11143
+ "type": "string",
11144
+ "minLength": 1,
11145
+ "maxLength": 200
11146
+ }
11147
+ },
11148
+ "excludeMarketingAutomationTechnology": {
11149
+ "description": "Exclude Marketing automation product names. Companies with no reported product remain included.",
11150
+ "minItems": 1,
11151
+ "maxItems": 100,
11152
+ "type": "array",
11153
+ "items": {
11154
+ "type": "string",
11155
+ "minLength": 1,
11156
+ "maxLength": 200
11157
+ }
11158
+ },
11159
+ "abmTechnology": {
11160
+ "description": "ABM product names. Match any reported product, ignoring case and surrounding spaces.",
11161
+ "minItems": 1,
11162
+ "maxItems": 100,
11163
+ "type": "array",
11164
+ "items": {
11165
+ "type": "string",
11166
+ "minLength": 1,
11167
+ "maxLength": 200
11168
+ }
11169
+ },
11170
+ "excludeAbmTechnology": {
11171
+ "description": "Exclude ABM product names. Companies with no reported product remain included.",
11172
+ "minItems": 1,
11173
+ "maxItems": 100,
11174
+ "type": "array",
11175
+ "items": {
11176
+ "type": "string",
11177
+ "minLength": 1,
11178
+ "maxLength": 200
11179
+ }
11180
+ },
11181
+ "salesAutomationTechnology": {
11182
+ "description": "Sales automation product names. Match any reported product, ignoring case and surrounding spaces.",
11183
+ "minItems": 1,
11184
+ "maxItems": 100,
11185
+ "type": "array",
11186
+ "items": {
11187
+ "type": "string",
11188
+ "minLength": 1,
11189
+ "maxLength": 200
11190
+ }
11191
+ },
11192
+ "excludeSalesAutomationTechnology": {
11193
+ "description": "Exclude Sales automation product names. Companies with no reported product remain included.",
11194
+ "minItems": 1,
11195
+ "maxItems": 100,
11196
+ "type": "array",
11197
+ "items": {
11198
+ "type": "string",
11199
+ "minLength": 1,
11200
+ "maxLength": 200
11201
+ }
11202
+ },
11203
+ "analyticsTechnology": {
11204
+ "description": "Analytics product names. Match any reported product, ignoring case and surrounding spaces.",
11205
+ "minItems": 1,
11206
+ "maxItems": 100,
11207
+ "type": "array",
11208
+ "items": {
11209
+ "type": "string",
11210
+ "minLength": 1,
11211
+ "maxLength": 200
11212
+ }
11213
+ },
11214
+ "excludeAnalyticsTechnology": {
11215
+ "description": "Exclude Analytics product names. Companies with no reported product remain included.",
11216
+ "minItems": 1,
11217
+ "maxItems": 100,
11218
+ "type": "array",
11219
+ "items": {
11220
+ "type": "string",
11221
+ "minLength": 1,
11222
+ "maxLength": 200
11223
+ }
11224
+ },
11225
+ "cmsTechnology": {
11226
+ "description": "CMS product names. Match any reported product, ignoring case and surrounding spaces.",
9329
11227
  "minItems": 1,
9330
- "maxItems": 50,
11228
+ "maxItems": 100,
9331
11229
  "type": "array",
9332
11230
  "items": {
9333
11231
  "type": "string",
9334
- "pattern": "^\\s*[a-z]{2}\\s*$"
11232
+ "minLength": 1,
11233
+ "maxLength": 200
9335
11234
  }
9336
11235
  },
9337
- "stateCodes": {
9338
- "description": "Person or job location state codes.",
11236
+ "excludeCmsTechnology": {
11237
+ "description": "Exclude CMS product names. Companies with no reported product remain included.",
9339
11238
  "minItems": 1,
9340
- "maxItems": 50,
11239
+ "maxItems": 100,
9341
11240
  "type": "array",
9342
11241
  "items": {
9343
11242
  "type": "string",
9344
11243
  "minLength": 1,
9345
- "maxLength": 120,
9346
- "pattern": "\\S"
11244
+ "maxLength": 200
9347
11245
  }
9348
11246
  },
9349
- "cities": {
9350
- "description": "Person or job location cities.",
11247
+ "cloudProviderTechnology": {
11248
+ "description": "Cloud provider product names. Match any reported product, ignoring case and surrounding spaces.",
9351
11249
  "minItems": 1,
9352
- "maxItems": 50,
11250
+ "maxItems": 100,
9353
11251
  "type": "array",
9354
11252
  "items": {
9355
11253
  "type": "string",
9356
11254
  "minLength": 1,
9357
- "maxLength": 120,
9358
- "pattern": "\\S"
11255
+ "maxLength": 200
11256
+ }
11257
+ },
11258
+ "excludeCloudProviderTechnology": {
11259
+ "description": "Exclude Cloud provider product names. Companies with no reported product remain included.",
11260
+ "minItems": 1,
11261
+ "maxItems": 100,
11262
+ "type": "array",
11263
+ "items": {
11264
+ "type": "string",
11265
+ "minLength": 1,
11266
+ "maxLength": 200
11267
+ }
11268
+ },
11269
+ "ecommerceTechnology": {
11270
+ "description": "Ecommerce product names. Match any reported product, ignoring case and surrounding spaces.",
11271
+ "minItems": 1,
11272
+ "maxItems": 100,
11273
+ "type": "array",
11274
+ "items": {
11275
+ "type": "string",
11276
+ "minLength": 1,
11277
+ "maxLength": 200
11278
+ }
11279
+ },
11280
+ "excludeEcommerceTechnology": {
11281
+ "description": "Exclude Ecommerce product names. Companies with no reported product remain included.",
11282
+ "minItems": 1,
11283
+ "maxItems": 100,
11284
+ "type": "array",
11285
+ "items": {
11286
+ "type": "string",
11287
+ "minLength": 1,
11288
+ "maxLength": 200
11289
+ }
11290
+ },
11291
+ "erpTechnology": {
11292
+ "description": "ERP product names. Match any reported product, ignoring case and surrounding spaces.",
11293
+ "minItems": 1,
11294
+ "maxItems": 100,
11295
+ "type": "array",
11296
+ "items": {
11297
+ "type": "string",
11298
+ "minLength": 1,
11299
+ "maxLength": 200
11300
+ }
11301
+ },
11302
+ "excludeErpTechnology": {
11303
+ "description": "Exclude ERP product names. Companies with no reported product remain included.",
11304
+ "minItems": 1,
11305
+ "maxItems": 100,
11306
+ "type": "array",
11307
+ "items": {
11308
+ "type": "string",
11309
+ "minLength": 1,
11310
+ "maxLength": 200
11311
+ }
11312
+ },
11313
+ "applicationSecurityTechnology": {
11314
+ "description": "Application security product names. Match any reported product, ignoring case and surrounding spaces.",
11315
+ "minItems": 1,
11316
+ "maxItems": 100,
11317
+ "type": "array",
11318
+ "items": {
11319
+ "type": "string",
11320
+ "minLength": 1,
11321
+ "maxLength": 200
11322
+ }
11323
+ },
11324
+ "excludeApplicationSecurityTechnology": {
11325
+ "description": "Exclude Application security product names. Companies with no reported product remain included.",
11326
+ "minItems": 1,
11327
+ "maxItems": 100,
11328
+ "type": "array",
11329
+ "items": {
11330
+ "type": "string",
11331
+ "minLength": 1,
11332
+ "maxLength": 200
11333
+ }
11334
+ },
11335
+ "cloudSecurityTechnology": {
11336
+ "description": "Cloud security product names. Match any reported product, ignoring case and surrounding spaces.",
11337
+ "minItems": 1,
11338
+ "maxItems": 100,
11339
+ "type": "array",
11340
+ "items": {
11341
+ "type": "string",
11342
+ "minLength": 1,
11343
+ "maxLength": 200
11344
+ }
11345
+ },
11346
+ "excludeCloudSecurityTechnology": {
11347
+ "description": "Exclude Cloud security product names. Companies with no reported product remain included.",
11348
+ "minItems": 1,
11349
+ "maxItems": 100,
11350
+ "type": "array",
11351
+ "items": {
11352
+ "type": "string",
11353
+ "minLength": 1,
11354
+ "maxLength": 200
11355
+ }
11356
+ },
11357
+ "emailSecurityTechnology": {
11358
+ "description": "Email security product names. Match any reported product, ignoring case and surrounding spaces.",
11359
+ "minItems": 1,
11360
+ "maxItems": 100,
11361
+ "type": "array",
11362
+ "items": {
11363
+ "type": "string",
11364
+ "minLength": 1,
11365
+ "maxLength": 200
11366
+ }
11367
+ },
11368
+ "excludeEmailSecurityTechnology": {
11369
+ "description": "Exclude Email security product names. Companies with no reported product remain included.",
11370
+ "minItems": 1,
11371
+ "maxItems": 100,
11372
+ "type": "array",
11373
+ "items": {
11374
+ "type": "string",
11375
+ "minLength": 1,
11376
+ "maxLength": 200
11377
+ }
11378
+ },
11379
+ "technologyPresent": {
11380
+ "description": "Technology categories the company must have.",
11381
+ "minItems": 1,
11382
+ "maxItems": 10,
11383
+ "type": "array",
11384
+ "items": {
11385
+ "type": "string",
11386
+ "enum": [
11387
+ "crm",
11388
+ "marketingAutomation",
11389
+ "abm",
11390
+ "salesAutomation",
11391
+ "analytics",
11392
+ "cms",
11393
+ "cloudProvider",
11394
+ "ecommerce",
11395
+ "erp",
11396
+ "security"
11397
+ ]
9359
11398
  }
9360
11399
  }
9361
11400
  },
9362
11401
  "additionalProperties": false
9363
- },
9364
- "excludeListId": {
9365
- "description": "Saved list whose members are left out of the result.",
9366
- "type": "string",
9367
- "format": "uuid",
9368
- "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)$"
9369
11402
  }
9370
11403
  },
9371
11404
  "additionalProperties": false
@@ -9436,6 +11469,36 @@ var TOOL_CATALOG = [
9436
11469
  "filters": {
9437
11470
  "type": "object",
9438
11471
  "properties": {
11472
+ "companyNames": {
11473
+ "description": "Company name prefixes. Match any name.",
11474
+ "minItems": 1,
11475
+ "maxItems": 5,
11476
+ "type": "array",
11477
+ "items": {
11478
+ "type": "string",
11479
+ "minLength": 1,
11480
+ "maxLength": 120,
11481
+ "pattern": "\\S"
11482
+ }
11483
+ },
11484
+ "excludeCompanyNames": {
11485
+ "description": "Company name prefixes to leave out.",
11486
+ "minItems": 1,
11487
+ "maxItems": 5,
11488
+ "type": "array",
11489
+ "items": {
11490
+ "type": "string",
11491
+ "minLength": 1,
11492
+ "maxLength": 120,
11493
+ "pattern": "\\S"
11494
+ }
11495
+ },
11496
+ "domain": {
11497
+ "description": "Company website domain. Exact host matching; root sites rank first.",
11498
+ "type": "string",
11499
+ "minLength": 1,
11500
+ "maxLength": 320
11501
+ },
9439
11502
  "countryCodes": {
9440
11503
  "description": "Two-letter country codes to include.",
9441
11504
  "minItems": 1,
@@ -9607,9 +11670,7 @@ var TOOL_CATALOG = [
9607
11670
  "type": "array",
9608
11671
  "items": {
9609
11672
  "type": "string",
9610
- "minLength": 1,
9611
- "maxLength": 120,
9612
- "pattern": "\\S"
11673
+ "pattern": "^[0-9]{6}$"
9613
11674
  }
9614
11675
  },
9615
11676
  "excludeNaics2022Codes": {
@@ -9619,9 +11680,7 @@ var TOOL_CATALOG = [
9619
11680
  "type": "array",
9620
11681
  "items": {
9621
11682
  "type": "string",
9622
- "minLength": 1,
9623
- "maxLength": 120,
9624
- "pattern": "\\S"
11683
+ "pattern": "^[0-9]{6}$"
9625
11684
  }
9626
11685
  },
9627
11686
  "fundingTypes": {
@@ -9750,12 +11809,6 @@ var TOOL_CATALOG = [
9750
11809
  "maxLength": 320
9751
11810
  }
9752
11811
  },
9753
- "domain": {
9754
- "description": "Website domain. Matching is exact on the host, and a root site ranks first.",
9755
- "type": "string",
9756
- "minLength": 1,
9757
- "maxLength": 320
9758
- },
9759
11812
  "insights": {
9760
11813
  "description": "Insights filters. Supply at least one.",
9761
11814
  "type": "object",
@@ -10459,6 +12512,36 @@ var TOOL_CATALOG = [
10459
12512
  "filters": {
10460
12513
  "type": "object",
10461
12514
  "properties": {
12515
+ "companyNames": {
12516
+ "description": "Company name alternatives or a domain. Finds the 50 closest token or prefix matches, ignoring punctuation, accents and legal suffixes.",
12517
+ "minItems": 1,
12518
+ "maxItems": 5,
12519
+ "type": "array",
12520
+ "items": {
12521
+ "type": "string",
12522
+ "minLength": 1,
12523
+ "maxLength": 120,
12524
+ "pattern": "\\S"
12525
+ }
12526
+ },
12527
+ "excludeCompanyNames": {
12528
+ "description": "Company name prefixes to leave out.",
12529
+ "minItems": 1,
12530
+ "maxItems": 5,
12531
+ "type": "array",
12532
+ "items": {
12533
+ "type": "string",
12534
+ "minLength": 1,
12535
+ "maxLength": 120,
12536
+ "pattern": "\\S"
12537
+ }
12538
+ },
12539
+ "domain": {
12540
+ "description": "Company website domain. Exact host matching; root sites rank first.",
12541
+ "type": "string",
12542
+ "minLength": 1,
12543
+ "maxLength": 320
12544
+ },
10462
12545
  "countryCodes": {
10463
12546
  "description": "Two-letter country codes to include.",
10464
12547
  "minItems": 1,
@@ -10558,9 +12641,7 @@ var TOOL_CATALOG = [
10558
12641
  "type": "array",
10559
12642
  "items": {
10560
12643
  "type": "string",
10561
- "minLength": 1,
10562
- "maxLength": 120,
10563
- "pattern": "\\S"
12644
+ "pattern": "^[0-9]{6}$"
10564
12645
  }
10565
12646
  },
10566
12647
  "excludeNaics2022Codes": {
@@ -10570,9 +12651,7 @@ var TOOL_CATALOG = [
10570
12651
  "type": "array",
10571
12652
  "items": {
10572
12653
  "type": "string",
10573
- "minLength": 1,
10574
- "maxLength": 120,
10575
- "pattern": "\\S"
12654
+ "pattern": "^[0-9]{6}$"
10576
12655
  }
10577
12656
  },
10578
12657
  "fundingTypes": {
@@ -10701,6 +12780,25 @@ var TOOL_CATALOG = [
10701
12780
  "maxLength": 320
10702
12781
  }
10703
12782
  },
12783
+ "personNames": {
12784
+ "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.",
12785
+ "minItems": 1,
12786
+ "maxItems": 5,
12787
+ "type": "array",
12788
+ "items": {
12789
+ "type": "string",
12790
+ "minLength": 1,
12791
+ "maxLength": 120,
12792
+ "pattern": "\\S"
12793
+ }
12794
+ },
12795
+ "email": {
12796
+ "description": "Exact work email address, matched through the email index.",
12797
+ "type": "string",
12798
+ "maxLength": 320,
12799
+ "format": "email",
12800
+ "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,}$"
12801
+ },
10704
12802
  "personCities": {
10705
12803
  "description": "Person cities to include. Requires personCountryCodes.",
10706
12804
  "minItems": 1,
@@ -11051,6 +13149,20 @@ var TOOL_CATALOG = [
11051
13149
  "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,}$"
11052
13150
  }
11053
13151
  },
13152
+ "firstName": {
13153
+ "description": "First name tokens, using accent-folded fuzzy matching. Requires companyId.",
13154
+ "type": "string",
13155
+ "minLength": 1,
13156
+ "maxLength": 120,
13157
+ "pattern": "\\S"
13158
+ },
13159
+ "lastName": {
13160
+ "description": "Last name tokens, using accent-folded fuzzy matching. Requires companyId.",
13161
+ "type": "string",
13162
+ "minLength": 1,
13163
+ "maxLength": 120,
13164
+ "pattern": "\\S"
13165
+ },
11054
13166
  "companyId": {
11055
13167
  "description": "Limit contacts to this company. This uses the company-indexed contact path and does not require country or industry filters.",
11056
13168
  "type": "string",
@@ -11478,16 +13590,18 @@ var TOOL_CATALOG = [
11478
13590
  import { z } from "zod";
11479
13591
  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() })]) });
11480
13592
  var HigherDataError = class extends Error {
11481
- constructor(message, code, status = 0, retryAfter2) {
13593
+ constructor(message, code, status = 0, retryAfter2, requestId) {
11482
13594
  super(message);
11483
13595
  this.code = code;
11484
13596
  this.status = status;
11485
13597
  this.retryAfter = retryAfter2;
13598
+ this.requestId = requestId;
11486
13599
  this.name = "HigherDataError";
11487
13600
  }
11488
13601
  code;
11489
13602
  status;
11490
13603
  retryAfter;
13604
+ requestId;
11491
13605
  };
11492
13606
  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) });
11493
13607
  var MAX_RESPONSE = 8 * 1024 * 1024;
@@ -11507,7 +13621,7 @@ function retryAfter(response, data, now) {
11507
13621
  }
11508
13622
  function apiError(response, data, now) {
11509
13623
  const parsed = failure.safeParse(data), error = parsed.success ? parsed.data.error : null;
11510
- 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));
13624
+ 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);
11511
13625
  }
11512
13626
  async function responseJson(response) {
11513
13627
  if (!response.body) throw new HigherDataError("The API returned an invalid response.", "invalid_response");