elevenlabs-voice-agent-mcp 1.0.1 → 1.0.3

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 (44) hide show
  1. package/README.md +15 -0
  2. package/dist/index.js +1 -3
  3. package/dist/index.js.map +1 -1
  4. package/package.json +25 -2
  5. package/.claude/settings.local.json +0 -23
  6. package/.env.example +0 -3
  7. package/AGENTS.md +0 -37
  8. package/CLAUDE.md +0 -233
  9. package/call-exact-format.ts +0 -66
  10. package/call-wait-null.ts +0 -71
  11. package/create-agent-simple.ts +0 -84
  12. package/create-new-agent.ts +0 -98
  13. package/demo-agent-system-prompt.xml +0 -166
  14. package/elevenlabs-voice-agent-mcp-1.0.0.tgz +0 -0
  15. package/em_positive_leads.csv +0 -25
  16. package/list-resources.ts +0 -93
  17. package/make-call-now.ts +0 -66
  18. package/make-test-call.ts +0 -80
  19. package/openapi.json +0 -3238
  20. package/src/constants.ts +0 -62
  21. package/src/index.ts +0 -143
  22. package/src/schemas/agent-schemas.ts +0 -193
  23. package/src/schemas/batch-calling-schemas.ts +0 -96
  24. package/src/schemas/common-schemas.ts +0 -83
  25. package/src/schemas/conversation-schemas.ts +0 -44
  26. package/src/schemas/outbound-schemas.ts +0 -70
  27. package/src/schemas/phone-number-schemas.ts +0 -140
  28. package/src/schemas/tool-schemas.ts +0 -161
  29. package/src/services/elevenlabs-api.ts +0 -113
  30. package/src/services/formatters.ts +0 -623
  31. package/src/tools/agent-tools.ts +0 -425
  32. package/src/tools/batch-calling-tools.ts +0 -237
  33. package/src/tools/conversation-tools.ts +0 -167
  34. package/src/tools/knowledge-tools.ts +0 -73
  35. package/src/tools/outbound-tools.ts +0 -95
  36. package/src/tools/phone-number-tools.ts +0 -346
  37. package/src/tools/tool-tools.ts +0 -195
  38. package/src/tools/utility-tools.ts +0 -147
  39. package/src/types.ts +0 -327
  40. package/src/utils/error-handlers.ts +0 -98
  41. package/src/utils/truncation.ts +0 -97
  42. package/test-call-wait-for-hello.ts +0 -76
  43. package/test-call.json +0 -5
  44. package/tsconfig.json +0 -21
package/openapi.json DELETED
@@ -1,3238 +0,0 @@
1
- {
2
- "openapi": "3.0.0",
3
- "info": {
4
- "title": "Seamless API",
5
- "description": "[Privacy Policy](https://seamless.ai/policies/privacy-policy)\n \nIn order to dramatically improve our offerings to customers, Seamless will be introducing a Public API\nwhich can be used to search Companies & Contacts, Enrich Lists, and offer integrations as an Endpoint for our\ncustomers.\n\nThe API is build using [RESTful](https://en.wikipedia.org/wiki/REST) principles and is secured using OAuth 2.0 with the implicit grant flow.\n\n# Authentication\n\n## API Key\n\n### 1. **Register Your Application**\nTo use the Seamless API, you need to register your application to obtain an API key.\nTo create a new API key, go to [Seamless.AI | Settings](https://login.seamless.ai/settings/public-api) > API Key and click the *Create New Connection* button.\nNote: The Public API Connections menu will only appear if your account has access to the Public API.\n\n### 2. **Use the Access Token**\nFor all authenticated API requests, include the API key in the header:\n\n```\nToken: API_KEY\n```\n\n## OAuth 2.0\n\n### 1. **Register Your Application**\n\nBefore integrating, you have to setup your client credentials.\n\nTo create a new API client, go to [Seamless.AI | Settings](https://login.seamless.ai/settings/public-api) > OAuth Connections, and click the *Create New Connection* button.\n\nNote: The Public API Connections menu will only appear if your account has access to the Public API.\n\n- `client_id`\n- `client_secret`\n- `redirect_uri`\n\nYou’ll use these to authenticate and obtain tokens.\n\n---\n\n### 2. **Obtain Authorization Code**\n\nRedirect the user to Seamless.AI's OAuth authorization endpoint:\n\n```\nGET https://login.seamless.ai/oauth/authorize\n```\n\n### Query Parameters:\n\n| Name | Description |\n| --- | --- |\n| `client_id` | Your client ID |\n| `redirect_uri` | The URL users are redirected to |\n| `state` | (Optional) CSRF protection string |\n\n**Example URL**:\n\n```\nGET https://login.seamless.ai/oauth/authorize?client_id=YOUR_CLIENT_ID&redirect_uri=https://yourapp.com/callback\n```\n\nOnce the user authenticates, they will be redirected to your `redirect_uri` with a `code` parameter. \nIf your `redirect_uri` contains any query parameters (such as `?foo=bar`), you must URL encode your `redirect_uri` for this step.\n\n---\n\n### 3. **Exchange Code for Access Token**\n\n```\nPOST https://api.seamless.ai/api/client/v1/oauth/accessToken\n```\n\n### Request Body (JSON):\n\n```json\n{\n \"client_id\": \"YOUR_CLIENT_ID\",\n \"client_secret\": \"YOUR_CLIENT_SECRET\",\n \"redirect_uri\": \"https://yourapp.com/callback\",\n \"grant_type\": \"authorization_code\",\n \"code\": \"AUTHORIZATION_CODE_FROM_STEP_2\"\n}\n```\n\n### Response:\n\n```json\n{\n \"access_token\": \"ACCESS_TOKEN\",\n \"refresh_token\": \"REFRESH_TOKEN\",\n \"expires_at\": 1712000000\n}\n```\n\n---\n\n### 4. **Use the Access Token**\n\nFor all authenticated API requests, include the token in the header:\n\n```\nAuthorization: Bearer ACCESS_TOKEN\n```\n\n---\n\n### 5. **Refreshing the Token**\n\nTo refresh the access token:\n\n```\nPOST https://api.seamless.ai/api/client/v1/oauth/accessToken\n```\n\n### Request Body:\n\n```json\n{\n \"client_Id\": \"YOUR_CLIENT_ID\",\n \"client_secret\": \"YOUR_CLIENT_SECRET\",\n \"redirect_uri\": \"https://yourapp.com/callback\",\n \"grant_type\": \"refresh_token\",\n \"refresh_token\": \"YOUR_REFRESH_TOKEN\"\n}\n```\n\n# Rate Limiting\n\nThe limit is currently around 100 requests per 60 seconds per Endpoint. You will receive a 429 HTTP response if you exceed the rate limit.\n\nRate limit and remaining credits information will be returned in the response header of each request. The parameters are:\n\n| Name | Example | Description |\n| --- | --- | --- |\n| `X-RateLimit-Limit` | 100 | The maximum number of requests you're permitted to make in a given time period. |\n| `X-RateLimit-Remaining` | 55 | The number of requests remaining in the current rate limit window. |\n| `X-RateLimit-Reset` | 1745587198 | The time at which the current rate limit window resets in epoch seconds. |\n| `X-PublicAPI-Credits` | 1000 | The number of credits remaining that can be used in requests. |",
6
- "version": "1.0.0",
7
- "x-logo": {
8
- "url": "https://s3.amazonaws.com/seamless.ai-public/logos/SVG_SeamlessAI_Blue.svg",
9
- "altText": "Seamless logo",
10
- "href": "https://login.seamless.ai"
11
- },
12
- "termsOfService": "https://seamless.ai/policies/terms-of-use"
13
- },
14
- "servers": [
15
- {
16
- "url": "https://api.seamless.ai/api/client/v1",
17
- "description": "Seamless API"
18
- }
19
- ],
20
- "components": {
21
- "securitySchemes": {
22
- "OAuth2": {
23
- "type": "oauth2",
24
- "flows": {
25
- "authorizationCode": {
26
- "authorizationUrl": "https://login.seamless.ai/oauth/authorize",
27
- "tokenUrl": "https://api.seamless.ai/api/client/v1/oauth/accessToken",
28
- "scopes": {}
29
- }
30
- }
31
- },
32
- "webhookSecret": {
33
- "type": "apiKey",
34
- "description": "Webhook secret to verify the request is from Seamless",
35
- "name": "x-seamless-webhook-secret",
36
- "in": "header"
37
- }
38
- }
39
- },
40
- "security": [
41
- {
42
- "OAuth2": []
43
- }
44
- ],
45
- "x-tagGroups": [
46
- {
47
- "name": "OAuth",
48
- "tags": [
49
- "OAuth"
50
- ]
51
- },
52
- {
53
- "name": "Search",
54
- "tags": [
55
- "Contact Search",
56
- "Company Search"
57
- ]
58
- },
59
- {
60
- "name": "Research",
61
- "tags": [
62
- "Contact Research",
63
- "Company Research"
64
- ]
65
- },
66
- {
67
- "name": "Org Contacts/Companies",
68
- "tags": [
69
- "Org Contacts",
70
- "Org Companies"
71
- ]
72
- }
73
- ],
74
- "paths": {
75
- "/companies": {
76
- "get": {
77
- "summary": "Get Org Companies",
78
- "description": "Get a list of companies from your orgs",
79
- "operationId": "getCompanies",
80
- "tags": [
81
- "Org Companies"
82
- ],
83
- "security": [
84
- {
85
- "OAuth2": []
86
- }
87
- ],
88
- "parameters": [
89
- {
90
- "name": "page",
91
- "in": "query",
92
- "description": "The page number to retrieve.",
93
- "schema": {
94
- "type": "integer",
95
- "default": 1,
96
- "example": 1
97
- }
98
- },
99
- {
100
- "name": "limit",
101
- "in": "query",
102
- "description": "The number of results per page.",
103
- "schema": {
104
- "type": "integer",
105
- "default": 500,
106
- "maximum": 500,
107
- "example": 100
108
- }
109
- },
110
- {
111
- "name": "startDate",
112
- "required": true,
113
- "in": "query",
114
- "description": "An ISO8601 date time string that defines the start date of the lookback period to return results from.",
115
- "schema": {
116
- "type": "string",
117
- "format": "date",
118
- "example": "2020-01-01T10:00:00Z"
119
- }
120
- },
121
- {
122
- "name": "endDate",
123
- "required": true,
124
- "in": "query",
125
- "description": "An ISO8601 date time string that defines the end date of the lookback period to return results from.",
126
- "schema": {
127
- "type": "string",
128
- "format": "date",
129
- "example": "2020-01-01T11:00:00Z"
130
- }
131
- }
132
- ],
133
- "responses": {
134
- "200": {
135
- "description": "Company Results",
136
- "content": {
137
- "application/json": {
138
- "schema": {
139
- "type": "object",
140
- "properties": {
141
- "data": {
142
- "description": "A list of companies from your orgs",
143
- "type": "array",
144
- "items": {
145
- "type": "object",
146
- "properties": {
147
- "advertisingIntelligenceUrl": {
148
- "type": "string"
149
- },
150
- "alexaScoreUrl": {
151
- "type": "string"
152
- },
153
- "annualRevenue": {
154
- "type": "string"
155
- },
156
- "apiResearchId": {
157
- "type": "string",
158
- "description": "The API research identifier for companies created through API research",
159
- "example": "research-123"
160
- },
161
- "phones": {
162
- "type": "string"
163
- },
164
- "phonesAiScores": {
165
- "type": "string"
166
- },
167
- "createdAt": {
168
- "type": "string",
169
- "example": "2024-04-21T14:30:00.000Z"
170
- },
171
- "description": {
172
- "type": "string"
173
- },
174
- "domain": {
175
- "type": "string"
176
- },
177
- "employeeReviewsUrl": {
178
- "type": "string"
179
- },
180
- "foundedOn": {
181
- "type": "string"
182
- },
183
- "googleFinanceUrl": {
184
- "type": "string"
185
- },
186
- "googleResearchUrl": {
187
- "type": "string"
188
- },
189
- "industries": {
190
- "type": "string"
191
- },
192
- "intelUrl": {
193
- "type": "string"
194
- },
195
- "jobPostingsUrl": {
196
- "type": "string"
197
- },
198
- "linkedInProfileUrl": {
199
- "type": "string"
200
- },
201
- "linkedInId": {
202
- "type": "string"
203
- },
204
- "localSportsTeamsUrl": {
205
- "type": "string"
206
- },
207
- "localWeatherUrl": {
208
- "type": "string"
209
- },
210
- "location": {
211
- "type": "object",
212
- "properties": {
213
- "street1": {
214
- "type": "string"
215
- },
216
- "city": {
217
- "type": "string"
218
- },
219
- "state": {
220
- "type": "string"
221
- },
222
- "postCode": {
223
- "type": "string"
224
- },
225
- "country": {
226
- "type": "string"
227
- },
228
- "countryAbbr": {
229
- "type": "string"
230
- },
231
- "countryAlpha2": {
232
- "type": "string"
233
- },
234
- "countryAlpha3": {
235
- "type": "string"
236
- },
237
- "fullString": {
238
- "type": "string"
239
- }
240
- }
241
- },
242
- "name": {
243
- "type": "string"
244
- },
245
- "newsUrl": {
246
- "type": "string"
247
- },
248
- "paidSearchIntelligenceUrl": {
249
- "type": "string"
250
- },
251
- "paidSearchKeywordsIntelligenceUrl": {
252
- "type": "string"
253
- },
254
- "revenueRange": {
255
- "type": "string"
256
- },
257
- "searchMarketingIntelligenceUrl": {
258
- "type": "string"
259
- },
260
- "secFilingsUrl": {
261
- "type": "string"
262
- },
263
- "seoResearchUrl": {
264
- "type": "string"
265
- },
266
- "sicCode": {
267
- "type": "string"
268
- },
269
- "similarWebsitesUrl": {
270
- "type": "string"
271
- },
272
- "socialMediaMentionsUrl": {
273
- "type": "string"
274
- },
275
- "socialMediaPostsUrl": {
276
- "type": "string"
277
- },
278
- "socialPostsUrl": {
279
- "type": "string"
280
- },
281
- "staffCount": {
282
- "type": "string"
283
- },
284
- "staffCountRange": {
285
- "type": "string"
286
- },
287
- "topTechnologies": {
288
- "type": "string"
289
- },
290
- "updatedAt": {
291
- "type": "string",
292
- "example": "2024-04-21T14:30:00.000Z"
293
- },
294
- "webTechnologiesUrl": {
295
- "type": "string"
296
- },
297
- "websiteAuditUrl": {
298
- "type": "string"
299
- },
300
- "websiteAudit2Url": {
301
- "type": "string"
302
- },
303
- "websiteGraderUrl": {
304
- "type": "string"
305
- },
306
- "whoisUrl": {
307
- "type": "string"
308
- },
309
- "wikipediaUrl": {
310
- "type": "string"
311
- },
312
- "yahooFinanceUrl": {
313
- "type": "string"
314
- }
315
- }
316
- }
317
- }
318
- }
319
- }
320
- }
321
- }
322
- },
323
- "401": {
324
- "description": "Unauthorized",
325
- "content": {
326
- "application/json": {
327
- "schema": {
328
- "type": "object",
329
- "required": [
330
- "message"
331
- ],
332
- "properties": {
333
- "message": {
334
- "description": "A human readable error message",
335
- "type": "string"
336
- }
337
- }
338
- }
339
- }
340
- }
341
- },
342
- "422": {
343
- "description": "Insufficient credits or missing license",
344
- "content": {
345
- "application/json": {
346
- "schema": {
347
- "description": "Insufficient credits or missing license",
348
- "type": "object",
349
- "properties": {
350
- "msg": {
351
- "type": "string"
352
- },
353
- "code": {
354
- "type": "string"
355
- },
356
- "data": {
357
- "type": "object",
358
- "properties": {
359
- "productCategory": {
360
- "type": "string"
361
- },
362
- "additionalCreditsNeeded": {
363
- "type": "integer"
364
- }
365
- }
366
- }
367
- }
368
- }
369
- }
370
- }
371
- },
372
- "500": {
373
- "description": "Unexpected error",
374
- "content": {
375
- "application/json": {
376
- "schema": {
377
- "type": "object",
378
- "required": [
379
- "message"
380
- ],
381
- "properties": {
382
- "message": {
383
- "description": "A human readable error message",
384
- "type": "string"
385
- }
386
- }
387
- }
388
- }
389
- }
390
- }
391
- }
392
- }
393
- },
394
- "/contacts": {
395
- "get": {
396
- "summary": "Get Org Contacts",
397
- "description": "Get a list of contacts from your orgs",
398
- "operationId": "getContacts",
399
- "tags": [
400
- "Org Contacts"
401
- ],
402
- "security": [
403
- {
404
- "OAuth2": []
405
- }
406
- ],
407
- "parameters": [
408
- {
409
- "name": "page",
410
- "in": "query",
411
- "description": "The page number to retrieve.",
412
- "schema": {
413
- "type": "integer",
414
- "default": 1,
415
- "example": 1
416
- }
417
- },
418
- {
419
- "name": "limit",
420
- "in": "query",
421
- "description": "The number of results per page.",
422
- "schema": {
423
- "type": "integer",
424
- "default": 500,
425
- "maximum": 500,
426
- "example": 100
427
- }
428
- },
429
- {
430
- "name": "startDate",
431
- "required": true,
432
- "in": "query",
433
- "description": "An ISO8601 date time string that defines the start date of the lookback period to return results from.",
434
- "schema": {
435
- "type": "string",
436
- "format": "date",
437
- "example": "2020-01-01T10:00:00Z"
438
- }
439
- },
440
- {
441
- "name": "endDate",
442
- "required": true,
443
- "in": "query",
444
- "description": "An ISO8601 date time string that defines the end date of the lookback period to return results from.",
445
- "schema": {
446
- "type": "string",
447
- "format": "date",
448
- "example": "2020-01-01T11:00:00Z"
449
- }
450
- }
451
- ],
452
- "responses": {
453
- "200": {
454
- "description": "Contact Results",
455
- "content": {
456
- "application/json": {
457
- "schema": {
458
- "type": "object",
459
- "properties": {
460
- "data": {
461
- "type": "array",
462
- "description": "A list of contacts from your orgs",
463
- "items": {
464
- "type": "object",
465
- "properties": {
466
- "username": {
467
- "type": "string"
468
- },
469
- "createdAt": {
470
- "type": "string"
471
- },
472
- "updatedAt": {
473
- "type": "string"
474
- },
475
- "firstName": {
476
- "type": "string"
477
- },
478
- "middleName": {
479
- "type": "string"
480
- },
481
- "lastName": {
482
- "type": "string"
483
- },
484
- "fullName": {
485
- "type": "string"
486
- },
487
- "name": {
488
- "type": "string"
489
- },
490
- "nameOriginal": {
491
- "type": "string"
492
- },
493
- "email": {
494
- "type": "string"
495
- },
496
- "personalEmail": {
497
- "type": "string"
498
- },
499
- "phone": {
500
- "type": "string"
501
- },
502
- "contactPhone1": {
503
- "type": "string"
504
- },
505
- "contactPhone1DataType": {
506
- "type": "string"
507
- },
508
- "contactPhone1TotalAI": {
509
- "type": "string"
510
- },
511
- "companyPhone1": {
512
- "type": "string"
513
- },
514
- "companyPhone1DataType": {
515
- "type": "string"
516
- },
517
- "companyPhone1TotalAI": {
518
- "type": "string"
519
- },
520
- "company": {
521
- "type": "string"
522
- },
523
- "companyOriginal": {
524
- "type": "string"
525
- },
526
- "companyIndustry": {
527
- "type": "string"
528
- },
529
- "companyStaffCount": {
530
- "type": "integer"
531
- },
532
- "companyStaffCountRange": {
533
- "type": "string"
534
- },
535
- "companyAnnualRevenue": {
536
- "type": "string"
537
- },
538
- "companyDomain": {
539
- "type": "string"
540
- },
541
- "companyRevenueRange": {
542
- "type": "string"
543
- },
544
- "companyLIProfileUrl": {
545
- "type": "string"
546
- },
547
- "companyLinkedInId": {
548
- "type": "string"
549
- },
550
- "title": {
551
- "type": "string"
552
- },
553
- "lIProfileUrl": {
554
- "type": "string"
555
- },
556
- "lISalesNavUrl": {
557
- "type": "string"
558
- },
559
- "lIRecruiterUrl": {
560
- "type": "string"
561
- },
562
- "contactLocation": {
563
- "type": "object",
564
- "properties": {
565
- "city": {
566
- "type": "string"
567
- },
568
- "state": {
569
- "type": "string"
570
- },
571
- "postCode": {
572
- "type": "string"
573
- },
574
- "county": {
575
- "type": "string"
576
- },
577
- "country": {
578
- "type": "string"
579
- },
580
- "stateAbbr": {
581
- "type": "string"
582
- },
583
- "countryAbbr": {
584
- "type": "string"
585
- },
586
- "countryAlpha2": {
587
- "type": "string"
588
- },
589
- "countryAlpha3": {
590
- "type": "string"
591
- },
592
- "countryNumeric": {
593
- "type": "string"
594
- },
595
- "fullString": {
596
- "type": "string"
597
- },
598
- "timezone": {
599
- "type": "string"
600
- },
601
- "timezoneRawOffset": {
602
- "type": "string"
603
- },
604
- "timezoneAbbr": {
605
- "type": "string"
606
- }
607
- }
608
- },
609
- "companyLocation": {
610
- "type": "object",
611
- "properties": {
612
- "street1": {
613
- "type": "string"
614
- },
615
- "street2": {
616
- "type": "string"
617
- },
618
- "street3": {
619
- "type": "string"
620
- },
621
- "city": {
622
- "type": "string"
623
- },
624
- "state": {
625
- "type": "string"
626
- },
627
- "postCode": {
628
- "type": "string"
629
- },
630
- "county": {
631
- "type": "string"
632
- },
633
- "country": {
634
- "type": "string"
635
- },
636
- "stateAbbr": {
637
- "type": "string"
638
- },
639
- "countryAbbr": {
640
- "type": "string"
641
- },
642
- "countryAlpha2": {
643
- "type": "string"
644
- },
645
- "countryAlpha3": {
646
- "type": "string"
647
- },
648
- "countryNumeric": {
649
- "type": "string"
650
- },
651
- "fullString": {
652
- "type": "string"
653
- }
654
- }
655
- },
656
- "website": {
657
- "type": "string"
658
- },
659
- "email1": {
660
- "type": "string"
661
- },
662
- "email1Selected": {
663
- "type": "boolean"
664
- },
665
- "email1TotalAI": {
666
- "type": "string"
667
- },
668
- "email1EmailAI": {
669
- "type": "string"
670
- },
671
- "email2": {
672
- "type": "string"
673
- },
674
- "email2TotalAI": {
675
- "type": "string"
676
- },
677
- "email2EmailAI": {
678
- "type": "string"
679
- },
680
- "email3": {
681
- "type": "string"
682
- },
683
- "email3TotalAI": {
684
- "type": "string"
685
- },
686
- "email3EmailAI": {
687
- "type": "string"
688
- },
689
- "jobHistory": {
690
- "type": "array",
691
- "description": "Contact's job history (requires Job Changes feature flag access)",
692
- "items": {
693
- "type": "object",
694
- "properties": {
695
- "companyName": {
696
- "type": "string",
697
- "description": "Company name for this job"
698
- },
699
- "title": {
700
- "type": "string",
701
- "description": "Job title/position"
702
- },
703
- "startedAt": {
704
- "type": "string",
705
- "format": "date-time",
706
- "description": "When the contact started this job"
707
- },
708
- "endedAt": {
709
- "type": "string",
710
- "format": "date-time",
711
- "description": "When the contact ended this job (null for current job)"
712
- }
713
- }
714
- }
715
- },
716
- "apiResearchId": {
717
- "type": "string",
718
- "description": "The Id return from the /contacts/research endpoint"
719
- }
720
- }
721
- }
722
- }
723
- }
724
- }
725
- }
726
- }
727
- },
728
- "401": {
729
- "description": "Unauthorized",
730
- "content": {
731
- "application/json": {
732
- "schema": {
733
- "type": "object",
734
- "required": [
735
- "message"
736
- ],
737
- "properties": {
738
- "message": {
739
- "description": "A human readable error message",
740
- "type": "string"
741
- }
742
- }
743
- }
744
- }
745
- }
746
- },
747
- "422": {
748
- "description": "Insufficient credits or missing license",
749
- "content": {
750
- "application/json": {
751
- "schema": {
752
- "description": "Insufficient credits or missing license",
753
- "type": "object",
754
- "properties": {
755
- "msg": {
756
- "type": "string"
757
- },
758
- "code": {
759
- "type": "string"
760
- },
761
- "data": {
762
- "type": "object",
763
- "properties": {
764
- "productCategory": {
765
- "type": "string"
766
- },
767
- "additionalCreditsNeeded": {
768
- "type": "integer"
769
- }
770
- }
771
- }
772
- }
773
- }
774
- }
775
- }
776
- },
777
- "500": {
778
- "description": "Unexpected error",
779
- "content": {
780
- "application/json": {
781
- "schema": {
782
- "type": "object",
783
- "required": [
784
- "message"
785
- ],
786
- "properties": {
787
- "message": {
788
- "description": "A human readable error message",
789
- "type": "string"
790
- }
791
- }
792
- }
793
- }
794
- }
795
- }
796
- }
797
- }
798
- },
799
- "/oauth/accessToken": {
800
- "post": {
801
- "summary": "Get an access token",
802
- "operationId": "getAccessToken",
803
- "tags": [
804
- "OAuth"
805
- ],
806
- "requestBody": {
807
- "content": {
808
- "application/json": {
809
- "schema": {
810
- "type": "object",
811
- "properties": {
812
- "client_id": {
813
- "type": "string"
814
- },
815
- "client_secret": {
816
- "type": "string"
817
- },
818
- "redirect_uri": {
819
- "type": "string"
820
- },
821
- "grant_type": {
822
- "type": "string",
823
- "enum": [
824
- "authorization_code",
825
- "refresh_token"
826
- ]
827
- },
828
- "code": {
829
- "type": "string",
830
- "description": "Required if grant_type is authorization_code"
831
- },
832
- "refresh_token": {
833
- "type": "string",
834
- "description": "Required if grant_type is refresh_token"
835
- }
836
- },
837
- "required": [
838
- "clientId",
839
- "clientSecret",
840
- "redirectUri",
841
- "grant_type"
842
- ]
843
- }
844
- }
845
- }
846
- },
847
- "responses": {
848
- "200": {
849
- "description": "The access token",
850
- "content": {
851
- "application/json": {
852
- "schema": {
853
- "type": "object",
854
- "properties": {
855
- "access_token": {
856
- "type": "string"
857
- },
858
- "expires_at": {
859
- "type": "integer"
860
- },
861
- "refresh_token": {
862
- "type": "string"
863
- }
864
- }
865
- }
866
- }
867
- }
868
- },
869
- "401": {
870
- "description": "Unauthorized",
871
- "content": {
872
- "application/json": {
873
- "schema": {
874
- "type": "object",
875
- "required": [
876
- "message"
877
- ],
878
- "properties": {
879
- "message": {
880
- "description": "A human readable error message",
881
- "type": "string"
882
- }
883
- }
884
- }
885
- }
886
- }
887
- },
888
- "422": {
889
- "description": "Insufficient credits or missing license",
890
- "content": {
891
- "application/json": {
892
- "schema": {
893
- "description": "Insufficient credits or missing license",
894
- "type": "object",
895
- "properties": {
896
- "msg": {
897
- "type": "string"
898
- },
899
- "code": {
900
- "type": "string"
901
- },
902
- "data": {
903
- "type": "object",
904
- "properties": {
905
- "productCategory": {
906
- "type": "string"
907
- },
908
- "additionalCreditsNeeded": {
909
- "type": "integer"
910
- }
911
- }
912
- }
913
- }
914
- }
915
- }
916
- }
917
- },
918
- "500": {
919
- "description": "Unexpected error",
920
- "content": {
921
- "application/json": {
922
- "schema": {
923
- "type": "object",
924
- "required": [
925
- "message"
926
- ],
927
- "properties": {
928
- "message": {
929
- "description": "A human readable error message",
930
- "type": "string"
931
- }
932
- }
933
- }
934
- }
935
- }
936
- }
937
- }
938
- }
939
- },
940
- "/search/companies": {
941
- "post": {
942
- "summary": "Search companies",
943
- "operationId": "searchCompanies",
944
- "tags": [
945
- "Company Search"
946
- ],
947
- "security": [
948
- {
949
- "OAuth2": []
950
- }
951
- ],
952
- "requestBody": {
953
- "required": true,
954
- "content": {
955
- "application/json": {
956
- "schema": {
957
- "type": "object",
958
- "properties": {
959
- "page": {
960
- "description": "The page number to retrieve.",
961
- "deprecated": true,
962
- "type": "integer",
963
- "default": 1,
964
- "example": 1
965
- },
966
- "nextToken": {
967
- "description": "The next token for pagination.",
968
- "type": "string",
969
- "default": null
970
- },
971
- "limit": {
972
- "description": "The number of contacts per page.",
973
- "type": "integer",
974
- "default": 50,
975
- "example": 50
976
- },
977
- "companyName": {
978
- "type": "array",
979
- "items": {
980
- "type": "string"
981
- },
982
- "maxItems": 100,
983
- "description": "Company name search filter.",
984
- "example": [
985
- "Seamless AI"
986
- ]
987
- },
988
- "companyNameSearchType": {
989
- "description": "The type of search to perform on the company name.",
990
- "type": "string",
991
- "enum": [
992
- "default",
993
- "related",
994
- "exact"
995
- ],
996
- "default": "default"
997
- },
998
- "companyDomain": {
999
- "type": "array",
1000
- "items": {
1001
- "type": "string"
1002
- },
1003
- "maxItems": 100,
1004
- "description": "Company domain search filter.",
1005
- "example": []
1006
- },
1007
- "companyState": {
1008
- "type": "array",
1009
- "items": {
1010
- "type": "string"
1011
- },
1012
- "maxItems": 10,
1013
- "description": "Company state search filter.",
1014
- "example": []
1015
- },
1016
- "companyCountry": {
1017
- "type": "array",
1018
- "items": {
1019
- "type": "string"
1020
- },
1021
- "maxItems": 10,
1022
- "description": "Company country search filter.",
1023
- "example": []
1024
- },
1025
- "companyZipCode": {
1026
- "type": "array",
1027
- "items": {
1028
- "type": "string"
1029
- },
1030
- "maxItems": 10,
1031
- "description": "Company zipcode search filter.",
1032
- "example": []
1033
- },
1034
- "companyStreet": {
1035
- "type": "array",
1036
- "items": {
1037
- "type": "string"
1038
- },
1039
- "maxItems": 10,
1040
- "description": "Company street search filter.",
1041
- "example": []
1042
- },
1043
- "industry": {
1044
- "type": "array",
1045
- "items": {
1046
- "type": "string"
1047
- },
1048
- "maxItems": 5,
1049
- "description": "Company industry search filter.",
1050
- "example": []
1051
- },
1052
- "companyKeyword": {
1053
- "type": "array",
1054
- "items": {
1055
- "type": "string"
1056
- },
1057
- "maxItems": 10,
1058
- "description": "Company keyword search filter.",
1059
- "example": []
1060
- },
1061
- "companySize": {
1062
- "type": "array",
1063
- "items": {
1064
- "type": "string",
1065
- "enum": [
1066
- "0 - 1 (Self-employed)",
1067
- "2 - 10",
1068
- "11 - 50",
1069
- "51 - 200",
1070
- "201 - 500",
1071
- "501 - 1,000",
1072
- "1,001 - 5,000",
1073
- "5,001 - 10,000",
1074
- "10,001+"
1075
- ]
1076
- },
1077
- "maxItems": 10,
1078
- "description": "Company size search filter.",
1079
- "example": []
1080
- },
1081
- "companyRevenue": {
1082
- "type": "array",
1083
- "items": {
1084
- "type": "string",
1085
- "enum": [
1086
- "$0 - $100K",
1087
- "$100K - $1M",
1088
- "$1M - $5M",
1089
- "$5M - $20M",
1090
- "$20M - $50M",
1091
- "$50M - $100M",
1092
- "$100M - $500M",
1093
- "$500M - $1B",
1094
- "$1B+"
1095
- ]
1096
- },
1097
- "maxItems": 10,
1098
- "description": "Company revenue search filter.",
1099
- "example": []
1100
- },
1101
- "technologies": {
1102
- "type": "array",
1103
- "items": {
1104
- "type": "string"
1105
- },
1106
- "maxItems": 10,
1107
- "description": "Company technologies search filter.",
1108
- "example": []
1109
- },
1110
- "foundedOn": {
1111
- "type": "array",
1112
- "items": {
1113
- "type": "string",
1114
- "enum": [
1115
- "Less than 1 Year",
1116
- "Last 1-3 Years",
1117
- "Last 4-10 Years",
1118
- "10+ Years"
1119
- ]
1120
- },
1121
- "description": "Range of years since the company was founded.",
1122
- "maxItems": 4,
1123
- "example": [
1124
- "Less than 1 Year",
1125
- "Last 1-3 Years"
1126
- ]
1127
- }
1128
- }
1129
- }
1130
- }
1131
- }
1132
- },
1133
- "responses": {
1134
- "200": {
1135
- "description": "Company Search Results",
1136
- "content": {
1137
- "application/json": {
1138
- "schema": {
1139
- "type": "object",
1140
- "properties": {
1141
- "data": {
1142
- "description": "A list of companies",
1143
- "type": "array",
1144
- "items": {
1145
- "type": "object",
1146
- "properties": {
1147
- "searchResultId": {
1148
- "type": "string"
1149
- },
1150
- "name": {
1151
- "type": "string"
1152
- },
1153
- "street1": {
1154
- "type": "string"
1155
- },
1156
- "street2": {
1157
- "type": "string"
1158
- },
1159
- "street3": {
1160
- "type": "string"
1161
- },
1162
- "city": {
1163
- "type": "string"
1164
- },
1165
- "state": {
1166
- "type": "string"
1167
- },
1168
- "postCode": {
1169
- "type": "string"
1170
- },
1171
- "country": {
1172
- "type": "string"
1173
- },
1174
- "domain": {
1175
- "type": "string"
1176
- },
1177
- "description": {
1178
- "type": "string"
1179
- },
1180
- "liUrl": {
1181
- "type": "string"
1182
- },
1183
- "sicCode": {
1184
- "type": "string"
1185
- },
1186
- "industries": {
1187
- "type": "array",
1188
- "items": {
1189
- "type": "string"
1190
- }
1191
- },
1192
- "revenueRange": {
1193
- "type": "string"
1194
- },
1195
- "annualRevenue": {
1196
- "type": "string"
1197
- },
1198
- "staffCountRange": {
1199
- "type": "string"
1200
- },
1201
- "employeeCount": {
1202
- "type": "string"
1203
- },
1204
- "numContacts": {
1205
- "type": "string"
1206
- },
1207
- "technologies": {
1208
- "type": "array",
1209
- "items": {
1210
- "type": "string"
1211
- }
1212
- },
1213
- "linkedInId": {
1214
- "type": "string"
1215
- },
1216
- "companyLIURL": {
1217
- "type": "string"
1218
- },
1219
- "foundedOn": {
1220
- "type": "string",
1221
- "format": "date"
1222
- }
1223
- }
1224
- }
1225
- },
1226
- "supplementalData": {
1227
- "type": "object",
1228
- "properties": {
1229
- "isMore": {
1230
- "type": "boolean"
1231
- },
1232
- "total": {
1233
- "type": "integer"
1234
- },
1235
- "perPage": {
1236
- "type": "integer"
1237
- },
1238
- "nextToken": {
1239
- "type": "string"
1240
- }
1241
- }
1242
- }
1243
- }
1244
- }
1245
- }
1246
- }
1247
- },
1248
- "401": {
1249
- "description": "Unauthorized",
1250
- "content": {
1251
- "application/json": {
1252
- "schema": {
1253
- "type": "object",
1254
- "required": [
1255
- "message"
1256
- ],
1257
- "properties": {
1258
- "message": {
1259
- "description": "A human readable error message",
1260
- "type": "string"
1261
- }
1262
- }
1263
- }
1264
- }
1265
- }
1266
- },
1267
- "422": {
1268
- "description": "Insufficient credits or missing license",
1269
- "content": {
1270
- "application/json": {
1271
- "schema": {
1272
- "description": "Insufficient credits or missing license",
1273
- "type": "object",
1274
- "properties": {
1275
- "msg": {
1276
- "type": "string"
1277
- },
1278
- "code": {
1279
- "type": "string"
1280
- },
1281
- "data": {
1282
- "type": "object",
1283
- "properties": {
1284
- "productCategory": {
1285
- "type": "string"
1286
- },
1287
- "additionalCreditsNeeded": {
1288
- "type": "integer"
1289
- }
1290
- }
1291
- }
1292
- }
1293
- }
1294
- }
1295
- }
1296
- },
1297
- "500": {
1298
- "description": "Unexpected error",
1299
- "content": {
1300
- "application/json": {
1301
- "schema": {
1302
- "type": "object",
1303
- "required": [
1304
- "message"
1305
- ],
1306
- "properties": {
1307
- "message": {
1308
- "description": "A human readable error message",
1309
- "type": "string"
1310
- }
1311
- }
1312
- }
1313
- }
1314
- }
1315
- }
1316
- }
1317
- }
1318
- },
1319
- "/search/contacts": {
1320
- "post": {
1321
- "summary": "Search contacts",
1322
- "operationId": "searchContacts",
1323
- "tags": [
1324
- "Contact Search"
1325
- ],
1326
- "security": [
1327
- {
1328
- "OAuth2": []
1329
- }
1330
- ],
1331
- "requestBody": {
1332
- "required": true,
1333
- "content": {
1334
- "application/json": {
1335
- "schema": {
1336
- "type": "object",
1337
- "properties": {
1338
- "page": {
1339
- "description": "The page number to retrieve.",
1340
- "deprecated": true,
1341
- "type": "integer",
1342
- "default": 1,
1343
- "example": 1
1344
- },
1345
- "nextToken": {
1346
- "description": "The next token for pagination.",
1347
- "type": "string",
1348
- "default": null
1349
- },
1350
- "limit": {
1351
- "description": "The number of contacts per page.",
1352
- "type": "integer",
1353
- "default": 50,
1354
- "example": 50
1355
- },
1356
- "companyName": {
1357
- "type": "array",
1358
- "items": {
1359
- "type": "string"
1360
- },
1361
- "maxItems": 100,
1362
- "description": "Contact company name search filter.",
1363
- "example": [
1364
- "Seamless.AI"
1365
- ]
1366
- },
1367
- "companyNameSearchType": {
1368
- "description": "The type of search to perform on the company name.",
1369
- "type": "string",
1370
- "enum": [
1371
- "default",
1372
- "related",
1373
- "exact"
1374
- ],
1375
- "default": "default"
1376
- },
1377
- "companyDomain": {
1378
- "type": "array",
1379
- "items": {
1380
- "type": "string"
1381
- },
1382
- "maxItems": 100,
1383
- "description": "Contact company domain search filter.",
1384
- "example": []
1385
- },
1386
- "contactState": {
1387
- "type": "array",
1388
- "items": {
1389
- "type": "string"
1390
- },
1391
- "maxItems": 10,
1392
- "description": "Contact or Company state search filter.",
1393
- "example": []
1394
- },
1395
- "contactCountry": {
1396
- "type": "array",
1397
- "items": {
1398
- "type": "string"
1399
- },
1400
- "maxItems": 10,
1401
- "description": "Contact or Company country search filter.",
1402
- "example": []
1403
- },
1404
- "contactZipCode": {
1405
- "type": "array",
1406
- "items": {
1407
- "type": "string"
1408
- },
1409
- "maxItems": 10,
1410
- "description": "Contact or Company zipcode search filter.",
1411
- "example": []
1412
- },
1413
- "locationType": {
1414
- "type": "string",
1415
- "enum": [
1416
- "bothOR",
1417
- "bothAND",
1418
- "company",
1419
- "contact"
1420
- ],
1421
- "description": "You can search by contacts’ location(contact), the companies’ location(company), both Contact And company(bothAND), or both contact Or company(bothOR).",
1422
- "default": "bothOR",
1423
- "example": "bothOR"
1424
- },
1425
- "department": {
1426
- "type": "array",
1427
- "items": {
1428
- "type": "string",
1429
- "enum": [
1430
- "Sales",
1431
- "Marketing",
1432
- "Engineering",
1433
- "Human Resources",
1434
- "Finance",
1435
- "IT",
1436
- "Engineering",
1437
- "Operations",
1438
- "Support",
1439
- "Legal",
1440
- "Project Management",
1441
- "Other"
1442
- ]
1443
- },
1444
- "maxItems": 5,
1445
- "description": "Contact department search filter.",
1446
- "example": []
1447
- },
1448
- "industry": {
1449
- "type": "array",
1450
- "items": {
1451
- "type": "string"
1452
- },
1453
- "maxItems": 5,
1454
- "description": "Contact industry search filter.",
1455
- "example": []
1456
- },
1457
- "fullname": {
1458
- "type": "array",
1459
- "items": {
1460
- "type": "string"
1461
- },
1462
- "maxItems": 10,
1463
- "description": "Contact fullname search filter.",
1464
- "example": []
1465
- },
1466
- "contactKeyword": {
1467
- "type": "array",
1468
- "items": {
1469
- "type": "string"
1470
- },
1471
- "maxItems": 10,
1472
- "description": "Contact keyword search filter.",
1473
- "example": []
1474
- },
1475
- "jobTitle": {
1476
- "type": "array",
1477
- "items": {
1478
- "type": "string"
1479
- },
1480
- "maxItems": 10,
1481
- "description": "Contact job title search filter.",
1482
- "example": []
1483
- },
1484
- "seniority": {
1485
- "type": "array",
1486
- "items": {
1487
- "type": "string",
1488
- "enum": [
1489
- "C-Level",
1490
- "VP",
1491
- "Director",
1492
- "Manager",
1493
- "Senior",
1494
- "Entry Level",
1495
- "Mid-Level",
1496
- "Other"
1497
- ]
1498
- },
1499
- "maxItems": 5,
1500
- "description": "Contact seniority search filter.",
1501
- "example": []
1502
- },
1503
- "companyFoundedOn": {
1504
- "type": "array",
1505
- "items": {
1506
- "type": "string",
1507
- "enum": [
1508
- "Less than 1 Year",
1509
- "Last 1-3 Years",
1510
- "Last 4-10 Years",
1511
- "10+ Years"
1512
- ]
1513
- },
1514
- "description": "Range of years since the company was founded.",
1515
- "maxItems": 4,
1516
- "example": [
1517
- "Less than 1 Year",
1518
- "Last 1-3 Years"
1519
- ]
1520
- },
1521
- "lastModifiedAfter": {
1522
- "description": "Filter on the lastModifiedAt(The last time the name, title, company, phone, or email changed).",
1523
- "type": "string",
1524
- "format": "date",
1525
- "example": "2025-09-01T11:00:00Z"
1526
- },
1527
- "lastModifiedBefore": {
1528
- "description": "Filter on the lastModifiedAt(The last time the name, title, company, phone, or email changed).",
1529
- "type": "string",
1530
- "format": "date",
1531
- "example": "2025-09-07T11:00:00Z"
1532
- }
1533
- }
1534
- }
1535
- }
1536
- }
1537
- },
1538
- "responses": {
1539
- "200": {
1540
- "description": "Contact Search Results",
1541
- "content": {
1542
- "application/json": {
1543
- "schema": {
1544
- "type": "object",
1545
- "properties": {
1546
- "data": {
1547
- "description": "A list of contacts",
1548
- "type": "array",
1549
- "items": {
1550
- "type": "object",
1551
- "properties": {
1552
- "searchResultId": {
1553
- "type": "string"
1554
- },
1555
- "name": {
1556
- "type": "string"
1557
- },
1558
- "company": {
1559
- "type": "string"
1560
- },
1561
- "title": {
1562
- "type": "string"
1563
- },
1564
- "department": {
1565
- "type": "string"
1566
- },
1567
- "seniority": {
1568
- "type": "string"
1569
- },
1570
- "domain": {
1571
- "type": "string"
1572
- },
1573
- "city": {
1574
- "type": "string"
1575
- },
1576
- "state": {
1577
- "type": "string"
1578
- },
1579
- "country": {
1580
- "type": "string"
1581
- },
1582
- "companyCity": {
1583
- "type": "string"
1584
- },
1585
- "companyState": {
1586
- "type": "string"
1587
- },
1588
- "companyCountry": {
1589
- "type": "string"
1590
- },
1591
- "liUrl": {
1592
- "type": "string"
1593
- },
1594
- "companyLIProfileUrl": {
1595
- "type": "string"
1596
- },
1597
- "sicCode": {
1598
- "type": "string"
1599
- },
1600
- "industries": {
1601
- "type": "array",
1602
- "items": {
1603
- "type": "string"
1604
- }
1605
- },
1606
- "companyFoundedOn": {
1607
- "type": "string",
1608
- "format": "date"
1609
- },
1610
- "companyRevenue": {
1611
- "type": "string"
1612
- },
1613
- "employeeSizeRange": {
1614
- "type": "string"
1615
- },
1616
- "timezone": {
1617
- "type": "string"
1618
- },
1619
- "lastModifiedAt": {
1620
- "description": "The last time the name, title, company, phone, or email changed.",
1621
- "type": "string"
1622
- }
1623
- }
1624
- }
1625
- },
1626
- "supplementalData": {
1627
- "type": "object",
1628
- "properties": {
1629
- "isMore": {
1630
- "type": "boolean"
1631
- },
1632
- "total": {
1633
- "type": "integer"
1634
- },
1635
- "perPage": {
1636
- "type": "integer"
1637
- },
1638
- "nextToken": {
1639
- "type": "string"
1640
- }
1641
- }
1642
- }
1643
- }
1644
- }
1645
- }
1646
- }
1647
- },
1648
- "401": {
1649
- "description": "Unauthorized",
1650
- "content": {
1651
- "application/json": {
1652
- "schema": {
1653
- "type": "object",
1654
- "required": [
1655
- "message"
1656
- ],
1657
- "properties": {
1658
- "message": {
1659
- "description": "A human readable error message",
1660
- "type": "string"
1661
- }
1662
- }
1663
- }
1664
- }
1665
- }
1666
- },
1667
- "422": {
1668
- "description": "Insufficient credits or missing license",
1669
- "content": {
1670
- "application/json": {
1671
- "schema": {
1672
- "description": "Insufficient credits or missing license",
1673
- "type": "object",
1674
- "properties": {
1675
- "msg": {
1676
- "type": "string"
1677
- },
1678
- "code": {
1679
- "type": "string"
1680
- },
1681
- "data": {
1682
- "type": "object",
1683
- "properties": {
1684
- "productCategory": {
1685
- "type": "string"
1686
- },
1687
- "additionalCreditsNeeded": {
1688
- "type": "integer"
1689
- }
1690
- }
1691
- }
1692
- }
1693
- }
1694
- }
1695
- }
1696
- },
1697
- "500": {
1698
- "description": "Unexpected error",
1699
- "content": {
1700
- "application/json": {
1701
- "schema": {
1702
- "type": "object",
1703
- "required": [
1704
- "message"
1705
- ],
1706
- "properties": {
1707
- "message": {
1708
- "description": "A human readable error message",
1709
- "type": "string"
1710
- }
1711
- }
1712
- }
1713
- }
1714
- }
1715
- }
1716
- }
1717
- }
1718
- },
1719
- "/companies/research": {
1720
- "post": {
1721
- "summary": "Research companies",
1722
- "description": "Research companies by searchResultId from company search results",
1723
- "operationId": "researchCompanies",
1724
- "tags": [
1725
- "Company Research"
1726
- ],
1727
- "security": [
1728
- {
1729
- "OAuth2": []
1730
- }
1731
- ],
1732
- "requestBody": {
1733
- "required": true,
1734
- "content": {
1735
- "application/json": {
1736
- "schema": {
1737
- "type": "object",
1738
- "properties": {
1739
- "searchResultIds": {
1740
- "type": "array",
1741
- "maxItems": 100,
1742
- "items": {
1743
- "type": "string"
1744
- }
1745
- },
1746
- "companies": {
1747
- "description": "Must include one of the following properties:\n- domain\n- companyName\n",
1748
- "type": "array",
1749
- "maxItems": 100,
1750
- "items": {
1751
- "type": "object",
1752
- "properties": {
1753
- "domain": {
1754
- "type": "string"
1755
- },
1756
- "companyName": {
1757
- "type": "string"
1758
- }
1759
- }
1760
- }
1761
- }
1762
- }
1763
- }
1764
- }
1765
- }
1766
- },
1767
- "responses": {
1768
- "202": {
1769
- "description": "The request IDs for research",
1770
- "content": {
1771
- "application/json": {
1772
- "schema": {
1773
- "type": "object",
1774
- "properties": {
1775
- "requestIds": {
1776
- "type": "array",
1777
- "items": {
1778
- "type": "string"
1779
- }
1780
- }
1781
- }
1782
- }
1783
- }
1784
- }
1785
- },
1786
- "401": {
1787
- "description": "Unauthorized",
1788
- "content": {
1789
- "application/json": {
1790
- "schema": {
1791
- "type": "object",
1792
- "required": [
1793
- "message"
1794
- ],
1795
- "properties": {
1796
- "message": {
1797
- "description": "A human readable error message",
1798
- "type": "string"
1799
- }
1800
- }
1801
- }
1802
- }
1803
- }
1804
- },
1805
- "422": {
1806
- "description": "Insufficient credits or missing license",
1807
- "content": {
1808
- "application/json": {
1809
- "schema": {
1810
- "description": "Insufficient credits or missing license",
1811
- "type": "object",
1812
- "properties": {
1813
- "msg": {
1814
- "type": "string"
1815
- },
1816
- "code": {
1817
- "type": "string"
1818
- },
1819
- "data": {
1820
- "type": "object",
1821
- "properties": {
1822
- "productCategory": {
1823
- "type": "string"
1824
- },
1825
- "additionalCreditsNeeded": {
1826
- "type": "integer"
1827
- }
1828
- }
1829
- }
1830
- }
1831
- }
1832
- }
1833
- }
1834
- },
1835
- "500": {
1836
- "description": "Unexpected error",
1837
- "content": {
1838
- "application/json": {
1839
- "schema": {
1840
- "type": "object",
1841
- "required": [
1842
- "message"
1843
- ],
1844
- "properties": {
1845
- "message": {
1846
- "description": "A human readable error message",
1847
- "type": "string"
1848
- }
1849
- }
1850
- }
1851
- }
1852
- }
1853
- }
1854
- }
1855
- }
1856
- },
1857
- "/companies/research/poll": {
1858
- "get": {
1859
- "summary": "Poll Company Research",
1860
- "description": "Get the results/status of a company research",
1861
- "operationId": "pollCompanyResearchResults",
1862
- "tags": [
1863
- "Company Research"
1864
- ],
1865
- "security": [
1866
- {
1867
- "OAuth2": []
1868
- }
1869
- ],
1870
- "parameters": [
1871
- {
1872
- "name": "requestIds",
1873
- "required": true,
1874
- "in": "query",
1875
- "description": "The id of the research request.",
1876
- "example": "1,2,3,4,5",
1877
- "schema": {
1878
- "type": "array",
1879
- "minItems": 1,
1880
- "maxItems": 100,
1881
- "items": {
1882
- "type": "string"
1883
- }
1884
- }
1885
- }
1886
- ],
1887
- "responses": {
1888
- "200": {
1889
- "description": "Poll Results",
1890
- "content": {
1891
- "application/json": {
1892
- "schema": {
1893
- "type": "object",
1894
- "properties": {
1895
- "data": {
1896
- "type": "object",
1897
- "properties": {
1898
- "requestId": {
1899
- "type": "string"
1900
- },
1901
- "status": {
1902
- "type": "string"
1903
- },
1904
- "results": {
1905
- "type": "array",
1906
- "description": "Company research data",
1907
- "items": {
1908
- "type": "object",
1909
- "properties": {
1910
- "advertisingIntelligenceUrl": {
1911
- "type": "string"
1912
- },
1913
- "alexaScoreUrl": {
1914
- "type": "string"
1915
- },
1916
- "annualRevenue": {
1917
- "type": "string"
1918
- },
1919
- "apiResearchId": {
1920
- "type": "string",
1921
- "description": "The API research identifier for companies created through API research",
1922
- "example": "research-123"
1923
- },
1924
- "phones": {
1925
- "type": "string"
1926
- },
1927
- "phonesAiScores": {
1928
- "type": "string"
1929
- },
1930
- "createdAt": {
1931
- "type": "string",
1932
- "example": "2024-04-21T14:30:00.000Z"
1933
- },
1934
- "description": {
1935
- "type": "string"
1936
- },
1937
- "domain": {
1938
- "type": "string"
1939
- },
1940
- "employeeReviewsUrl": {
1941
- "type": "string"
1942
- },
1943
- "foundedOn": {
1944
- "type": "string"
1945
- },
1946
- "googleFinanceUrl": {
1947
- "type": "string"
1948
- },
1949
- "googleResearchUrl": {
1950
- "type": "string"
1951
- },
1952
- "industries": {
1953
- "type": "string"
1954
- },
1955
- "intelUrl": {
1956
- "type": "string"
1957
- },
1958
- "jobPostingsUrl": {
1959
- "type": "string"
1960
- },
1961
- "linkedInProfileUrl": {
1962
- "type": "string"
1963
- },
1964
- "linkedInId": {
1965
- "type": "string"
1966
- },
1967
- "localSportsTeamsUrl": {
1968
- "type": "string"
1969
- },
1970
- "localWeatherUrl": {
1971
- "type": "string"
1972
- },
1973
- "location": {
1974
- "type": "object",
1975
- "properties": {
1976
- "street1": {
1977
- "type": "string"
1978
- },
1979
- "city": {
1980
- "type": "string"
1981
- },
1982
- "state": {
1983
- "type": "string"
1984
- },
1985
- "postCode": {
1986
- "type": "string"
1987
- },
1988
- "country": {
1989
- "type": "string"
1990
- },
1991
- "countryAbbr": {
1992
- "type": "string"
1993
- },
1994
- "countryAlpha2": {
1995
- "type": "string"
1996
- },
1997
- "countryAlpha3": {
1998
- "type": "string"
1999
- },
2000
- "fullString": {
2001
- "type": "string"
2002
- }
2003
- }
2004
- },
2005
- "name": {
2006
- "type": "string"
2007
- },
2008
- "newsUrl": {
2009
- "type": "string"
2010
- },
2011
- "paidSearchIntelligenceUrl": {
2012
- "type": "string"
2013
- },
2014
- "paidSearchKeywordsIntelligenceUrl": {
2015
- "type": "string"
2016
- },
2017
- "revenueRange": {
2018
- "type": "string"
2019
- },
2020
- "searchMarketingIntelligenceUrl": {
2021
- "type": "string"
2022
- },
2023
- "secFilingsUrl": {
2024
- "type": "string"
2025
- },
2026
- "seoResearchUrl": {
2027
- "type": "string"
2028
- },
2029
- "sicCode": {
2030
- "type": "string"
2031
- },
2032
- "similarWebsitesUrl": {
2033
- "type": "string"
2034
- },
2035
- "socialMediaMentionsUrl": {
2036
- "type": "string"
2037
- },
2038
- "socialMediaPostsUrl": {
2039
- "type": "string"
2040
- },
2041
- "socialPostsUrl": {
2042
- "type": "string"
2043
- },
2044
- "staffCount": {
2045
- "type": "string"
2046
- },
2047
- "staffCountRange": {
2048
- "type": "string"
2049
- },
2050
- "topTechnologies": {
2051
- "type": "string"
2052
- },
2053
- "updatedAt": {
2054
- "type": "string",
2055
- "example": "2024-04-21T14:30:00.000Z"
2056
- },
2057
- "webTechnologiesUrl": {
2058
- "type": "string"
2059
- },
2060
- "websiteAuditUrl": {
2061
- "type": "string"
2062
- },
2063
- "websiteAudit2Url": {
2064
- "type": "string"
2065
- },
2066
- "websiteGraderUrl": {
2067
- "type": "string"
2068
- },
2069
- "whoisUrl": {
2070
- "type": "string"
2071
- },
2072
- "wikipediaUrl": {
2073
- "type": "string"
2074
- },
2075
- "yahooFinanceUrl": {
2076
- "type": "string"
2077
- }
2078
- }
2079
- }
2080
- }
2081
- }
2082
- }
2083
- }
2084
- }
2085
- }
2086
- }
2087
- },
2088
- "401": {
2089
- "description": "Unauthorized",
2090
- "content": {
2091
- "application/json": {
2092
- "schema": {
2093
- "type": "object",
2094
- "required": [
2095
- "message"
2096
- ],
2097
- "properties": {
2098
- "message": {
2099
- "description": "A human readable error message",
2100
- "type": "string"
2101
- }
2102
- }
2103
- }
2104
- }
2105
- }
2106
- },
2107
- "422": {
2108
- "description": "Insufficient credits or missing license",
2109
- "content": {
2110
- "application/json": {
2111
- "schema": {
2112
- "description": "Insufficient credits or missing license",
2113
- "type": "object",
2114
- "properties": {
2115
- "msg": {
2116
- "type": "string"
2117
- },
2118
- "code": {
2119
- "type": "string"
2120
- },
2121
- "data": {
2122
- "type": "object",
2123
- "properties": {
2124
- "productCategory": {
2125
- "type": "string"
2126
- },
2127
- "additionalCreditsNeeded": {
2128
- "type": "integer"
2129
- }
2130
- }
2131
- }
2132
- }
2133
- }
2134
- }
2135
- }
2136
- },
2137
- "500": {
2138
- "description": "Unexpected error",
2139
- "content": {
2140
- "application/json": {
2141
- "schema": {
2142
- "type": "object",
2143
- "required": [
2144
- "message"
2145
- ],
2146
- "properties": {
2147
- "message": {
2148
- "description": "A human readable error message",
2149
- "type": "string"
2150
- }
2151
- }
2152
- }
2153
- }
2154
- }
2155
- }
2156
- }
2157
- }
2158
- },
2159
- "/contacts/research": {
2160
- "post": {
2161
- "summary": "Research contacts",
2162
- "description": "Research contacts by searchResultId from contact search results or Contact enrich",
2163
- "operationId": "researchContacts",
2164
- "tags": [
2165
- "Contact Research"
2166
- ],
2167
- "security": [
2168
- {
2169
- "OAuth2": []
2170
- }
2171
- ],
2172
- "requestBody": {
2173
- "required": true,
2174
- "content": {
2175
- "application/json": {
2176
- "examples": {
2177
- "searchResultIds": {
2178
- "summary": "Contact research via searchResultIds",
2179
- "value": {
2180
- "searchResultIds": [
2181
- "searchResultId1",
2182
- "searchResultId2"
2183
- ]
2184
- }
2185
- },
2186
- "contacts": {
2187
- "summary": "Contact research via contacts",
2188
- "value": {
2189
- "contacts": [
2190
- {
2191
- "contactName": "John Doe",
2192
- "companyName": "Acme Corp"
2193
- }
2194
- ]
2195
- }
2196
- },
2197
- "jobChanges": {
2198
- "summary": "Contact research with job changes",
2199
- "value": {
2200
- "isJobChange": true,
2201
- "contacts": [
2202
- {
2203
- "contactName": "John Doe",
2204
- "companyName": "Acme Corp"
2205
- },
2206
- {
2207
- "contactName": "Jane Doe",
2208
- "companyName": "Acme Corp",
2209
- "title": "Software Engineer"
2210
- }
2211
- ]
2212
- }
2213
- }
2214
- },
2215
- "schema": {
2216
- "type": "object",
2217
- "properties": {
2218
- "searchResultIds": {
2219
- "type": "array",
2220
- "description": "The search result IDs to research",
2221
- "maxItems": 100,
2222
- "items": {
2223
- "type": "string"
2224
- }
2225
- },
2226
- "isJobChange": {
2227
- "type": "boolean"
2228
- },
2229
- "contacts": {
2230
- "description": "Contact enrich, must include one of the following properties:\n- contactName and companyName (optional title for Job Changes)\n- contactName and domain\n- email\n- liProfileUrl\n- liSalesNavUrl\n- liRecruiterUrl\n\nWhen isJobChange flag is set to true, searchResultIds should not be used.\n",
2231
- "type": "array",
2232
- "maxItems": 100,
2233
- "items": {
2234
- "type": "object",
2235
- "properties": {
2236
- "contactName": {
2237
- "type": "string"
2238
- },
2239
- "companyName": {
2240
- "type": "string"
2241
- },
2242
- "domain": {
2243
- "type": "string"
2244
- },
2245
- "email": {
2246
- "type": "string"
2247
- },
2248
- "liProfileUrl": {
2249
- "type": "string"
2250
- },
2251
- "liSalesNavUrl": {
2252
- "type": "string"
2253
- },
2254
- "liRecruiterUrl": {
2255
- "type": "string"
2256
- }
2257
- }
2258
- }
2259
- }
2260
- }
2261
- }
2262
- }
2263
- }
2264
- },
2265
- "responses": {
2266
- "202": {
2267
- "description": "The request IDs for research",
2268
- "content": {
2269
- "application/json": {
2270
- "schema": {
2271
- "type": "object",
2272
- "properties": {
2273
- "requestIds": {
2274
- "type": "array",
2275
- "maxItems": 100,
2276
- "items": {
2277
- "type": "string"
2278
- }
2279
- }
2280
- }
2281
- }
2282
- }
2283
- }
2284
- },
2285
- "401": {
2286
- "description": "Unauthorized",
2287
- "content": {
2288
- "application/json": {
2289
- "schema": {
2290
- "type": "object",
2291
- "required": [
2292
- "message"
2293
- ],
2294
- "properties": {
2295
- "message": {
2296
- "description": "A human readable error message",
2297
- "type": "string"
2298
- }
2299
- }
2300
- }
2301
- }
2302
- }
2303
- },
2304
- "422": {
2305
- "description": "Insufficient credits or missing license",
2306
- "content": {
2307
- "application/json": {
2308
- "schema": {
2309
- "description": "Insufficient credits or missing license",
2310
- "type": "object",
2311
- "properties": {
2312
- "msg": {
2313
- "type": "string"
2314
- },
2315
- "code": {
2316
- "type": "string"
2317
- },
2318
- "data": {
2319
- "type": "object",
2320
- "properties": {
2321
- "productCategory": {
2322
- "type": "string"
2323
- },
2324
- "additionalCreditsNeeded": {
2325
- "type": "integer"
2326
- }
2327
- }
2328
- }
2329
- }
2330
- }
2331
- }
2332
- }
2333
- },
2334
- "500": {
2335
- "description": "Unexpected error",
2336
- "content": {
2337
- "application/json": {
2338
- "schema": {
2339
- "type": "object",
2340
- "required": [
2341
- "message"
2342
- ],
2343
- "properties": {
2344
- "message": {
2345
- "description": "A human readable error message",
2346
- "type": "string"
2347
- }
2348
- }
2349
- }
2350
- }
2351
- }
2352
- }
2353
- }
2354
- }
2355
- },
2356
- "/contacts/research/poll": {
2357
- "get": {
2358
- "summary": "Poll Contact Research",
2359
- "description": "Get the results/status of a contact research request",
2360
- "operationId": "pollContactsResearchResults",
2361
- "tags": [
2362
- "Contact Research"
2363
- ],
2364
- "security": [
2365
- {
2366
- "OAuth2": []
2367
- }
2368
- ],
2369
- "parameters": [
2370
- {
2371
- "name": "requestIds",
2372
- "required": true,
2373
- "in": "query",
2374
- "description": "The id of the research request.",
2375
- "example": "1,2,3,4,5",
2376
- "schema": {
2377
- "type": "array",
2378
- "minItems": 1,
2379
- "maxItems": 100,
2380
- "items": {
2381
- "type": "string"
2382
- }
2383
- }
2384
- }
2385
- ],
2386
- "responses": {
2387
- "200": {
2388
- "description": "Poll Results",
2389
- "content": {
2390
- "application/json": {
2391
- "schema": {
2392
- "type": "object",
2393
- "properties": {
2394
- "success": {
2395
- "type": "boolean"
2396
- },
2397
- "data": {
2398
- "type": "array",
2399
- "items": {
2400
- "type": "object",
2401
- "properties": {
2402
- "requestId": {
2403
- "type": "string"
2404
- },
2405
- "searchResultId": {
2406
- "type": "string"
2407
- },
2408
- "status": {
2409
- "type": "string"
2410
- },
2411
- "message": {
2412
- "type": "string"
2413
- },
2414
- "contact": {
2415
- "type": "object",
2416
- "properties": {
2417
- "username": {
2418
- "type": "string"
2419
- },
2420
- "createdAt": {
2421
- "type": "string"
2422
- },
2423
- "updatedAt": {
2424
- "type": "string"
2425
- },
2426
- "firstName": {
2427
- "type": "string"
2428
- },
2429
- "middleName": {
2430
- "type": "string"
2431
- },
2432
- "lastName": {
2433
- "type": "string"
2434
- },
2435
- "fullName": {
2436
- "type": "string"
2437
- },
2438
- "name": {
2439
- "type": "string"
2440
- },
2441
- "nameOriginal": {
2442
- "type": "string"
2443
- },
2444
- "email": {
2445
- "type": "string"
2446
- },
2447
- "personalEmail": {
2448
- "type": "string"
2449
- },
2450
- "phone": {
2451
- "type": "string"
2452
- },
2453
- "contactPhone1": {
2454
- "type": "string"
2455
- },
2456
- "contactPhone1DataType": {
2457
- "type": "string"
2458
- },
2459
- "contactPhone1TotalAI": {
2460
- "type": "string"
2461
- },
2462
- "companyPhone1": {
2463
- "type": "string"
2464
- },
2465
- "companyPhone1DataType": {
2466
- "type": "string"
2467
- },
2468
- "companyPhone1TotalAI": {
2469
- "type": "string"
2470
- },
2471
- "company": {
2472
- "type": "string"
2473
- },
2474
- "companyOriginal": {
2475
- "type": "string"
2476
- },
2477
- "companyIndustry": {
2478
- "type": "string"
2479
- },
2480
- "companyStaffCount": {
2481
- "type": "integer"
2482
- },
2483
- "companyStaffCountRange": {
2484
- "type": "string"
2485
- },
2486
- "companyAnnualRevenue": {
2487
- "type": "string"
2488
- },
2489
- "companyDomain": {
2490
- "type": "string"
2491
- },
2492
- "companyRevenueRange": {
2493
- "type": "string"
2494
- },
2495
- "companyLIProfileUrl": {
2496
- "type": "string"
2497
- },
2498
- "companyLinkedInId": {
2499
- "type": "string"
2500
- },
2501
- "title": {
2502
- "type": "string"
2503
- },
2504
- "lIProfileUrl": {
2505
- "type": "string"
2506
- },
2507
- "lISalesNavUrl": {
2508
- "type": "string"
2509
- },
2510
- "lIRecruiterUrl": {
2511
- "type": "string"
2512
- },
2513
- "contactLocation": {
2514
- "type": "object",
2515
- "properties": {
2516
- "city": {
2517
- "type": "string"
2518
- },
2519
- "state": {
2520
- "type": "string"
2521
- },
2522
- "postCode": {
2523
- "type": "string"
2524
- },
2525
- "county": {
2526
- "type": "string"
2527
- },
2528
- "country": {
2529
- "type": "string"
2530
- },
2531
- "stateAbbr": {
2532
- "type": "string"
2533
- },
2534
- "countryAbbr": {
2535
- "type": "string"
2536
- },
2537
- "countryAlpha2": {
2538
- "type": "string"
2539
- },
2540
- "countryAlpha3": {
2541
- "type": "string"
2542
- },
2543
- "countryNumeric": {
2544
- "type": "string"
2545
- },
2546
- "fullString": {
2547
- "type": "string"
2548
- },
2549
- "timezone": {
2550
- "type": "string"
2551
- },
2552
- "timezoneRawOffset": {
2553
- "type": "string"
2554
- },
2555
- "timezoneAbbr": {
2556
- "type": "string"
2557
- }
2558
- }
2559
- },
2560
- "companyLocation": {
2561
- "type": "object",
2562
- "properties": {
2563
- "street1": {
2564
- "type": "string"
2565
- },
2566
- "street2": {
2567
- "type": "string"
2568
- },
2569
- "street3": {
2570
- "type": "string"
2571
- },
2572
- "city": {
2573
- "type": "string"
2574
- },
2575
- "state": {
2576
- "type": "string"
2577
- },
2578
- "postCode": {
2579
- "type": "string"
2580
- },
2581
- "county": {
2582
- "type": "string"
2583
- },
2584
- "country": {
2585
- "type": "string"
2586
- },
2587
- "stateAbbr": {
2588
- "type": "string"
2589
- },
2590
- "countryAbbr": {
2591
- "type": "string"
2592
- },
2593
- "countryAlpha2": {
2594
- "type": "string"
2595
- },
2596
- "countryAlpha3": {
2597
- "type": "string"
2598
- },
2599
- "countryNumeric": {
2600
- "type": "string"
2601
- },
2602
- "fullString": {
2603
- "type": "string"
2604
- }
2605
- }
2606
- },
2607
- "website": {
2608
- "type": "string"
2609
- },
2610
- "email1": {
2611
- "type": "string"
2612
- },
2613
- "email1Selected": {
2614
- "type": "boolean"
2615
- },
2616
- "email1TotalAI": {
2617
- "type": "string"
2618
- },
2619
- "email1EmailAI": {
2620
- "type": "string"
2621
- },
2622
- "email2": {
2623
- "type": "string"
2624
- },
2625
- "email2TotalAI": {
2626
- "type": "string"
2627
- },
2628
- "email2EmailAI": {
2629
- "type": "string"
2630
- },
2631
- "email3": {
2632
- "type": "string"
2633
- },
2634
- "email3TotalAI": {
2635
- "type": "string"
2636
- },
2637
- "email3EmailAI": {
2638
- "type": "string"
2639
- },
2640
- "jobHistory": {
2641
- "type": "array",
2642
- "description": "Contact's job history (requires Job Changes feature flag access)",
2643
- "items": {
2644
- "type": "object",
2645
- "properties": {
2646
- "companyName": {
2647
- "type": "string",
2648
- "description": "Company name for this job"
2649
- },
2650
- "title": {
2651
- "type": "string",
2652
- "description": "Job title/position"
2653
- },
2654
- "startedAt": {
2655
- "type": "string",
2656
- "format": "date-time",
2657
- "description": "When the contact started this job"
2658
- },
2659
- "endedAt": {
2660
- "type": "string",
2661
- "format": "date-time",
2662
- "description": "When the contact ended this job (null for current job)"
2663
- }
2664
- }
2665
- }
2666
- },
2667
- "apiResearchId": {
2668
- "type": "string",
2669
- "description": "The Id return from the /contacts/research endpoint"
2670
- }
2671
- }
2672
- }
2673
- }
2674
- }
2675
- }
2676
- }
2677
- }
2678
- }
2679
- }
2680
- },
2681
- "401": {
2682
- "description": "Unauthorized",
2683
- "content": {
2684
- "application/json": {
2685
- "schema": {
2686
- "type": "object",
2687
- "required": [
2688
- "message"
2689
- ],
2690
- "properties": {
2691
- "message": {
2692
- "description": "A human readable error message",
2693
- "type": "string"
2694
- }
2695
- }
2696
- }
2697
- }
2698
- }
2699
- },
2700
- "422": {
2701
- "description": "Insufficient credits or missing license",
2702
- "content": {
2703
- "application/json": {
2704
- "schema": {
2705
- "description": "Insufficient credits or missing license",
2706
- "type": "object",
2707
- "properties": {
2708
- "msg": {
2709
- "type": "string"
2710
- },
2711
- "code": {
2712
- "type": "string"
2713
- },
2714
- "data": {
2715
- "type": "object",
2716
- "properties": {
2717
- "productCategory": {
2718
- "type": "string"
2719
- },
2720
- "additionalCreditsNeeded": {
2721
- "type": "integer"
2722
- }
2723
- }
2724
- }
2725
- }
2726
- }
2727
- }
2728
- }
2729
- },
2730
- "500": {
2731
- "description": "Unexpected error",
2732
- "content": {
2733
- "application/json": {
2734
- "schema": {
2735
- "type": "object",
2736
- "required": [
2737
- "message"
2738
- ],
2739
- "properties": {
2740
- "message": {
2741
- "description": "A human readable error message",
2742
- "type": "string"
2743
- }
2744
- }
2745
- }
2746
- }
2747
- }
2748
- }
2749
- }
2750
- }
2751
- }
2752
- },
2753
- "tags": [],
2754
- "x-webhooks": {
2755
- "company-researched": {
2756
- "post": {
2757
- "summary": "Researched Company Webhook",
2758
- "security": [
2759
- {
2760
- "webhookSecret": []
2761
- }
2762
- ],
2763
- "description": "Pushes the results of a company research request.\nTo create a webhook, go to [Seamless.AI | Settings](https://login.seamless.ai/settings) > Webhooks and click the Create New Webhook button and select Company Research as the type.\n",
2764
- "tags": [
2765
- "Company Research"
2766
- ],
2767
- "requestBody": {
2768
- "content": {
2769
- "application/json": {
2770
- "schema": {
2771
- "type": "object",
2772
- "properties": {
2773
- "advertisingIntelligenceUrl": {
2774
- "type": "string"
2775
- },
2776
- "alexaScoreUrl": {
2777
- "type": "string"
2778
- },
2779
- "annualRevenue": {
2780
- "type": "string"
2781
- },
2782
- "apiResearchId": {
2783
- "type": "string",
2784
- "description": "The API research identifier for companies created through API research",
2785
- "example": "research-123"
2786
- },
2787
- "phones": {
2788
- "type": "string"
2789
- },
2790
- "phonesAiScores": {
2791
- "type": "string"
2792
- },
2793
- "createdAt": {
2794
- "type": "string",
2795
- "example": "2024-04-21T14:30:00.000Z"
2796
- },
2797
- "description": {
2798
- "type": "string"
2799
- },
2800
- "domain": {
2801
- "type": "string"
2802
- },
2803
- "employeeReviewsUrl": {
2804
- "type": "string"
2805
- },
2806
- "foundedOn": {
2807
- "type": "string"
2808
- },
2809
- "googleFinanceUrl": {
2810
- "type": "string"
2811
- },
2812
- "googleResearchUrl": {
2813
- "type": "string"
2814
- },
2815
- "industries": {
2816
- "type": "string"
2817
- },
2818
- "intelUrl": {
2819
- "type": "string"
2820
- },
2821
- "jobPostingsUrl": {
2822
- "type": "string"
2823
- },
2824
- "linkedInProfileUrl": {
2825
- "type": "string"
2826
- },
2827
- "linkedInId": {
2828
- "type": "string"
2829
- },
2830
- "localSportsTeamsUrl": {
2831
- "type": "string"
2832
- },
2833
- "localWeatherUrl": {
2834
- "type": "string"
2835
- },
2836
- "location": {
2837
- "type": "object",
2838
- "properties": {
2839
- "street1": {
2840
- "type": "string"
2841
- },
2842
- "city": {
2843
- "type": "string"
2844
- },
2845
- "state": {
2846
- "type": "string"
2847
- },
2848
- "postCode": {
2849
- "type": "string"
2850
- },
2851
- "country": {
2852
- "type": "string"
2853
- },
2854
- "countryAbbr": {
2855
- "type": "string"
2856
- },
2857
- "countryAlpha2": {
2858
- "type": "string"
2859
- },
2860
- "countryAlpha3": {
2861
- "type": "string"
2862
- },
2863
- "fullString": {
2864
- "type": "string"
2865
- }
2866
- }
2867
- },
2868
- "name": {
2869
- "type": "string"
2870
- },
2871
- "newsUrl": {
2872
- "type": "string"
2873
- },
2874
- "paidSearchIntelligenceUrl": {
2875
- "type": "string"
2876
- },
2877
- "paidSearchKeywordsIntelligenceUrl": {
2878
- "type": "string"
2879
- },
2880
- "revenueRange": {
2881
- "type": "string"
2882
- },
2883
- "searchMarketingIntelligenceUrl": {
2884
- "type": "string"
2885
- },
2886
- "secFilingsUrl": {
2887
- "type": "string"
2888
- },
2889
- "seoResearchUrl": {
2890
- "type": "string"
2891
- },
2892
- "sicCode": {
2893
- "type": "string"
2894
- },
2895
- "similarWebsitesUrl": {
2896
- "type": "string"
2897
- },
2898
- "socialMediaMentionsUrl": {
2899
- "type": "string"
2900
- },
2901
- "socialMediaPostsUrl": {
2902
- "type": "string"
2903
- },
2904
- "socialPostsUrl": {
2905
- "type": "string"
2906
- },
2907
- "staffCount": {
2908
- "type": "string"
2909
- },
2910
- "staffCountRange": {
2911
- "type": "string"
2912
- },
2913
- "topTechnologies": {
2914
- "type": "string"
2915
- },
2916
- "updatedAt": {
2917
- "type": "string",
2918
- "example": "2024-04-21T14:30:00.000Z"
2919
- },
2920
- "webTechnologiesUrl": {
2921
- "type": "string"
2922
- },
2923
- "websiteAuditUrl": {
2924
- "type": "string"
2925
- },
2926
- "websiteAudit2Url": {
2927
- "type": "string"
2928
- },
2929
- "websiteGraderUrl": {
2930
- "type": "string"
2931
- },
2932
- "whoisUrl": {
2933
- "type": "string"
2934
- },
2935
- "wikipediaUrl": {
2936
- "type": "string"
2937
- },
2938
- "yahooFinanceUrl": {
2939
- "type": "string"
2940
- }
2941
- }
2942
- }
2943
- }
2944
- }
2945
- },
2946
- "responses": {
2947
- "2XX": {
2948
- "description": "Return a 2XX status to indicate that the data was received successfully"
2949
- }
2950
- }
2951
- }
2952
- },
2953
- "contact-researched": {
2954
- "post": {
2955
- "summary": "Researched Contact Webhook",
2956
- "security": [
2957
- {
2958
- "webhookSecret": []
2959
- }
2960
- ],
2961
- "description": "Pushes the results of a company research request.\nTo create a webhook, go to [Seamless.AI | Settings](https://login.seamless.ai/settings) > Webhooks and click the Create New Webhook button and select Contact Research as the type.\n",
2962
- "tags": [
2963
- "Contact Research"
2964
- ],
2965
- "requestBody": {
2966
- "content": {
2967
- "application/json": {
2968
- "schema": {
2969
- "type": "object",
2970
- "properties": {
2971
- "username": {
2972
- "type": "string"
2973
- },
2974
- "createdAt": {
2975
- "type": "string"
2976
- },
2977
- "updatedAt": {
2978
- "type": "string"
2979
- },
2980
- "firstName": {
2981
- "type": "string"
2982
- },
2983
- "middleName": {
2984
- "type": "string"
2985
- },
2986
- "lastName": {
2987
- "type": "string"
2988
- },
2989
- "fullName": {
2990
- "type": "string"
2991
- },
2992
- "name": {
2993
- "type": "string"
2994
- },
2995
- "nameOriginal": {
2996
- "type": "string"
2997
- },
2998
- "email": {
2999
- "type": "string"
3000
- },
3001
- "personalEmail": {
3002
- "type": "string"
3003
- },
3004
- "phone": {
3005
- "type": "string"
3006
- },
3007
- "contactPhone1": {
3008
- "type": "string"
3009
- },
3010
- "contactPhone1DataType": {
3011
- "type": "string"
3012
- },
3013
- "contactPhone1TotalAI": {
3014
- "type": "string"
3015
- },
3016
- "companyPhone1": {
3017
- "type": "string"
3018
- },
3019
- "companyPhone1DataType": {
3020
- "type": "string"
3021
- },
3022
- "companyPhone1TotalAI": {
3023
- "type": "string"
3024
- },
3025
- "company": {
3026
- "type": "string"
3027
- },
3028
- "companyOriginal": {
3029
- "type": "string"
3030
- },
3031
- "companyIndustry": {
3032
- "type": "string"
3033
- },
3034
- "companyStaffCount": {
3035
- "type": "integer"
3036
- },
3037
- "companyStaffCountRange": {
3038
- "type": "string"
3039
- },
3040
- "companyAnnualRevenue": {
3041
- "type": "string"
3042
- },
3043
- "companyDomain": {
3044
- "type": "string"
3045
- },
3046
- "companyRevenueRange": {
3047
- "type": "string"
3048
- },
3049
- "companyLIProfileUrl": {
3050
- "type": "string"
3051
- },
3052
- "companyLinkedInId": {
3053
- "type": "string"
3054
- },
3055
- "title": {
3056
- "type": "string"
3057
- },
3058
- "lIProfileUrl": {
3059
- "type": "string"
3060
- },
3061
- "lISalesNavUrl": {
3062
- "type": "string"
3063
- },
3064
- "lIRecruiterUrl": {
3065
- "type": "string"
3066
- },
3067
- "contactLocation": {
3068
- "type": "object",
3069
- "properties": {
3070
- "city": {
3071
- "type": "string"
3072
- },
3073
- "state": {
3074
- "type": "string"
3075
- },
3076
- "postCode": {
3077
- "type": "string"
3078
- },
3079
- "county": {
3080
- "type": "string"
3081
- },
3082
- "country": {
3083
- "type": "string"
3084
- },
3085
- "stateAbbr": {
3086
- "type": "string"
3087
- },
3088
- "countryAbbr": {
3089
- "type": "string"
3090
- },
3091
- "countryAlpha2": {
3092
- "type": "string"
3093
- },
3094
- "countryAlpha3": {
3095
- "type": "string"
3096
- },
3097
- "countryNumeric": {
3098
- "type": "string"
3099
- },
3100
- "fullString": {
3101
- "type": "string"
3102
- },
3103
- "timezone": {
3104
- "type": "string"
3105
- },
3106
- "timezoneRawOffset": {
3107
- "type": "string"
3108
- },
3109
- "timezoneAbbr": {
3110
- "type": "string"
3111
- }
3112
- }
3113
- },
3114
- "companyLocation": {
3115
- "type": "object",
3116
- "properties": {
3117
- "street1": {
3118
- "type": "string"
3119
- },
3120
- "street2": {
3121
- "type": "string"
3122
- },
3123
- "street3": {
3124
- "type": "string"
3125
- },
3126
- "city": {
3127
- "type": "string"
3128
- },
3129
- "state": {
3130
- "type": "string"
3131
- },
3132
- "postCode": {
3133
- "type": "string"
3134
- },
3135
- "county": {
3136
- "type": "string"
3137
- },
3138
- "country": {
3139
- "type": "string"
3140
- },
3141
- "stateAbbr": {
3142
- "type": "string"
3143
- },
3144
- "countryAbbr": {
3145
- "type": "string"
3146
- },
3147
- "countryAlpha2": {
3148
- "type": "string"
3149
- },
3150
- "countryAlpha3": {
3151
- "type": "string"
3152
- },
3153
- "countryNumeric": {
3154
- "type": "string"
3155
- },
3156
- "fullString": {
3157
- "type": "string"
3158
- }
3159
- }
3160
- },
3161
- "website": {
3162
- "type": "string"
3163
- },
3164
- "email1": {
3165
- "type": "string"
3166
- },
3167
- "email1Selected": {
3168
- "type": "boolean"
3169
- },
3170
- "email1TotalAI": {
3171
- "type": "string"
3172
- },
3173
- "email1EmailAI": {
3174
- "type": "string"
3175
- },
3176
- "email2": {
3177
- "type": "string"
3178
- },
3179
- "email2TotalAI": {
3180
- "type": "string"
3181
- },
3182
- "email2EmailAI": {
3183
- "type": "string"
3184
- },
3185
- "email3": {
3186
- "type": "string"
3187
- },
3188
- "email3TotalAI": {
3189
- "type": "string"
3190
- },
3191
- "email3EmailAI": {
3192
- "type": "string"
3193
- },
3194
- "jobHistory": {
3195
- "type": "array",
3196
- "description": "Contact's job history (requires Job Changes feature flag access)",
3197
- "items": {
3198
- "type": "object",
3199
- "properties": {
3200
- "companyName": {
3201
- "type": "string",
3202
- "description": "Company name for this job"
3203
- },
3204
- "title": {
3205
- "type": "string",
3206
- "description": "Job title/position"
3207
- },
3208
- "startedAt": {
3209
- "type": "string",
3210
- "format": "date-time",
3211
- "description": "When the contact started this job"
3212
- },
3213
- "endedAt": {
3214
- "type": "string",
3215
- "format": "date-time",
3216
- "description": "When the contact ended this job (null for current job)"
3217
- }
3218
- }
3219
- }
3220
- },
3221
- "apiResearchId": {
3222
- "type": "string",
3223
- "description": "The Id return from the /contacts/research endpoint"
3224
- }
3225
- }
3226
- }
3227
- }
3228
- }
3229
- },
3230
- "responses": {
3231
- "2XX": {
3232
- "description": "Return a 2XX status to indicate that the data was received successfully"
3233
- }
3234
- }
3235
- }
3236
- }
3237
- }
3238
- }