-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path2025-11-26.json
More file actions
15002 lines (15002 loc) · 515 KB
/
2025-11-26.json
File metadata and controls
15002 lines (15002 loc) · 515 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"openapi": "3.1.1",
"info": {
"version": "",
"x-affinity-api-version": "2024-01-01",
"contact": {
"email": "support@affinity.co",
"name": "Affinity Support",
"url": "https://support.affinity.co"
},
"description": "# Introduction\n\nWelcome to Affinity API v2! This API provides a RESTful interface for building internal apps,\nautomated workflows, 3rd party integrations, and for connecting Affinity to the rest of your tech\nstack.\n\nThe legacy Affinity v1 API can be found at [api-docs.affinity.co](https://api-docs.affinity.co/).\nThe v2 API is not at feature parity with v1 - we are continuing to develop new v2 APIs to support\nall v1 functionality over time.\n\n**The Affinity APIs are only available on select license types.** See\n[this Help Center article](https://support.affinity.co/hc/en-us/articles/5563700459533-Getting-started-with-the-Affinity-API-FAQs)\nor contact your Customer Success Manager for more information.\n\n# Getting Started\n\nAll Affinity API endpoints use the base URL `https://api.affinity.co`. All v2 endpoint paths start\nwith `/v2`. Requests must be sent over HTTPS.\n\nThe first few sections of these docs cover general information on the API. Each subsequent section\ncovers a set of API endpoints.\n\nEach endpoint is documented with its accepted request parameters, expected response shapes, and a\nsample request and response. The shape of a given response can vary depending on what \"type\" of\nobject or data is being returned. When this is the case, the response documentation will include a\ndropdown that can be used to select the \"type\" for which to display the response shape.\n\n## Authentication\n\nAffinity API v2 uses API keys and **bearer authentication** (this is an important difference from\nAffinity API v1's use of basic authentication).\n\nTo generate an API key, navigate to the Settings page in the Affinity web app. You will need the\n\"Generate an API key\" role-based permission controlled by your Affinity admin. See\n[this Help Center article](https://support.affinity.co/hc/en-us/articles/360032633992-How-to-obtain-your-API-Key)\nfor full instructions on API key generation, and\n[this article](https://support.affinity.co/hc/en-us/articles/360015976732-Account-Level-Permissions)\nfor more information on role-based permissions in Affinity.\n\nProvide your API key as your bearer authentication token to start making calls to Affinity API v2.\n\nWe support one API key per user in your Affinity account. Your API key is able to read data and\nperform actions in Affinity on your behalf, so keep it safe as you would a password.\n\n## Permissions\n\n### Overall Requirements\n\nYou must have the \"Generate an API key\" permission to be able to work with the Affinity API. Most\nusers in Affinity have this by default — Contact your Affinity admin if you are not able to generate\nan API key, and see\n[this article](https://support.affinity.co/hc/en-us/articles/360015976732-Account-Level-Permissions)\nfor more information on role-based permissions in Affinity.\n\n### Resource-Level Permissions\n\nThe Affinity API respects sharing permissions that are set in-product. For example, if a given user\ndoes not have access to a list, note, or interaction in-product, they will not be able to see or\nmodify it via API.\n\n### Endpoint-Level Permissions\n\nMany API endpoints require endpoint-specific permissions in-product. These permissions, along with\nthe \"Generate an API key\" permission, are managed by your Affinity admin in the Settings page. In\nthe description of each endpoint you will see the required permissions needed.\n\n## Rate Limits\n\nThe Affinity API sets a limit on the number of calls that a user can make per minute, and that all\nthe users on an account can make per month. It also sets a reasonable limit on the number of\nconcurrent requests it will support from an account at one time.\n\nRequests to **both** Affinity API versions will count toward the one pool of requests allowed for a\nuser or account. Once a per-minute, monthly, or concurrent rate limit is hit, subsequent requests\nwill return an error code of 429. **We highly recommend designing your application to handle 429\nerrors.**\n\n### Per-Minute Limits (User-Level)\n\nTo help protect our systems, API requests will be halted at **900 per user, per minute.** We may\nalso lower this limit on a temporary basis to manage API availability.\n\n### Concurrent Request Limits (Account-Level)\n\nTo protect our systems and manage availability across customers, we set a reasonable limit on\nconcurrent requests at the account level. Customers should not expect to hit this limit unless they\nare hitting the API with heavy operations from many concurrent threads at once.\n\n### Monthly Plan Tier Limits (Account-Level)\n\nThe overall number of requests you can make per month will depend on your account's plan tier.\n**This monthly account-level limit resets at the end of each calendar month.** Current rate limits\nby plan tier are:\n\n| Plan Tier | Calls Per Month |\n| ---------- | --------------- |\n| Essentials | None |\n| Scale | 100k |\n| Advanced | 100k |\n| Enterprise | Unlimited\\* |\n\n\\*Per-Minute and Concurrent Request Limits still apply.\n\n### Rate Limit Headers\n\nAll API calls will return the following response headers with information about per-minute and\nmonthly limits:\n\n| Header | Description |\n| -------------------------------- | ------------------------------------------------------- |\n| X-Ratelimit-Limit-User | Number of requests allowed per minute for the user |\n| X-Ratelimit-Limit-User-Remaining | Number of requests remaining for the user |\n| X-Ratelimit-Limit-User-Reset | Time in seconds before the limit resets for the user |\n| X-Ratelimit-Limit-Org | Number of requests allowed per month for the account |\n| X-Ratelimit-Limit-Org-Remaining | Number of requests remaining for the account |\n| X-Ratelimit-Limit-Org-Reset | Time in seconds before the limit resets for the account |\n\n## Pagination\n\nWhen an endpoint is expected to return multiple results, we break the results into pages to make\nthem easier to handle. To cycle forward through multiple pages of data, look for the `nextUrl`\nproperty in the `pagination` portion of an API response, and use it for your next request. See\nendpoint documentation for more information.\n\n## Filtering\n\nSome endpoints support a filtering language for flexible and powerful queries. This allows for the\ncreation of complex filter expressions using different operators and boolean logic in a single\nfilter string. The description of each endpoint will contain information on which filter properties\nand operators are supported.\n\n### Rules\n\n- Spaces are insignificant by default. For example, `field = hello` and `field=hello` are both\n valid.\n- If spaces are significant, they need to be inside double quotes, for example,\n `field = \"hello world\"`\n- Special characters need to be escaped with a backslash: `field=\"hello\\\" world\"` <br> Full list of\n special characters: `\\ * ~ ! & = > < $ ^ | \" ' ( ) ] [ /`\n- Use `&` and `|` for boolean operations: `foo = 1 | baz = 2 & bar = 3`. Boolean Algebra Logic is\n assumed: `&` takes precedence over `|`. When evaluating the condition above, `baz = 2 & bar = 3`\n will be computed first, and then the result will be `or`'ed with `foo=1`\n- Parentheses can be used to specify the order of operations. In the example above, to make sure\n that `foo = 1 | baz = 2` is evaluated first, parentheses must be placed\n `(foo = 1 | baz = 2) & bar = 3`\n\n### Grammar\n\n#### Simple Types\n\n| Definition | Property Type | Operator | Example |\n| ------------------------ | ---------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------- |\n| exact match | all | = | content = “hello world” <br> content=hello |\n| starts with | text | =^ | content =^ he |\n| ends with | text | =$ | content =$ llo |\n| contains | text | =~ | content =~ lo |\n| greater than | int32, int64, float, double, decimal, date, datetime | \\> | count > 1 |\n| greater than or equal to | int32, int64, float, double, decimal, date, datetime | \\>= | content >= 1 |\n| less than | int32, int64, float, double, decimal, date, datetime | \\< | count < 1 |\n| less than or equal to | int32, int64, float, double, decimal, date, datetime | \\<= | content <= 1 |\n| is NULL | all | != \\* | content != \\* |\n| is not NULL | all | =\\* | content = \\* |\n| is empty | text | =\"\" | content = \"\" |\n| negation | all | ! | content != ”hello world” <br> !(content = ”hello world”) <br> !(content =^ “hello world”) |\n\n#### Collections (all types)\n\n| Definition | Operator | Example |\n| ------------------------- | -------- | ------------------------------------ |\n| exact match with ordering | = | industries = [Healthcare,Fintech] |\n| contains all | =~ | industries =~ [Healthcare,Fintech] |\n| empty | =[] | industries =[] |\n| negation | ! | !(industries = [Healthcare,Fintech]) |\n\n## Error Codes\n\nHere is a list of the error codes the API will return if something goes wrong (see endpoint\ndocumentation for endpoint-specific errors):\n\n| Error Code | Meaning |\n| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| 400 | Bad Request — See endpoint documentation for more information. |\n| 401 | Unauthorized — Your API key is invalid. |\n| 403 | Forbidden — Insufficient rights to a resource. |\n| 404 | Not Found — Requested resource does not exist. See endpoint documentation for more information. |\n| 405 | Method Not Allowed — The method being used is not supported for this resource. |\n| 422 | Unprocessable Entity — Malformed parameters supplied. This can also happen in cases the parameters supplied logically cannot complete the request. In this case, an appropriate error message is delivered. |\n| 429 | Too Many Requests — You have exceeded the rate limit. |\n| 500 | Internal Server Error — We had a problem with our server. Try again later. |\n| 503 | Service Unavailable — This shouldn't generally happen. Contact us if you encounter this error. |\n\n## Beta Endpoints\n\nYou’ll notice in our documentation that some endpoints will be marked as BETA. These endpoints are\nnewly released and will eventually progress to General Availability (GA). While an endpoint is in\nBETA there are some important things to consider:\n\n- The development of this endpoint may still be in progress. This means new capabilities, request\n parameters, response data, and performance improvements may be adjusted over time. Because of\n this, breaking changes may occur to the endpoint WITHOUT notice or versioning.\n- As this is an early release, bug fixes may still be ongoing as well, and we encourage you to\n report bugs to [support@affinity.co](mailto:support@affinity.co).\n- In addition, your feedback around the capabilities of the endpoint are highly valuable, please\n reach out to your CSM to provide feedback to our product team.\n\n# Data Model\n\n## The Basics\n\nThe three top-level objects in Affinity are **Persons, Companies, and Opportunities**. (Note:\nCompanies are called Organizations in the Affinity web app.) These have profiles in the Affinity web\napp and can be added to Lists.\n\nA **List** is a spreadsheet-like collection of rows tied to Persons, Companies, or Opportunities.\n\n- Each row on a List is a **List Entry**. A List Entry contains data and metadata about a given\n Person, Company, or Opportunity in the context of a List. This includes list-specific field data,\n and information about who added the row to the List and when.\n- A given entity can be added to a List more than once. These List Entries can have different\n List-specific field data and List Entry-level metadata.\n\nEach column on a List maps to a **Field**. Fields show up within Affinity profile pages, extensions,\nand integrations. There are two categories of fields:\n\n- **List-specific fields** are scoped to a single List. In the API, their data can only be accessed\n through the List Entry resource.\n- **Global fields** belong to entities directly. These can include default fields, fields created by\n you, enrichment fields, or relationship intelligence fields. They can be accessed through the\n Person/Company/Opportunity resources and the List Entry resource.\n\n## Working with Field Data\n\n### Field Types and IDs\n\nHere is a deeper look at the types of Fields in Affinity, differentiated by the scope and source of\ntheir data:\n\n| Field Type | Description | Example Fields | Field ID Pattern |\n| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |\n| `enriched` | Firmographic, funding, and people Fields populated by Affinity. These can be \"Affinity Data\" Fields or come from distinct data partners. | \"Affinity Data: Description\", \"Dealroom: Number of Employees\" | A string representing the enrichment source, followed by the field name, e.g. `affinity-data-description` or `dealroom-number-of-employees`. |\n| `list` | Fields that are specific to the context of a given list. These can only be accessed through `*/list-entries` endpoints in this version of the API. | Default \"Status\" and \"Amount\" columns, custom columns that pertain to a given List of deals or founders | `field-`, followed by a unique integer, e.g. `field-1234` |\n| `global` | Fields that persist across an Affinity account and are not list-specific. | \"My Firm's Founder Scoring Column\" | `field-`, followed by a unique integer, e.g. `field-1234` |\n| `relationship-intelligence` | Fields populated by Affinity from users' email and calendar data that provide insight into your firm's relationship with a given Person/Company/Opportunity. | \"Source of Introduction\", \"First Email\", \"Last Email\", \"First Event\", \"Last Event\", \"Next Event\", \"First Chat Message\", \"Last Chat Message\", \"Last Contact\" | A string similar to the field's name in-product, e.g. `source-of-introduction` |\n\n### Field Value Types\n\nField data can take a variety of shapes. These value types are described in the Affinity Help Center\n[creating columns in lists](https://support.affinity.co/hc/en-us/articles/115001608232-How-to-create-a-new-column-in-a-list).\nHere is a list of the same value types, as represented in this API. Notice how array types end with\n`-multi`:\n\n| Single Type | Array Type |\n| ------------------- | ------------------------- |\n| `text` | Not supported in Affinity |\n| `number` | `number-multi` |\n| `datetime` | Not supported in Affinity |\n| `location` | `location-multi` |\n| `dropdown` | `dropdown-multi` |\n| `ranked-dropdown` | Not supported in Affinity |\n| `person` | `person-multi` |\n| `company` | `company-multi` |\n| `filterable-text`\\* | `filterable-text-multi`\\* |\n\n\\*Note that `filterable-text` and `filterable-text-multi` are special types that operate similarly\nto `dropdown` and `dropdown-multi`. They are reserved for Affinity-populated Fields, and users\ncannot create Fields with these types.\n\nWhen an array-typed value has no data in it, the API will return `null` (rather than an empty\narray).\n\n### Retrieving Field Data\n\nTo retrieve field data on companies, persons, or opportunities, call GET `/v2/companies`, GET\n`/v2/persons`, or one of our GET `*/list-entries` endpoints. (Note that Opportunities only have\nlist-specific Fields, so all their field data will live on the `*/list-entries` endpoints.) For most\nof these endpoints, you will need to specify the Fields for which you want data returned via the\n`fieldIds` or `fieldTypes` parameter — Otherwise, entities will be returned without any field data\nattached.\n\nThe GET `/v2/companies` and `/v2/persons` endpoints can return entities with enriched, global, and\nrelationship intelligence field data attached, but do not support list-specific field data. **To get\ncomprehensive field data including list-specific field data on Companies and Persons, use the GET\n`*/list-entries` endpoints.**\n\n### Specifying Desired Fields (Field Selection)\n\nAs mentioned above, you will need to specify the Fields (either by ID or by Type) for which you want\ndata returned when using the following endpoints:\n\n- GET `/v2/companies`\n- GET `/v2/companies/{id}`\n- GET `/v2/persons`\n- GET `/v2/persons/{id}`\n- GET `/v2/lists/{listId}/list-entries`\n\nEach of these endpoints has a `fieldIds` parameter that accepts an array of Field IDs, and a\n`fieldTypes` parameter that accepts an array of Field Types. Use the GET `*/fields` endpoints to get\nField IDs, Field Types, and other Field-level metadata:\n\n- Call GET `/v2/companies/fields` and `/v2/persons/fields` to get a list of the enriched, global,\n and relationship intelligence (AKA non-list-specific) Fields that exist on Companies and Persons,\n respectively. These are the Fields whose values are available to pull via GET `/v2/companies`, GET\n `/v2/companies/{id}`, GET `/v2/persons`, and `/v2/persons/{id}`.\n- Call GET `/v2/lists/{listId}/fields` to get a list of the enriched, global, relationship\n intelligence, **and list-specific** Fields for a given List. These are the Fields whose values are\n available to pull via GET `/v2/lists/{listId}/list-entries`.\n\nThe following endpoints don't require field selection:\n\n- GET `/v2/lists/{listId}/saved-views/{viewId}/list-entries` — See below. This endpoint returns just\n the field data that has been pulled into the given Saved View via UI.\n- GET `/v2/companies/{id}/list-entries` and GET `/v2/persons/{id}/list-entries` — These endpoints\n return comprehensive field data for the given person or company in the context of each List Entry.\n\n### Saved Views\n\nA Saved View allows a user to configure the Fields they want to see in the UI for a given List, and\nset filters and sorts on the rows on that List. A List can have multiple Saved Views. In the context\nof this API, Saved Views can be useful for specifying the exact Fields for which data is needed. The\n`*/saved-views/{viewId}/list-entries` endpoint also respects the filters that have been set on the\ngiven Saved View in the Affinity web app. (It does not, however, respect sorts just yet.)\n\n### Partner Data Restrictions\n\nThis API supports pulling data from\n[Affinity Data](https://support.affinity.co/hc/en-us/articles/360058255052-Affinity-Data) fields and\nselect\n[Dealroom fields](https://support.affinity.co/hc/en-us/articles/6106558518797-Dealroom-co-data-in-Affinity#h_01G2N22SVH7TJR3DJV3NQDE9HQ).\nDue the agreements we have with some of our data partners, the API does not expose data from the\nfollowing sources:\n\n- Crunchbase, including Crunchbase UUID\n- Pitchbook\n- [Dealroom \"exclusive\" fields](https://support.affinity.co/hc/en-us/articles/6106558518797-Dealroom-co-data-in-Affinity#h_01G2N22YEAZJ5TC1X9ENKZFWF5)\n\n## Nested Associations\n\nSome GET endpoints return \"association\" data under `fields`. For example, the Persons GET endpoints\nreturn data about which Companies a Person is associated with in Affinity. The Opportunities GET\nendpoints return similar data about associated Companies and Persons. The List Entries GET endpoints\nalso return this data for Person and Opportunity List Entries.\n\nThe API truncates these nested arrays of Persons or Companies **at 100 entries**. For example, if an\nOpportunity is associated with 200 Persons in Affinity, only 100 of those Persons will be returned\nby the GET `/opportunities` or `/opportunities/{id}` endpoint.\n\n# User Guides\n\n## A Tour of Our GET Endpoints\n\n| Desired Data | Relevant Endpoints | Notes |\n| ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |\n| Company/Person/Opportunity rows from a List | Grab the List’s ID from its URL in the Affinity web app, then hit GET `/v2/lists/{listId}/list-entries` | Data returned will be restricted to the rows on the requested List |\n| Company/Person/Opportunity rows from a Saved View | In the Affinity web app, navigate to a List and [create a Saved View](https://support.affinity.co/hc/en-us/articles/115001508572-How-to-leverage-saved-views-within-a-list) with the desired field data and filters on it. Grab the List and Saved View IDs from the web app URL, then hit GET `/v2/lists/{listId}/saved-views/{viewId}/list-entries` | Data returned will be restricted to the rows and columns on the requested Saved View |\n| Full rolodex of Companies or Persons in Affinity | GET `/v2/companies`, GET `/v2/persons` | Data from list-specific Fields will not be returned |\n| All the rows for a given Company or Person across all Lists | GET `/v2/companies/{id}/list-entries`, GET `/v2/persons/{id}/list-entries` | |\n| Metadata on Fields, including Field IDs | GET `/v2/companies/fields`, GET `/v2/persons/fields`, GET `/v2/lists/{listId}/fields` | Metadata on list-specific Fields will only be returned by GET `/v2/lists/{listId}/fields` |\n| Metadata on Lists or Saved Views | GET `/v2/lists`, GET `/v2/lists/{listId}/saved-views` | |\n| Opportunity data | GET `/v2/opportunities` will only return Opportunity names and List IDs. For comprehensive Opportunity data, hit GET `/v2/lists/{listId}/list-entries` for an Opportunity List | |\n\nTip: The ID for a List, Saved View, Person, Company, or Opportunity can always be found in its\nAffinity web app URL.\n\n# Changelog\n\n## September 25th, 2025\n\n- Added the following endpoints in BETA:\n\n| Method | URL | Summary |\n| ------ | ----------------------------------- | ---------------------------- |\n| GET | `/v2/company-merges` | Get All Company Merge status |\n| POST | `/v2/company-merges` | Initiate Company Merge |\n| GET | `/v2/company-merges/{mergeId}` | Get Company Merge status |\n| GET | `/v2/tasks/company-merges` | Get All Company Merge Tasks |\n| GET | `/v2/tasks/company-merges/{taskId}` | Get Company Merge Task |\n\n## July 30th, 2025\n\n- Added the following endpoints in BETA:\n\n| Method | URL | Summary |\n| ------ | ---------------------------------- | --------------------------- |\n| GET | `/v2/person-merges` | Get All Person Merge status |\n| POST | `/v2/person-merges` | Initiate Person Merge |\n| GET | `/v2/person-merges/{mergeId}` | Get Person Merge status |\n| GET | `/v2/tasks/person-merges` | Get All Person Merge Tasks |\n| GET | `/v2/tasks/person-merges/{taskId}` | Get Person Merge Task |\n\n## May 14th, 2025\n\n- Renamed all path parameters named simply \"id\" to a more descriptive name (eg. \"personId\"). This\n will not have any effect on the API at runtime, but may impact code relying on the OpenAPI spec\n doing type generation.\n\n## April 9th, 2025\n\n- The following endpoints are no longer in BETA:\n\n| Method | URL | Summary |\n| ------ | ---------------------------------------------------------------- | ------------------------------------------------- |\n| GET | `/v2/lists/{listId}/list-entries/{listEntryId}` | Get a single List Entry on a List |\n| GET | `/v2/lists/{listId}/list-entries/{listEntryId}/fields` | Get field values on a single List Entry |\n| PATCH | `/v2/lists/{listId}/list-entries/{listEntryId}/fields` | Perform batch operations on a list entry's fields |\n| GET | `/v2/lists/{listId}/list-entries/{listEntryId}/fields/{fieldId}` | Get a single field value |\n| POST | `/v2/lists/{listId}/list-entries/{listEntryId}/fields/{fieldId}` | Update a single field value on a List Entry |\n\n## March 31st, 2025\n\n- The following beta endpoints now support updating association fields.\n\n| Method | URL | Summary |\n| ------ | ---------------------------------------------------------------- | ------------------------------------------------- |\n| PATCH | `/v2/lists/{listId}/list-entries/{listEntryId}/fields` | Perform batch operations on a list entry's fields |\n| POST | `/v2/lists/{listId}/list-entries/{listEntryId}/fields/{fieldId}` | Update a single field value on a List Entry |\n\n## February 28th, 2025\n\n- Added the following endpoints in BETA:\n\n| Method | URL | Summary |\n| ------ | ---------------------------------------------------------------- | ------------------------------------------------- |\n| GET | `/v2/lists/{listId}/list-entries/{listEntryId}` | Get a single List Entry on a List |\n| GET | `/v2/lists/{listId}/list-entries/{listEntryId}/fields` | Get field values on a single List Entry |\n| PATCH | `/v2/lists/{listId}/list-entries/{listEntryId}/fields` | Perform batch operations on a list entry's fields |\n| GET | `/v2/lists/{listId}/list-entries/{listEntryId}/fields/{fieldId}` | Get a single field value |\n| POST | `/v2/lists/{listId}/list-entries/{listEntryId}/fields/{fieldId}` | Update a single field value on a List Entry |\n\n## January 17th, 2025\n\n- Document `X-Ratelimit` headers in the schema for all endpoints.\n\n## January 15th, 2025\n\n- Add default responses to all endpoints to document all possible error codes that can be returned\n by the API.\n- Updated 400 error responses to correctly include the `bad-request` error code as a possible error.\n\n## December 3rd, 2024\n\n- Properly document `listId` property on `CompanyListEntry`, `PersonListEntry`, and\n `OpportunityListEntry` schemas.\n\n## September 25th, 2024\n\n- Upgrade schema to OpenAPI 3.1\n\n## August 5, 2024\n\n- Correct `opp` to `opportunity` to match documentation for the `List` `type` property.\n\n## July 24, 2024\n\n- More accurate documentation for response properties that are enums — Enums with `null` as a\n possible value will have it listed as one.\n\n## March 25, 2024\n\n- Added the ability to retrieve the date and other details of your firm's \"First Email\", \"Last\n Email\", \"First Event\", \"Last Event\", \"Next Event\", \"First Chat Message\", \"Last Chat Message\", and\n \"Last Contact\" with a given entity. Use these timestamps to add relationship context to your\n applications, and to identify founders and companies that need investors' attention.\n- Endpoints that previously required a `fieldIds` parameter to return field data, now accept either\n `fieldIds` or `fieldTypes`, and will return field data accordingly. See the\n [Specifying Desired Fields (Field Selection)](#section/Data-Model/Working-with-Field-Data) section\n of these docs for more information. The new `fieldTypes` parameter should make field data\n retrieval easier for users looking to pull data from many similar Fields at a time.\n\n## January 4, 2023\n\n- Most endpoints that return field data now require the user to use the `fieldIds` parameter to\n specify which Fields they want data for. Without `fieldIds` specified, these endpoints will return\n basic entity data but not field data.\n\n## December 12, 2023\n\n- Added the ability to retrieve metadata (e.g. ID, name, type, enrichment source, and data type) on\n Fields. See the [Retrieving Field Metadata](#section/Data-Model/Working-with-Field-Data) section\n of these docs for more information.\n",
"license": {
"name": "Proprietary",
"url": "https://www.affinity.co/legal/terms-of-use"
},
"termsOfService": "https://www.affinity.co/legal/terms-of-use",
"title": "Affinity API v2",
"x-logo": {
"url": "https://s3.us-west-2.amazonaws.com/assets.affinity.co/img/logos/full-color-svg.svg",
"altText": "Affinity logo"
}
},
"servers": [
{
"url": "https://api.affinity.co"
}
],
"security": [
{
"bearerAuth": []
}
],
"tags": [
{
"description": "Operations about auths",
"name": "auth"
},
{
"description": "Operations about calls",
"name": "calls"
},
{
"description": "Operations about chat messages",
"name": "chatMessages"
},
{
"description": "Operations about companies",
"name": "companies"
},
{
"description": "Operations about company merges",
"name": "companyMerges"
},
{
"description": "Operations about emails",
"name": "emails"
},
{
"description": "Operations about lists",
"name": "lists"
},
{
"description": "Operations about meetings",
"name": "meetings"
},
{
"description": "Operations about notes",
"name": "notes",
"x-stability-level": "beta"
},
{
"description": "Operations about opportunities",
"name": "opportunities"
},
{
"description": "Operations about person merges",
"name": "personMerges"
},
{
"description": "Operations about persons",
"name": "persons"
}
],
"paths": {
"/v2/auth/whoami": {
"get": {
"description": "Returns information about the authenticated user, their current organization, and API key permissions.\nUse this endpoint to verify your authentication and understand your available API access levels.",
"summary": "Get current user",
"operationId": "v2_auth_whoami__GET",
"tags": [
"auth"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WhoAmI"
}
}
},
"headers": {
"X-Ratelimit-Limit-User": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User"
},
"X-Ratelimit-Limit-User-Remaining": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User-Remaining"
},
"X-Ratelimit-Limit-User-Reset": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User-Reset"
},
"X-Ratelimit-Limit-Org": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org"
},
"X-Ratelimit-Limit-Org-Remaining": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org-Remaining"
},
"X-Ratelimit-Limit-Org-Reset": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org-Reset"
}
}
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/default"
}
}
}
},
"/v2/calls": {
"get": {
"description": "Paginate through all calls in Affinity. Returns basic information about the call interaction\nand its participants. Will only return calls that the current authenticated user has \npermission to see.\n\nYou can filter calls using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties.\n| **Property Name** | **Description** | **Type** | **Allowed Operators** | **Examples** |\n|-----------------------------|-----------------------------------------------------------------|------------|--------------------------------------|----------------------------------|\n| `id` | Unique identifier for Calls | `int64` | `=` | `id=1` |\n| `startTime` | Start time of when the Call was held | `datetime` | `>`, `<`, `>=`, `<=` | `sentAt>2025-01-01T01:00:00Z` |\n| `createdAt` | When the Call was created in Affinity | `datetime` | `>`, `<`, `>=`, `<=` | `createdAt<2025-01-01T01:00:00Z` |\n| `updatedAt` | When the Call was updated in Affinity | `datetime` | `>`, `<`, `>=`, `<=` | `updatedAt>=2025-01-01T01:00:00Z`|\n",
"summary": "Get metadata on all Calls",
"operationId": "v2_calls__GET",
"tags": [
"calls"
],
"parameters": [
{
"name": "cursor",
"description": "Cursor for the next or previous page",
"in": "query",
"schema": {
"type": "string",
"examples": [
"ICAgICAgYmVmb3JlOjo6Nw"
]
},
"example": "ICAgICAgYmVmb3JlOjo6Nw"
},
{
"name": "limit",
"description": "Number of items to include in the page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 100,
"default": 100,
"examples": [
100
]
},
"example": 100
},
{
"name": "filter",
"description": "Filter options",
"in": "query",
"schema": {
"type": "string"
},
"example": "id=1234"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/interactions.CallPaged"
}
}
},
"headers": {
"X-Ratelimit-Limit-User": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User"
},
"X-Ratelimit-Limit-User-Remaining": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User-Remaining"
},
"X-Ratelimit-Limit-User-Reset": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User-Reset"
},
"X-Ratelimit-Limit-Org": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org"
},
"X-Ratelimit-Limit-Org-Remaining": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org-Remaining"
},
"X-Ratelimit-Limit-Org-Reset": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org-Reset"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"default": {
"$ref": "#/components/responses/default"
}
}
}
},
"/v2/chat-messages": {
"get": {
"description": "Paginate through all chat messages in Affinity. Returns basic information about the chat message\ninteraction and its participants. Will only return chat messages that the current authenticated\nuser has permission to see.\n\nYou can filter chat messages using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties.\n| **Property Name** | **Description** | **Type** | **Allowed Operators** | **Examples** |\n|-----------------------------|-----------------------------------------------------------------|------------|--------------------------------------|----------------------------------|\n| `id` | Unique identifier for Chat Messages | `int64` | `=` | `id=1` |\n| `sentAt` | When the Chat Message was sent at | `datetime` | `>`, `<`, `>=`, `<=` | `sentAt>2025-01-01T01:00:00Z` |\n| `createdAt` | When the Chat Message was created in Affinity | `datetime` | `>`, `<`, `>=`, `<=` | `createdAt<2025-01-01T01:00:00Z` |\n| `updatedAt` | When the Chat Message was updated in Affinity | `datetime` | `>`, `<`, `>=`, `<=` | `updatedAt>=2025-01-01T01:00:00Z`|\n",
"summary": "Get metadata on all Chat Messages",
"operationId": "v2_chat-messages__GET",
"tags": [
"chatMessages"
],
"parameters": [
{
"name": "cursor",
"description": "Cursor for the next or previous page",
"in": "query",
"schema": {
"type": "string",
"examples": [
"ICAgICAgYmVmb3JlOjo6Nw"
]
},
"example": "ICAgICAgYmVmb3JlOjo6Nw"
},
{
"name": "limit",
"description": "Number of items to include in the page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 100,
"default": 100,
"examples": [
100
]
},
"example": 100
},
{
"name": "filter",
"description": "Filter options",
"in": "query",
"schema": {
"type": "string"
},
"example": "id=1234"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/interactions.ChatMessagePaged"
}
}
},
"headers": {
"X-Ratelimit-Limit-User": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User"
},
"X-Ratelimit-Limit-User-Remaining": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User-Remaining"
},
"X-Ratelimit-Limit-User-Reset": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User-Reset"
},
"X-Ratelimit-Limit-Org": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org"
},
"X-Ratelimit-Limit-Org-Remaining": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org-Remaining"
},
"X-Ratelimit-Limit-Org-Reset": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org-Reset"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"default": {
"$ref": "#/components/responses/default"
}
}
}
},
"/v2/companies": {
"get": {
"description": "Paginate through Companies in Affinity.\nReturns basic information and non-list-specific field data on each Company.\n\nTo retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter\nto specify the Fields for which you want data returned.\nThese Field IDs and Types can be found using the GET `/v2/companies/fields` endpoint.\nWhen no `fieldIds` or `fieldTypes` are provided, Companies will be returned without any field data attached.\nTo supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this:\n`?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`.\n\nRequires the \"Export All Organizations directory\" [permission](#section/Getting-Started/Permissions).",
"summary": "Get all Companies",
"operationId": "v2_companies__GET",
"tags": [
"companies"
],
"parameters": [
{
"name": "cursor",
"description": "Cursor for the next or previous page",
"in": "query",
"schema": {
"type": "string",
"examples": [
"ICAgICAgYmVmb3JlOjo6Nw"
]
},
"example": "ICAgICAgYmVmb3JlOjo6Nw"
},
{
"name": "limit",
"description": "Number of items to include in the page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 100,
"default": 100,
"examples": [
100
]
},
"example": 100
},
{
"name": "ids",
"description": "Company IDs",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64",
"minimum": 1,
"maximum": 9223372036854776000
}
},
"example": [
1,
2
]
},
{
"name": "fieldIds",
"description": "Field IDs for which to return field data",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"field-1"
]
]
},
"example": [
"field-1",
"field-2"
]
},
{
"name": "fieldTypes",
"description": "Field Types for which to return field data",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"enriched",
"global",
"relationship-intelligence"
]
}
},
"example": [
"enriched",
"global"
]
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanyPaged"
}
}
},
"headers": {
"X-Ratelimit-Limit-User": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User"
},
"X-Ratelimit-Limit-User-Remaining": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User-Remaining"
},
"X-Ratelimit-Limit-User-Reset": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User-Reset"
},
"X-Ratelimit-Limit-Org": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org"
},
"X-Ratelimit-Limit-Org-Remaining": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org-Remaining"
},
"X-Ratelimit-Limit-Org-Reset": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org-Reset"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"default": {
"$ref": "#/components/responses/default"
}
}
}
},
"/v2/companies/fields": {
"get": {
"description": "Returns metadata on non-list-specific Company Fields.\n\nUse the returned Field IDs to request field data from the GET `/v2/companies` and GET `/v2/companies/{id}` endpoints.",
"summary": "Get metadata on Company Fields",
"operationId": "v2_companies_fields__GET",
"tags": [
"companies"
],
"parameters": [
{
"name": "cursor",
"description": "Cursor for the next or previous page",
"in": "query",
"schema": {
"type": "string",
"examples": [
"ICAgICAgYmVmb3JlOjo6Nw"
]
},
"example": "ICAgICAgYmVmb3JlOjo6Nw"
},
{
"name": "limit",
"description": "Number of items to include in the page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 100,
"default": 100,
"examples": [
100
]
},
"example": 100
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FieldMetadataPaged"
}
}
},
"headers": {
"X-Ratelimit-Limit-User": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User"
},
"X-Ratelimit-Limit-User-Remaining": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User-Remaining"
},
"X-Ratelimit-Limit-User-Reset": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User-Reset"
},
"X-Ratelimit-Limit-Org": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org"
},
"X-Ratelimit-Limit-Org-Remaining": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org-Remaining"
},
"X-Ratelimit-Limit-Org-Reset": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org-Reset"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"default": {
"$ref": "#/components/responses/default"
}
}
}
},
"/v2/companies/{companyId}": {
"get": {
"description": "Returns basic information and non-list-specific field data on the requested Company.\n\nTo retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter\nto specify the Fields for which you want data returned.\nThese Field IDs and Types can be found using the GET `/v2/companies/fields` endpoint.\nWhen no `fieldIds` or `fieldTypes` are provided, Companies will be returned without any field data attached.\nTo supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this:\n`?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`.\n\nRequires the \"Export All Organizations directory\" [permission](#section/Getting-Started/Permissions).",
"summary": "Get a single Company",
"operationId": "v2_companies_companyId__GET",
"tags": [
"companies"
],
"parameters": [
{
"name": "companyId",
"description": "Company ID",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64",
"minimum": 1,
"maximum": 9223372036854776000
}
},
{
"name": "fieldIds",
"description": "Field IDs for which to return field data",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"field-1"
]
]
},
"example": [
"field-1",
"field-2"
]
},
{
"name": "fieldTypes",
"description": "Field Types for which to return field data",
"in": "query",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"enriched",
"global",
"relationship-intelligence"
]
}
},
"example": [
"enriched",
"global"
]
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Company"
}
}
},
"headers": {
"X-Ratelimit-Limit-User": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User"
},
"X-Ratelimit-Limit-User-Remaining": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User-Remaining"
},
"X-Ratelimit-Limit-User-Reset": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User-Reset"
},
"X-Ratelimit-Limit-Org": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org"
},
"X-Ratelimit-Limit-Org-Remaining": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org-Remaining"
},
"X-Ratelimit-Limit-Org-Reset": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org-Reset"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/default"
}
}
}
},
"/v2/companies/{companyId}/list-entries": {
"get": {
"description": "Paginate through the List Entries (AKA rows) for the given Company across all Lists.\nEach List Entry includes field data for the Company, including list-specific field data.\nEach List Entry also includes metadata about its creation, i.e., when it was added to the List and by whom.\n\nRequires the \"Export data from Lists\" [permission](#section/Getting-Started/Permissions).",
"summary": "Get a Company's List Entries",
"operationId": "v2_companies_companyId_list-entries__GET",
"tags": [
"companies"
],
"parameters": [
{
"name": "companyId",
"description": "Company ID",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64",
"minimum": 1,
"maximum": 9223372036854776000
}
},
{
"name": "cursor",
"description": "Cursor for the next or previous page",
"in": "query",
"schema": {
"type": "string",
"examples": [
"ICAgICAgYmVmb3JlOjo6Nw"
]
},
"example": "ICAgICAgYmVmb3JlOjo6Nw"
},
{
"name": "limit",
"description": "Number of items to include in the page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 100,
"default": 100,
"examples": [
100
]
},
"example": 100
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListEntryPaged"
}
}
},
"headers": {
"X-Ratelimit-Limit-User": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User"
},
"X-Ratelimit-Limit-User-Remaining": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User-Remaining"
},
"X-Ratelimit-Limit-User-Reset": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User-Reset"
},
"X-Ratelimit-Limit-Org": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org"
},
"X-Ratelimit-Limit-Org-Remaining": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org-Remaining"
},
"X-Ratelimit-Limit-Org-Reset": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org-Reset"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/default"
}
}
}
},
"/v2/companies/{companyId}/lists": {
"get": {
"description": "Paginate through all Lists where the given Company appears as an entry and that you have access to view.\nReturns basic List information for each List that contains this Company.",
"summary": "Get a Company's Lists",
"operationId": "v2_companies_companyId_lists__GET",
"tags": [
"companies"
],
"parameters": [
{
"name": "companyId",
"description": "Company ID",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64",
"minimum": 1,
"maximum": 9223372036854776000
}
},
{
"name": "cursor",
"description": "Cursor for the next or previous page",
"in": "query",
"schema": {
"type": "string",
"examples": [
"ICAgICAgYmVmb3JlOjo6Nw"
]
},
"example": "ICAgICAgYmVmb3JlOjo6Nw"
},
{
"name": "limit",
"description": "Number of items to include in the page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 100,
"default": 100,
"examples": [
100
]
},
"example": 100
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListPaged"
}
}
},
"headers": {
"X-Ratelimit-Limit-User": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User"
},
"X-Ratelimit-Limit-User-Remaining": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User-Remaining"
},
"X-Ratelimit-Limit-User-Reset": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User-Reset"
},
"X-Ratelimit-Limit-Org": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org"
},
"X-Ratelimit-Limit-Org-Remaining": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org-Remaining"
},
"X-Ratelimit-Limit-Org-Reset": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org-Reset"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/default"
}
}
}
},
"/v2/companies/{companyId}/notes": {
"get": {
"x-stability-level": "beta",
"description": "| ⚠️ This endpoint is currently in BETA |\n|--|\n\nReturns relevant notes for a given company which includes directly attached notes and notes attached to persons on this company.\n\nYou can filter notes using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties.\n| **Property Name** | **Description** | **Type** | **Allowed Operators** | **Examples** |\n|-----------------------------|-----------------------------------------------------------------|------------|--------------------------------------|---------------------------------|\n| `creator.id` | Filter notes by the creator of the note | `int32` | `=` | `creator.id=1` |\n| `createdAt` | Filter notes by when it was created | `datetime` | `>`, `<`, `>=`, `<=` | `createdAt<2025-02-04T10:48:24Z` |\n| `updatedAt` | Filter notes by when it was updated | `datetime` | `>`, `<`, `>=`, `<=` | `updatedAt>=2025-02-03T10:48:24Z`|\n",
"summary": "Get Notes for a Company",
"operationId": "v2_companies_companyId_notes__GET",
"tags": [
"companies"
],
"parameters": [
{
"name": "companyId",
"description": "Company's ID",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64",
"minimum": 1,
"maximum": 9223372036854776000
}
},
{
"name": "filter",
"description": "Filter options",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "cursor",
"description": "Cursor for the next or previous page",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"description": "Number of items to include in the page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 100,
"default": 20
}
},
{
"name": "totalCount",
"description": "Include total count of the collection in the pagination response",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/notes.NotesPaged"
}
}
},
"headers": {
"X-Ratelimit-Limit-User": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User"
},
"X-Ratelimit-Limit-User-Remaining": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User-Remaining"
},
"X-Ratelimit-Limit-User-Reset": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User-Reset"
},
"X-Ratelimit-Limit-Org": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org"
},
"X-Ratelimit-Limit-Org-Remaining": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org-Remaining"
},
"X-Ratelimit-Limit-Org-Reset": {
"$ref": "#/components/headers/X-Ratelimit-Limit-Org-Reset"
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
},
"default": {
"$ref": "#/components/responses/default"
}
}
}
},
"/v2/company-merges": {
"get": {
"description": "Retrieve paginated company merges for the organization.\n\n\nReturns all company merges initiated by users in your organization, including their current\nstatus, the companies involved, and merge details. You can filter company merges using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties:\n\n\n| Property | Type | Operators | Values | Examples |\n|----------|------|-----------|--------|----------|\n| `status` | `enum` | `=` | `in-progress`, `success`, `failed` | `status=failed` |\n| `taskId` | `string` | `=` | | `taskId=789e0123-e45b-67c8-d901-234567890123` |\n\n\nCompany merges are returned in reverse chronological order (most recent first).\n\n\nRequires the \"Manage duplicates\" [permission](#section/Getting-Started/Permissions) and\norganization admin role.\n",
"summary": "Get All Company Merges",
"operationId": "v2_company-merges__GET",
"tags": [
"companyMerges"
],
"parameters": [
{
"name": "cursor",
"description": "Cursor for the next or previous page",
"in": "query",
"schema": {
"type": "string"
},
"example": "ICAgICAgYmVmb3JlOjo6Nw"
},
{
"name": "limit",
"description": "Number of items to include in the page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 100,
"default": 100
},
"example": 100
},
{
"name": "filter",
"description": "Filter company merges using Affinity Filtering Language",
"in": "query",
"schema": {
"type": "string"
},
"example": "status=failed | taskId=789e0123-e45b-67c8-d901-234567890123"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompanyMergeStatePaged"
},
"examples": {
"merges-list": {
"$ref": "#/components/examples/merges-list"
}
}
}
},
"headers": {
"X-Ratelimit-Limit-User": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User"
},
"X-Ratelimit-Limit-User-Remaining": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User-Remaining"
},
"X-Ratelimit-Limit-User-Reset": {
"$ref": "#/components/headers/X-Ratelimit-Limit-User-Reset"
},
"X-Ratelimit-Limit-Org": {