You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**Documentation Version:** This copy is based on the official documentation as it appeared on **November 6, 2025 at 18:49:04** (Last updated: 11/06/2025 18:49:04). The official documentation may have been updated since this copy was created.
25
28
26
29
> **⚠️ Use at Your Own Risk**
@@ -346,6 +349,7 @@ Use the common use cases below to learn how Affinity API endpoints work.
346
349
>
347
350
> - The ID for a list, person, organization and opportunity can be found via the URL in the CRM. For a list `affinity.affinity.co/lists/[**list_id**]` and for a company profile `affinity.affinity.co/companies/[**company_id**]`
348
351
> - For large lists, use `page_size` and `page_token` parameters in the [`GET /lists/{list_id}/list-entries`](#list-entries) endpoint to improve performance
352
+
>
349
353
## Getting Field Values for All List Entries on a List
350
354
351
355
1. Query [`GET /lists`](#list) to get all lists and filter results by list name to get the appropriate list ID
@@ -883,7 +887,7 @@ curl -X POST “https://api.affinity.co/lists/450/list-entries” \
883
887
> **Note**
884
888
> Person and company lists can contain the same entity multiple times. Depending on your use case, before you add an entry, you may want to verify whether or not it exists in the list already.
885
889
886
-
#### The list entry resource that was just created through this request.
890
+
#### The list entry resource that was just created through this request
- List-specific field IDs are also returned from GET /list/{list_id}
987
+
982
988
#### Example Request
983
989
984
990
```bash
@@ -1061,7 +1067,7 @@ is_list_specific boolean false This determines whether the field object belongs
1061
1067
1062
1068
is_required boolean false This determines whether the field object is required.
1063
1069
1064
-
| This determine whether multiple value can be added to a single cells for the field. | is _list_ specific | This determine whether the fields objects belongs to a specific list. If set to true, you must pass in the appropriate list_id. |is _required|
1070
+
| This determine whether multiple value can be added to a single cells for the field. | is _list_ specific | This determine whether the fields objects belongs to a specific list. If set to true, you must pass in the appropriate list_id. |is_required|
1065
1071
#### Field Entity Type
1066
1072
1067
1073
#### Return
@@ -1106,6 +1112,7 @@ As an example for how a field value is created:
1106
1112
- A person X is added to this list. This action creates a list entry for this person.
1107
1113
- A value, 50,000, is entered in the cell corresponding to person X in the Deal Size column.
1108
1114
- 50,000 is now a field value tied to the list entry corresponding to person X, and the "Deal Size" field.
1115
+
1109
1116
> **Note**
1110
1117
> By default, Affinity creates some fields for you automatically. These include Location, Industry, Job Title, and more. See the Default Fields section for more information.
1111
1118
@@ -1502,11 +1509,12 @@ An array of all the field value changes associated with the supplied field and p
1502
1509
1503
1510
The person API allows you to manage all the contacts of your organization. These people include anyone your team has ever been in email communication or meeting with, and all the people that your team has added to Affinity.
1504
1511
1505
-
#### If you are looking to add or remove a person from a list, please check out the List Entries section of the API.
1512
+
#### If you are looking to add or remove a person from a list, please check out the List Entries section of the API
1506
1513
1507
1514
List Entries
1508
1515
1509
1516
- If you are looking to modify a person's field value (one of the cells on Affinity's spreadsheet), please check out the Field Value section of the API.
1517
+
1510
1518
#### The Person Resource
1511
1519
1512
1520
Each person resource is assigned a unique id and stores the name, type, and email addresses of the person. A person resource also has access to a Smart attribute called primary_email. The value of primary_email is automatically computed and represents the most likely current active email address for the person.
@@ -1776,7 +1784,7 @@ Update an existing person with person_id with the supplied parameters. Only attr
1776
1784
1777
1785
The person object that was just updated through this request.
1778
1786
1779
-
#### If you are looking to add an existing person to a list, please check the List Entries section of the API.
1787
+
#### If you are looking to add an existing person to a list, please check the List Entries section of the API
1780
1788
1781
1789
> **Note**
1782
1790
> If you are trying to add a new email or organization to a person, the existing values for email and organization_id must also be supplied as parameters.
@@ -1854,9 +1862,10 @@ An organization has many people associated with it - these are your team's point
1854
1862
1855
1863
To make the data quality as good as possible, we have our own proprietary database of organizations that we have developed through third-party partnerships and web scraping. We use this database to enrich organization data automatically.
1856
1864
1857
-
#### If you are looking to add or remove an organization from a list, please check out the List Entries section of the API.
1865
+
#### If you are looking to add or remove an organization from a list, please check out the List Entries section of the API
1858
1866
1859
1867
- If you are looking to modify a field value (one of the cells on Affinity' spreadsheet), please check out the Field Value section of the API.
1868
+
1860
1869
#### The Organization Resource
1861
1870
1862
1871
Each organization object has a unique id. It also has a name, domain (the website of the organization), and people associated with it. The domain is an important attribute from an automation perspective, as it's used to automatically associate person objects with organizations.
@@ -2100,7 +2109,7 @@ Create a new organization with the supplied parameters.
2100
2109
2101
2110
The organization resource that was just created by a successful request.
2102
2111
2103
-
#### If you are looking to add an existing organization to a list, please check the List Entries section of the API.
2112
+
#### If you are looking to add an existing organization to a list, please check the List Entries section of the API
2104
2113
2105
2114
#### Update an Organization
2106
2115
@@ -2129,7 +2138,7 @@ Update an existing organization with organization_id with the supplied parameter
2129
2138
2130
2139
The organization resource that was just updated through a successful request.
2131
2140
2132
-
#### If you are looking to add an existing organization to a list, please check the List Entries section of the API.
2141
+
#### If you are looking to add an existing organization to a list, please check the List Entries section of the API
2133
2142
2134
2143
> **Note**
2135
2144
> If you are trying to add a person to an organization, the existing values for person_id must also be passed into the endpoint.
Return all interactions that meet the query parameters.
2476
2485
2477
-
#### type integer true The type of interaction to be retrieved.
2486
+
#### type integer true The type of interaction to be retrieved
2478
2487
2479
2488
logging_type integer false The logging type of interaction to be retrieved.
2480
2489
@@ -2506,15 +2515,16 @@ page_size number false How many results to return per page. (Default is the maxi
2506
2515
| end_time | string | A string (formatted according to ISO 8601) representing the end of the time range for the interaction to be retrieved. Must be after start_time. Date range must not exceed one year. | page_size | number | How many results to return per page. (Default is the maximum value of 100.) |
2507
2516
page_token string false The next_page_token from the previous response required to retrieve the next page of result.
2508
2517
2509
-
#### One person_id, organization_id or opportunity_id must be specified per request.
2518
+
#### One person_id, organization_id or opportunity_id must be specified per request
2510
2519
2511
2520
- Only one type of interaction can be specified per request.
2512
2521
- An error will be returned if an internal person is used in the person_id parameter.
2522
+
2513
2523
#### Return
2514
2524
2515
2525
An array of all the interactions filtered by query parameters. next_page_token includes a token to be sent along with the next request as the page_token parameter to fetch the next page of results.
2516
2526
2517
-
#### Interaction in the API response may not be visible on a CRM profile page if they have the exact same timestamp as another interaction.
2527
+
#### Interaction in the API response may not be visible on a CRM profile page if they have the exact same timestamp as another interaction
2518
2528
2519
2529
#### Get a Specific Interaction
2520
2530
@@ -2671,7 +2681,7 @@ ISO 8601
2671
2681
2672
2682
The interaction created through this request.
2673
2683
2674
-
#### When creating an interaction using the API, the users corresponding to the API token will be the creator by default.
2684
+
#### When creating an interaction using the API, the users corresponding to the API token will be the creator by default
2675
2685
2676
2686
#### Update an Interaction
2677
2687
@@ -4045,6 +4055,7 @@ The rate limit resource, a JSON body of data including limit, calls remaining, s
4045
4055
#### 2025-11-05
4046
4056
4047
4057
- Added support for bearer authentication
4058
+
4048
4059
#### 2024-07-17
4049
4060
4050
4061
- At least one associated person, company, opportunity, or parent note must be specified when creating a note.
@@ -4055,20 +4066,23 @@ creating a note
4055
4066
- /interaction now restricts the duration between start_time and end_time to a maximum of one year
4056
4067
- /interaction now ensures that the provided start_time is before the provided end_time
4057
4068
- /interaction now has a maximum page_size of 100
4069
+
4058
4070
#### 2023-08-07
4059
4071
4060
4072
- Added associated_person_id, interaction_person_id, interaction_id, and interaction_type to the note resource. The person_id, associated_person_id, and interaction_person_id properties on a note have been updated. See [the note resource](#the-note-resource) for more details.
4061
4073
4062
4074
#### 2023-07-27
4063
4075
4064
4076
- Datetime values in webhook bodies and API responses are ISO 8601-formatted date strings. For example: "2023-06-21T16:00:28.315-07:00".
4077
+
4065
4078
#### 2023-07-17
4066
4079
4067
4080
- Added information about notes with type 1. See [note with type 1](#the-note-resource) for more details.
4068
4081
4069
4082
#### 2023-07-03
4070
4083
4071
4084
- Updated API access information for Professional tier customers.
4085
+
4072
4086
#### 2023-06-13
4073
4087
4074
4088
- The created_at parameter on the POST endpoint for notes no longer accepts timestamps in the future. See [POST /note](#post-note) for more details.
@@ -4103,28 +4117,36 @@ create a note within a thread
4103
4117
#### 2023-02-10
4104
4118
4105
4119
- Added Rate Limit Header section to the Rate Limit documentation.
4120
+
4106
4121
#### 2023-02-08
4107
4122
4108
4123
- Added created_at and updated_at timestamp to Field Value.
4109
4124
- Added an updated_at timestamp to Note.
4125
+
4110
4126
#### 2023-02-07
4111
4127
4112
4128
- Added the ability to retrieve Current Organization columns data on Person.
4129
+
4113
4130
#### 2022-09-06
4114
4131
4115
4132
- Added Rate Limit endpoint and documentation. Moved from a daily to a per minute per user limit. Monthly per account limit remain the same.
4133
+
4116
4134
#### 2022-09-02
4117
4135
4118
4136
- Added entity_type and exclude_dropdown_option documentation to Field.
4137
+
4119
4138
#### 2022-05-05
4120
4139
4121
4140
- Added enrichment_source documentation to Field.
4141
+
4122
4142
#### 2022-04-11
4123
4143
4124
4144
- Added Partner With Us section.
4145
+
4125
4146
#### 2022-03-21
4126
4147
4127
4148
- Added opportunity_id fields to person and organization response.
4149
+
4128
4150
#### 2022-02-23
4129
4151
4130
4152
- Added Interaction API documentation.
@@ -4151,6 +4173,7 @@ Reminder webhook
4151
4173
4152
4174
- Added organization.merged event to Webhook.
4153
4175
- Added mentioned_person_id and is_meeting fields to Note.
4176
+
4154
4177
#### 2021-11-22
4155
4178
4156
4179
- Added link out to Help Center for webhook response
@@ -4164,10 +4187,12 @@ GET field value change
4164
4187
#### 2021-10-15
4165
4188
4166
4189
- Minor content update
4190
+
4167
4191
#### 2021-10-04
4168
4192
4169
4193
- Update to Example Response.
4170
4194
- Responsive tweak.
4195
+
4171
4196
#### 2021-09-07
4172
4197
4173
4198
- Revamped API documentation Added Common Use Case section. Added Rate Limit section. Update to PUT and POST cURL example.
@@ -4176,12 +4201,15 @@ Common Use Case
4176
4201
4177
4202
- Added Rate Limit section.
4178
4203
- Update to PUT and POST cURL example.
4204
+
4179
4205
#### 2021-08-18
4180
4206
4181
4207
- Fixed typo in the API doc where entity_id and creator_id wa in path paramater when they should be inside the payload parameter for Create a New List Entry.
0 commit comments