> ## Documentation Index > Fetch the complete documentation index at: https://developer.affinity.co/llms.txt > Use this file to discover all available pages before exploring further. # Get Introduction Paths > | ⚠️ This endpoint is currently in BETA | |--| Returns ranked introduction paths from an internal person to a target, strongest first. Each path is composed of one or two edges: a single edge is a direct relationship between an internal person and the target. Two edges represent an internal person reaching the target through a bridge person, where `edges[0].to` and `edges[1].from` are the same person. The target is specified with the required `filter` parameter, using exactly one of the `target.id` or `target.currentCompany.id` filter terms. `target.id` targets a specific person, whether an existing contact or a person already identified at a target company. `target.currentCompany.id` targets any person at that company; returned paths may lead to different people, and each path's target is `edges[edges.length - 1].to`, exposed as `target` for filtering. Only relative ordering is exposed. `rank` reflects each path's position among all paths to the target, computed before paging is applied, so a path keeps the same rank on whichever page it appears; it is not stable across requests as underlying data changes. `tier` is a qualitative `strong`, `moderate`, or `weak` band for the path as a whole. Neither `rank` nor `tier` exposes the underlying interaction score or inferred connection confidence used to compute them. Each edge also carries its own `tier`, independent of the path-level `tier`, so a client can distinguish which specific hop is strong or weak within a two-edge path. Results are always ordered by rank, strongest first. `orderBy` is not supported. ## Filters The `filter` parameter is required and must contain exactly one of the following filter terms. Providing both, or neither, returns a `400`. | **Property Name** | **Type** | **Description** | **Allowed Operators** | **Examples** | |---|---|---|---|---| | `target.id` | `integer` | The target person's id. | `=` | `target.id = 123` | | `target.currentCompany.id` | `integer` | The id of the company the target person currently works at; ranks paths to any person at that company. | `=` | `target.currentCompany.id = 456` | ## Path types An edge's `connectionInfo` carries whichever signals connect its two people, and more than one can be present on the same edge. `interactionScore` reflects interaction history, `lastInteraction` the most recent email, meeting, call, or chat message behind it, `linkedIn` a LinkedIn connection, and `sharedWorkHistory` or `investmentHistory` an inferred connection through shared employment or an investor-portfolio relationship. Each is `null` or empty when that signal is absent. ## OpenAPI ````yaml /schema/temp/publish.yml get /v2/intro-paths openapi: 3.1.1 info: version: 0.0.1 x-affinity-api-version: '2026-09-17' contact: email: support@affinity.co name: Affinity Support url: https://support.affinity.co description: > # Introduction Welcome to Affinity API v2! This API provides a RESTful interface for building internal apps, automated workflows, 3rd party integrations, and for connecting Affinity to the rest of your tech stack. The legacy Affinity v1 API can be found at [api-docs.affinity.co](https://api-docs.affinity.co/). The v2 API is not at feature parity with v1 - we are continuing to develop new v2 APIs to support all v1 functionality over time. **The Affinity APIs are only available on select license types.** See [this Help Center article](https://support.affinity.co/hc/en-us/articles/5563700459533-Getting-started-with-the-Affinity-API-FAQs) or contact your Customer Success Manager for more information. # Getting Started All Affinity API endpoints use the base URL `https://api.affinity.co`. All v2 endpoint paths start with `/v2`. Requests must be sent over HTTPS. The first few sections of these docs cover general information on the API. Each subsequent section covers a set of API endpoints. Each endpoint is documented with its accepted request parameters, expected response shapes, and a sample request and response. The shape of a given response can vary depending on what "type" of object or data is being returned. When this is the case, the response documentation will include a dropdown that can be used to select the "type" for which to display the response shape. ## Authentication Affinity API v2 uses API keys and **bearer authentication**. To generate an API key, navigate to the Manage Apps Page in your Affinity Settings. You will need the "Generate an API key" role-based permission controlled by your Affinity admin. See [this Help Center article](https://support.affinity.co/hc/en-us/articles/360032633992-How-to-obtain-your-API-Key) for full instructions on API key generation, and [this article](https://support.affinity.co/hc/en-us/articles/360015976732-Account-Level-Permissions) for more information on role-based permissions in Affinity. Provide your API key as your bearer authentication token to start making calls to Affinity API v2. You can create multiple API keys and provide a name and description for each. Your API key is able to read data and perform actions in Affinity on your behalf, so keep it safe as you would a password. To further secure an API key, you can define an IP Allowlist to limit which IP addresses or ranges can make API calls using that key. ## Permissions ### Overall Requirements You must have the "Generate an API key" permission to be able to work with the Affinity API. Most users in Affinity have this by default — Contact your Affinity admin if you are not able to generate an API key, and see [this article](https://support.affinity.co/hc/en-us/articles/360015976732-Account-Level-Permissions) for more information on role-based permissions in Affinity. ### Resource-Level Permissions The Affinity API respects sharing permissions that are set in-product. For example, if a given user does not have access to a list, note, or interaction in-product, they will not be able to see or modify it via API. ### Endpoint-Level Permissions Many API endpoints require endpoint-specific permissions in-product. These permissions, along with the "Generate an API key" permission, are managed by your Affinity admin in the Settings page. In the description of each endpoint you will see the required permissions needed. ## Rate Limits The Affinity API sets a limit on the number of calls that a user can make per minute, and that all the users on an account can make per month. It also sets a reasonable limit on the number of concurrent requests it will support from an account at one time. Requests to **both** Affinity API versions will count toward the one pool of requests allowed for a user or account. Once a per-minute, monthly, or concurrent rate limit is hit, subsequent requests will return an error code of 429. **We highly recommend designing your application to handle 429 errors.** ### Per-Minute Limits (User-Level) To help protect our systems, API requests will be halted at **900 per user, per minute.** We may also lower this limit on a temporary basis to manage API availability. ### Concurrent Request Limits (Account-Level) To protect our systems and manage availability across customers, we set a reasonable limit on concurrent requests at the account level. Customers should not expect to hit this limit unless they are hitting the API with heavy operations from many concurrent threads at once. ### Monthly Plan Tier Limits (Account-Level) The overall number of requests you can make per month will depend on your account's plan tier. **This monthly account-level limit resets at the end of each calendar month.** Current rate limits by plan tier are: | Plan Tier | Calls Per Month | | ---------- | --------------- | | Essentials | None | | Scale | 100k | | Advanced | 100k | | Enterprise | Unlimited\* | \*Per-Minute and Concurrent Request Limits still apply. ### Rate Limit Headers All API calls will return the following response headers with information about per-minute and monthly limits: | Header | Description | | -------------------------------- | ------------------------------------------------------- | | x-ratelimit-limit-user | Number of requests allowed per minute for the user | | x-ratelimit-limit-user-remaining | Number of requests remaining for the user | | x-ratelimit-limit-user-reset | Time in seconds before the limit resets for the user | | x-ratelimit-limit-org | Number of requests allowed per month for the account | | x-ratelimit-limit-org-remaining | Number of requests remaining for the account | | x-ratelimit-limit-org-reset | Time in seconds before the limit resets for the account | The `x-ratelimit-limit-org*` headers are absent when no monthly quota applies to the caller, for example a plan with no monthly cap. ## Pagination When an endpoint is expected to return multiple results, we break the results into pages to make them easier to handle. To cycle forward through multiple pages of data, look for the `nextUrl` property in the `pagination` portion of an API response, and use it for your next request. See endpoint documentation for more information. ## Filtering Some endpoints support a filtering language for flexible and powerful queries. This allows for the creation of complex filter expressions using different operators and boolean logic in a single filter string. The description of each endpoint will contain information on which filter properties and operators are supported. ### Rules - Spaces are insignificant by default. For example, `field = hello` and `field=hello` are both valid. - If spaces are significant, they need to be inside double quotes, for example, `field = "hello world"` - Special characters need to be escaped with a backslash: `field="hello\" world"`
Full list of special characters: `\ * ~ ! & = > < $ ^ | " ' ( ) ] [ /` - Use `&` and `|` for boolean operations: `foo = 1 | baz = 2 & bar = 3`. Boolean Algebra Logic is assumed: `&` takes precedence over `|`. When evaluating the condition above, `baz = 2 & bar = 3` will be computed first, and then the result will be `or`'ed with `foo=1` - Parentheses can be used to specify the order of operations. In the example above, to make sure that `foo = 1 | baz = 2` is evaluated first, parentheses must be placed `(foo = 1 | baz = 2) & bar = 3` ### Grammar #### Simple Types | Definition | Property Type | Operator | Example | | ------------------------ | ---------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------- | | exact match | all | = | content = “hello world”
content=hello | | starts with | text | =^ | content =^ he | | ends with | text | =$ | content =$ llo | | contains | text | =~ | content =~ lo | | greater than | int32, int64, float, double, decimal, date, datetime | \> | count > 1 | | greater than or equal to | int32, int64, float, double, decimal, date, datetime | \>= | content >= 1 | | less than | int32, int64, float, double, decimal, date, datetime | \< | count < 1 | | less than or equal to | int32, int64, float, double, decimal, date, datetime | \<= | content <= 1 | | is NULL | all | != \* | content != \* | | is not NULL | all | =\* | content = \* | | is empty | text | ="" | content = "" | | negation | all | ! | content != ”hello world”
!(content = ”hello world”)
!(content =^ “hello world”) | #### Collections (all types) | Definition | Operator | Example | | ------------------------- | -------- | ------------------------------------ | | exact match with ordering | = | industries = [Healthcare,Fintech] | | contains all | =~ | industries =~ [Healthcare,Fintech] | | empty | =[] | industries =[] | | negation | ! | !(industries = [Healthcare,Fintech]) | ## Error Codes Here is a list of the error codes the API will return if something goes wrong (see endpoint documentation for endpoint-specific errors): | Error Code | Meaning | | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 400 | Bad Request — See endpoint documentation for more information. | | 401 | Unauthorized — Your API key is invalid. | | 403 | Forbidden — Insufficient rights to a resource. | | 404 | Not Found — Requested resource does not exist. See endpoint documentation for more information. | | 405 | Method Not Allowed — The method being used is not supported for this resource. | | 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. | | 429 | Too Many Requests — You have exceeded the rate limit. | | 500 | Internal Server Error — We had a problem with our server. Try again later. | | 503 | Service Unavailable — This shouldn't generally happen. Contact us if you encounter this error. | ## Versioning Versioning in Affinity’s API ensures that your integrations remain stable as updates are introduced. Within API v2, minor versions identify releases that may include breaking or behavior-changing modifications, and they allow you to target the exact API behavior your integration depends on. When you create an API key in the Settings page, you'll select a **Default API Version** for that key. The current available versions are: - **2024-01-01** - The current stable version of the v2 API As new minor versions of Affinity API v2 are introduced, they will appear in this list. You’ll be able to create new keys using those versions or update an existing key to use a newer version. ## Beta Endpoints You’ll notice in our documentation that some endpoints will be marked as BETA. These endpoints are newly released and will eventually progress to General Availability (GA). While an endpoint is in BETA there are some important things to consider: - The development of this endpoint may still be in progress. This means new capabilities, request parameters, response data, and performance improvements may be adjusted over time. Because of this, breaking changes may occur to the endpoint WITHOUT notice or versioning. - As this is an early release, bug fixes may still be ongoing as well, and we encourage you to report bugs to [support@affinity.co](mailto:support@affinity.co). - In addition, your feedback around the capabilities of the endpoint are highly valuable, please reach out to your CSM to provide feedback to our product team. # Data Model ## The Basics The three top-level objects in Affinity are **Persons, Companies, and Opportunities**. (Note: Companies are called Organizations in the Affinity web app.) These have profiles in the Affinity web app and can be added to Lists. A **List** is a spreadsheet-like collection of rows tied to Persons, Companies, or Opportunities. - Each row on a List is a **List Entry**. A List Entry contains data and metadata about a given Person, Company, or Opportunity in the context of a List. This includes list-specific field data, and information about who added the row to the List and when. - A given entity can be added to a List more than once. These List Entries can have different List-specific field data and List Entry-level metadata. Each column on a List maps to a **Field**. Fields show up within Affinity profile pages, extensions, and integrations. There are two categories of fields: - **List-specific fields** are scoped to a single List. In the API, their data can only be accessed through the List Entry resource. - **Global fields** belong to entities directly. These can include default fields, fields created by you, enrichment fields, or relationship intelligence fields. They can be accessed through the Person/Company/Opportunity resources and the List Entry resource. ## Working with Field Data ### Field Types and IDs Here is a deeper look at the types of Fields in Affinity, differentiated by the scope and source of their data: | Field Type | Description | Example Fields | Field ID Pattern | | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | `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`. | | `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` | | `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` | | `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` | ### Field Value Types Field data can take a variety of shapes. These value types are described in the Affinity Help Center [creating columns in lists](https://support.affinity.co/hc/en-us/articles/115001608232-How-to-create-a-new-column-in-a-list). Here is a list of the same value types, as represented in this API. Notice how array types end with `-multi`: | Single Type | Array Type | | ------------------- | ------------------------- | | `text` | Not supported in Affinity | | `number` | `number-multi` | | `datetime` | Not supported in Affinity | | `location` | `location-multi` | | `dropdown` | `dropdown-multi` | | `ranked-dropdown` | Not supported in Affinity | | `person` | `person-multi` | | `company` | `company-multi` | | `filterable-text`\* | `filterable-text-multi`\* | \*Note that `filterable-text` and `filterable-text-multi` are special types that operate similarly to `dropdown` and `dropdown-multi`. They are reserved for Affinity-populated Fields, and users cannot create Fields with these types. When an array-typed value has no data in it, the API will return `null` (rather than an empty array). ### Retrieving Field Data To retrieve field data on companies, persons, or opportunities, call GET `/v2/companies`, GET `/v2/persons`, or one of our GET `*/list-entries` endpoints. (Note that Opportunities only have list-specific Fields, so all their field data will live on the `*/list-entries` endpoints.) For most of these endpoints, you will need to specify the Fields for which you want data returned via the `fieldIds` or `fieldTypes` parameter — Otherwise, entities will be returned without any field data attached. The GET `/v2/companies` and `/v2/persons` endpoints can return entities with enriched, global, and relationship intelligence field data attached, but do not support list-specific field data. **To get comprehensive field data including list-specific field data on Companies and Persons, use the GET `*/list-entries` endpoints.** ### Specifying Desired Fields (Field Selection) As mentioned above, you will need to specify the Fields (either by ID or by Type) for which you want data returned when using the following endpoints: - GET `/v2/companies` - GET `/v2/companies/{id}` - GET `/v2/persons` - GET `/v2/persons/{id}` - GET `/v2/lists/{listId}/list-entries` Each of these endpoints has a `fieldIds` parameter that accepts an array of Field IDs, and a `fieldTypes` parameter that accepts an array of Field Types. Use the GET `*/fields` endpoints to get Field IDs, Field Types, and other Field-level metadata: - Call GET `/v2/companies/fields` and `/v2/persons/fields` to get a list of the enriched, global, and relationship intelligence (AKA non-list-specific) Fields that exist on Companies and Persons, respectively. These are the Fields whose values are available to pull via GET `/v2/companies`, GET `/v2/companies/{id}`, GET `/v2/persons`, and `/v2/persons/{id}`. - Call GET `/v2/lists/{listId}/fields` to get a list of the enriched, global, relationship intelligence, **and list-specific** Fields for a given List. These are the Fields whose values are available to pull via GET `/v2/lists/{listId}/list-entries`. The following endpoints don't require field selection: - GET `/v2/lists/{listId}/saved-views/{viewId}/list-entries` — See below. This endpoint returns just the field data that has been pulled into the given Saved View via UI. - GET `/v2/companies/{id}/list-entries` and GET `/v2/persons/{id}/list-entries` — These endpoints return comprehensive field data for the given person or company in the context of each List Entry. ### Saved Views A Saved View allows a user to configure the Fields they want to see in the UI for a given List, and set filters and sorts on the rows on that List. A List can have multiple Saved Views. In the context of this API, Saved Views can be useful for specifying the exact Fields for which data is needed. The `*/saved-views/{viewId}/list-entries` endpoint also respects the filters that have been set on the given Saved View in the Affinity web app. (It does not, however, respect sorts just yet.) ### Partner Data Restrictions This API supports pulling data from [Affinity Data](https://support.affinity.co/hc/en-us/articles/360058255052-Affinity-Data) fields and select [Dealroom fields](https://support.affinity.co/hc/en-us/articles/6106558518797-Dealroom-co-data-in-Affinity#h_01G2N22SVH7TJR3DJV3NQDE9HQ). Due the agreements we have with some of our data partners, the API does not expose data from the following sources: - Crunchbase, including Crunchbase UUID - Pitchbook - [Dealroom "exclusive" fields](https://support.affinity.co/hc/en-us/articles/6106558518797-Dealroom-co-data-in-Affinity#h_01G2N22YEAZJ5TC1X9ENKZFWF5) ## Nested Associations Some GET endpoints return "association" data under `fields`. For example, the Persons GET endpoints return data about which Companies a Person is associated with in Affinity. The Opportunities GET endpoints return similar data about associated Companies and Persons. The List Entries GET endpoints also return this data for Person and Opportunity List Entries. The API truncates these nested arrays of Persons or Companies **at 100 entries**. For example, if an Opportunity is associated with 200 Persons in Affinity, only 100 of those Persons will be returned by the GET `/opportunities` or `/opportunities/{id}` endpoint. # Changelog ## January 30th, 2026 - The following endpoints are no longer in BETA: | Method | URL | Summary | | ------ | ------------------------------------------- | ---------------------------------------------- | | GET | `/v2/notes` | Get all Notes | | GET | `/v2/notes/{noteId}` | Get a Note with a given id | | GET | `/v2/notes/{noteId}/attached-companies` | Get directly attached companies for a Note | | GET | `/v2/notes/{noteId}/attached-opportunities` | Get directly attached opportunities for a Note | | GET | `/v2/notes/{noteId}/attached-persons` | Get directly attached persons for a Note | | GET | `/v2/notes/{noteId}/replies` | Get reply notes for a given Note | ## January 26th, 2026 - Added the following endpoints in BETA: | Method | URL | Summary | | ------ | ------------------------------------------ | ------------------------------------ | | GET | `/v2/transcripts` | Get All Transcripts | | GET | `/v2/transcripts/{transcriptId}` | Get Transcript | | GET | `/v2/transcripts/{transcriptId}/fragments` | Get Fragments on a single Transcript | ## January 14th, 2026 - Rate limit response headers have been updated to use lowercase formatting. This change affects all API endpoints. The new lowercase headers are: | Header | Description | | -------------------------------- | ------------------------------------------------------- | | x-ratelimit-limit-user | Number of requests allowed per minute for the user | | x-ratelimit-limit-user-remaining | Number of requests remaining for the user | | x-ratelimit-limit-user-reset | Time in seconds before the limit resets for the user | | x-ratelimit-limit-org | Number of requests allowed per month for the account | | x-ratelimit-limit-org-remaining | Number of requests remaining for the account | | x-ratelimit-limit-org-reset | Time in seconds before the limit resets for the account | ## January 1st, 2026 - API Change: Handling timestamps for date fields. Affinity is standardizing how dates are represented across the platform to ensure consistency between the application and the API. Starting January 1st, 2026, the API will change how it handles timestamps for date fields. Today, timestamps sent to date fields over the API are not visible to users in any CRM interface. After this change, the API will ignore any time information included in requests, storing and returning values at midnight Pacific Time (PT) on the submitted date. **Example:** - API request includes: `2024-04-01T15:30:00Z` - Affinity will store and return: `2024-04-01T07:00:00.000Z` (equivalent to midnight PT) Any existing date field values that currently include timestamps will also be updated to reflect midnight PT on their stored date. No action is required unless your integration depends on time data within date fields. ## September 25th, 2025 - Added the following endpoints in BETA: | Method | URL | Summary | | ------ | ----------------------------------- | ---------------------------- | | GET | `/v2/company-merges` | Get All Company Merge status | | POST | `/v2/company-merges` | Initiate Company Merge | | GET | `/v2/company-merges/{mergeId}` | Get Company Merge status | | GET | `/v2/tasks/company-merges` | Get All Company Merge Tasks | | GET | `/v2/tasks/company-merges/{taskId}` | Get Company Merge Task | ## July 30th, 2025 - Added the following endpoints in BETA: | Method | URL | Summary | | ------ | ------------------------------------------- | ---------------------------------------------- | | GET | `/v2/person-merges` | Get All Person Merge status | | POST | `/v2/person-merges` | Initiate Person Merge | | GET | `/v2/person-merges/{mergeId}` | Get Person Merge status | | GET | `/v2/tasks/person-merges` | Get All Person Merge Tasks | | GET | `/v2/tasks/person-merges/{taskId}` | Get Person Merge Task | | GET | `/v2/notes` | Get all Notes | | GET | `/v2/notes/{noteId}` | Get a Note with a given id | | GET | `/v2/notes/{noteId}/attached-companies` | Get directly attached companies for a Note | | GET | `/v2/notes/{noteId}/attached-opportunities` | Get directly attached opportunities for a Note | | GET | `/v2/notes/{noteId}/attached-persons` | Get directly attached persons for a Note | | GET | `/v2/notes/{noteId}/replies` | Get reply notes for a given Note | ## May 14th, 2025 - Renamed all path parameters named simply "id" to a more descriptive name (eg. "personId"). This will not have any effect on the API at runtime, but may impact code relying on the OpenAPI spec doing type generation. ## April 9th, 2025 - The following endpoints are no longer in BETA: | Method | URL | Summary | | ------ | ---------------------------------------------------------------- | ------------------------------------------------- | | GET | `/v2/lists/{listId}/list-entries/{listEntryId}` | Get a single List Entry on a List | | GET | `/v2/lists/{listId}/list-entries/{listEntryId}/fields` | Get field values on a single List Entry | | PATCH | `/v2/lists/{listId}/list-entries/{listEntryId}/fields` | Perform batch operations on a list entry's fields | | GET | `/v2/lists/{listId}/list-entries/{listEntryId}/fields/{fieldId}` | Get a single field value | | POST | `/v2/lists/{listId}/list-entries/{listEntryId}/fields/{fieldId}` | Update a single field value on a List Entry | ## March 31st, 2025 - The following beta endpoints now support updating association fields. | Method | URL | Summary | | ------ | ---------------------------------------------------------------- | ------------------------------------------------- | | PATCH | `/v2/lists/{listId}/list-entries/{listEntryId}/fields` | Perform batch operations on a list entry's fields | | POST | `/v2/lists/{listId}/list-entries/{listEntryId}/fields/{fieldId}` | Update a single field value on a List Entry | ## February 28th, 2025 - Added the following endpoints in BETA: | Method | URL | Summary | | ------ | ---------------------------------------------------------------- | ------------------------------------------------- | | GET | `/v2/lists/{listId}/list-entries/{listEntryId}` | Get a single List Entry on a List | | GET | `/v2/lists/{listId}/list-entries/{listEntryId}/fields` | Get field values on a single List Entry | | PATCH | `/v2/lists/{listId}/list-entries/{listEntryId}/fields` | Perform batch operations on a list entry's fields | | GET | `/v2/lists/{listId}/list-entries/{listEntryId}/fields/{fieldId}` | Get a single field value | | POST | `/v2/lists/{listId}/list-entries/{listEntryId}/fields/{fieldId}` | Update a single field value on a List Entry | ## January 17th, 2025 - Document `X-Ratelimit` headers in the schema for all endpoints. ## January 15th, 2025 - Add default responses to all endpoints to document all possible error codes that can be returned by the API. - Updated 400 error responses to correctly include the `bad-request` error code as a possible error. ## December 3rd, 2024 - Properly document `listId` property on `CompanyListEntry`, `PersonListEntry`, and `OpportunityListEntry` schemas. ## September 25th, 2024 - Upgrade schema to OpenAPI 3.1 ## August 5, 2024 - Correct `opp` to `opportunity` to match documentation for the `List` `type` property. ## July 24, 2024 - More accurate documentation for response properties that are enums — Enums with `null` as a possible value will have it listed as one. ## March 25, 2024 - Added the ability to retrieve the date and other details of your firm's "First Email", "Last Email", "First Event", "Last Event", "Next Event", "First Chat Message", "Last Chat Message", and "Last Contact" with a given entity. Use these timestamps to add relationship context to your applications, and to identify founders and companies that need investors' attention. - Endpoints that previously required a `fieldIds` parameter to return field data, now accept either `fieldIds` or `fieldTypes`, and will return field data accordingly. See the [Specifying Desired Fields (Field Selection)](/pages/data-model/working-with-field-data) section of these docs for more information. The new `fieldTypes` parameter should make field data retrieval easier for users looking to pull data from many similar Fields at a time. ## January 4, 2023 - Most endpoints that return field data now require the user to use the `fieldIds` parameter to specify which Fields they want data for. Without `fieldIds` specified, these endpoints will return basic entity data but not field data. ## December 12, 2023 - Added the ability to retrieve metadata (e.g. ID, name, type, enrichment source, and data type) on Fields. See the [Retrieving Field Metadata](/pages/data-model/working-with-field-data) section of these docs for more information. 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://assets.affinity.co/img/logos/full-color-svg.svg altText: Affinity logo servers: - url: https://api.affinity.co security: - apiKeyAuth: [] tags: - description: Operations about Auth name: Auth - description: Operations about Calls name: Calls - description: Operations about chat messages name: Chat Messages - description: Operations about companies name: Companies - description: Operations about company duplicate suggestions name: Company Duplicate Suggestions - description: Operations about company merges name: Company Merges - description: Operations about emails name: Emails - description: Operations about feedback name: Feedback - description: Operations about field value changes name: Field Value Changes - description: Operations about files name: Files - description: Operations about inferred connections name: Inferred Connections - description: Operations about introduction paths name: Intro Paths - description: Operations about lists name: Lists - description: Operations about meetings name: Meetings - description: Operations about notes name: Notes - description: Operations about opportunities name: Opportunities - description: Operations about person duplicate suggestions name: Person Duplicate Suggestions - description: Operations about person merges name: Person Merges - description: Operations about persons name: Persons - description: Operations about rate limits name: Rate Limit - description: Operations about reminders name: Reminders - description: Operations about semantic searches name: Semantic Search - description: Operations about teams name: Teams - description: Operations about transcripts name: Transcripts - description: Operations about users name: Users - description: Operations about webhooks name: Webhooks paths: /v2/intro-paths: get: tags: - Intro Paths summary: Get Introduction Paths description: > | ⚠️ This endpoint is currently in BETA | |--| Returns ranked introduction paths from an internal person to a target, strongest first. Each path is composed of one or two edges: a single edge is a direct relationship between an internal person and the target. Two edges represent an internal person reaching the target through a bridge person, where `edges[0].to` and `edges[1].from` are the same person. The target is specified with the required `filter` parameter, using exactly one of the `target.id` or `target.currentCompany.id` filter terms. `target.id` targets a specific person, whether an existing contact or a person already identified at a target company. `target.currentCompany.id` targets any person at that company; returned paths may lead to different people, and each path's target is `edges[edges.length - 1].to`, exposed as `target` for filtering. Only relative ordering is exposed. `rank` reflects each path's position among all paths to the target, computed before paging is applied, so a path keeps the same rank on whichever page it appears; it is not stable across requests as underlying data changes. `tier` is a qualitative `strong`, `moderate`, or `weak` band for the path as a whole. Neither `rank` nor `tier` exposes the underlying interaction score or inferred connection confidence used to compute them. Each edge also carries its own `tier`, independent of the path-level `tier`, so a client can distinguish which specific hop is strong or weak within a two-edge path. Results are always ordered by rank, strongest first. `orderBy` is not supported. ## Filters The `filter` parameter is required and must contain exactly one of the following filter terms. Providing both, or neither, returns a `400`. | **Property Name** | **Type** | **Description** | **Allowed Operators** | **Examples** | |---|---|---|---|---| | `target.id` | `integer` | The target person's id. | `=` | `target.id = 123` | | `target.currentCompany.id` | `integer` | The id of the company the target person currently works at; ranks paths to any person at that company. | `=` | `target.currentCompany.id = 456` | ## Path types An edge's `connectionInfo` carries whichever signals connect its two people, and more than one can be present on the same edge. `interactionScore` reflects interaction history, `lastInteraction` the most recent email, meeting, call, or chat message behind it, `linkedIn` a LinkedIn connection, and `sharedWorkHistory` or `investmentHistory` an inferred connection through shared employment or an investor-portfolio relationship. Each is `null` or empty when that signal is absent. operationId: v2_intro-paths__GET parameters: - name: filter description: >- Filter options. Required; must contain exactly one of the `target.id` or `target.currentCompany.id` filter terms. See the Filters section above. in: query required: true 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: 1 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/IntroPathsPaged' examples: introPaths: $ref: '#/components/examples/intro-paths' 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' components: schemas: IntroPathsPaged: title: IntroPathsPaged description: A paginated list of introduction paths. type: object properties: data: description: A page of IntroPath objects, ordered by rank, strongest first. type: array items: $ref: '#/components/schemas/IntroPath' maxItems: 100 pagination: $ref: '#/components/schemas/PaginationWithTotalCount' required: - data - pagination additionalProperties: false IntroPath: title: IntroPath description: A ranked introduction path from an internal person to a target person. type: object properties: rank: description: >- The path's position among all recommended paths to this target, where `1` is the strongest. Consistent across pagination and filtering: gaps may appear when a filter excludes higher-ranked paths, but a path's rank does not change based on which page or filter is applied. type: integer format: int64 minimum: 1 maximum: 9007199254740991 example: 1 tier: description: >- A qualitative strength for the path as a whole, derived from the interaction score and inferred connection confidence of its edges without exposing either value. type: string enum: - strong - moderate - weak example: strong target: $ref: '#/components/schemas/IntroPath.Target' description: >- The person this path leads to, equivalent to the last edge's `to`. Filterable by `target.id` and `target.currentCompany.id`. edges: description: >- The one or two edges that make up this path, in order from the internal person to the target. `edges[0].from` is the internal person and the last edge's `to` is the target person. A single edge is a direct path. Two edges represent an internal person reaching the target through a bridge person, who is `edges[0].to` (equivalently `edges[1].from`). type: array minItems: 1 maxItems: 2 items: $ref: '#/components/schemas/IntroPath.Edge' required: - rank - tier - target - edges additionalProperties: false example: rank: 1 tier: strong target: id: 55 name: Jane Doe title: CEO linkedinUrl: https://www.linkedin.com/in/janedoe currentCompany: id: 200 name: Acme domain: acme.co edges: - from: id: 42 firstName: Alice lastName: Roe primaryEmailAddress: alice@northpointvc.com linkedinUrl: https://www.linkedin.com/in/aliceroe to: id: 55 firstName: Jane lastName: Doe primaryEmailAddress: jane.doe@acme.co linkedinUrl: https://www.linkedin.com/in/janedoe connectionInfo: interactionScore: 0.72 lastInteraction: type: email sentAt: '2026-08-14T15:04:00Z' linkedIn: null sharedWorkHistory: [] investmentHistory: [] tier: strong PaginationWithTotalCount: title: PaginationWithTotalCount type: object allOf: - $ref: '#/components/schemas/Pagination' properties: totalCount: description: >- The total count of the collection. Only included if requested via the totalCount query string parameter. type: integer format: int64 minimum: 0 maximum: 9007199254740991 example: 42 BadRequestError: title: BadRequestError type: object properties: code: description: Error code type: string const: bad-request example: bad-request message: description: Error message type: string required: - code - message additionalProperties: false ValidationError: title: ValidationError type: object properties: code: description: Error code type: string const: validation example: validation message: description: Error message type: string param: description: Param the error refers to type: string example: limit required: - code - message - param additionalProperties: false NotFoundErrors: title: NotFoundErrors description: NotFoundErrors model type: object properties: errors: description: NotFoundError errors type: array items: $ref: '#/components/schemas/NotFoundError' required: - errors additionalProperties: false Errors: title: Errors type: object properties: errors: description: Errors type: array items: $ref: '#/components/schemas/Error' required: - errors additionalProperties: false IntroPath.Target: title: IntroPath.Target description: >- Identifies the person this path leads to, equivalent to the last edge's `to`. type: object properties: id: description: The target person's unique identifier. Filterable by `target.id`. type: integer format: int64 minimum: 1 maximum: 9007199254740991 example: 55 name: description: The target person's full name, or `null` when not known. type: - string - 'null' example: Jane Doe title: description: The target person's current job title, or `null` when not known. type: - string - 'null' example: CEO linkedinUrl: description: >- A link to the target person's LinkedIn profile, or `null` when not known. type: - string - 'null' example: https://www.linkedin.com/in/janedoe currentCompany: description: >- The company the target person currently works at, or `null` when not known. Filterable by `target.currentCompany.id`. oneOf: - $ref: '#/components/schemas/InferredConnectionCompanyRef' - type: 'null' required: - id - name - title - linkedinUrl - currentCompany additionalProperties: false IntroPath.Edge: title: IntroPath.Edge description: One hop in an introduction path, from one person to another. type: object properties: from: $ref: '#/components/schemas/IntroPath.Person' description: The person at the start of this edge. to: $ref: '#/components/schemas/IntroPath.Person' description: The person at the end of this edge. connectionInfo: $ref: '#/components/schemas/IntroPath.ConnectionInfo' description: A summary of how `from` and `to` are connected. tier: description: >- A qualitative strength for this edge alone, derived from its own interaction score or inferred connection confidence without exposing either value. Not necessarily the same as the `tier` of the path this edge belongs to. type: string enum: - strong - moderate - weak example: strong required: - from - to - connectionInfo - tier additionalProperties: false Pagination: title: Pagination type: object properties: prevUrl: description: URL for the previous page type: - string - 'null' format: uri example: https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw nextUrl: description: URL for the next page type: - string - 'null' format: uri example: https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA NotFoundError: title: NotFoundError type: object properties: code: description: Error code type: string const: not-found example: not-found message: description: Error message type: string required: - code - message additionalProperties: false Error: title: Error oneOf: - $ref: '#/components/schemas/AuthenticationError' - $ref: '#/components/schemas/AuthorizationError' - $ref: '#/components/schemas/BadRequestError' - $ref: '#/components/schemas/ConflictError' - $ref: '#/components/schemas/MethodNotAllowedError' - $ref: '#/components/schemas/NotAcceptableError' - $ref: '#/components/schemas/NotFoundError' - $ref: '#/components/schemas/NotImplementedError' - $ref: '#/components/schemas/RateLimitError' - $ref: '#/components/schemas/ServerError' - $ref: '#/components/schemas/TimeoutError' - $ref: '#/components/schemas/UnprocessableEntityError' - $ref: '#/components/schemas/UnsupportedMediaTypeError' - $ref: '#/components/schemas/ValidationError' discriminator: propertyName: code mapping: authentication: '#/components/schemas/AuthenticationError' authorization: '#/components/schemas/AuthorizationError' bad-request: '#/components/schemas/BadRequestError' conflict: '#/components/schemas/ConflictError' method-not-allowed: '#/components/schemas/MethodNotAllowedError' not-acceptable: '#/components/schemas/NotAcceptableError' not-found: '#/components/schemas/NotFoundError' not-implemented: '#/components/schemas/NotImplementedError' rate-limit: '#/components/schemas/RateLimitError' server: '#/components/schemas/ServerError' timeout: '#/components/schemas/TimeoutError' unprocessable-entity: '#/components/schemas/UnprocessableEntityError' unsupported-media-type: '#/components/schemas/UnsupportedMediaTypeError' validation: '#/components/schemas/ValidationError' InferredConnectionCompanyRef: title: InferredConnectionCompanyRef description: A reference to a company that appears in an inferred connection. type: object properties: id: description: The company's unique identifier. type: integer format: int64 minimum: 1 maximum: 9007199254740991 example: 123 name: description: The company's name. type: - string - 'null' domain: description: The company's primary domain, or `null` when not known. type: - string - 'null' example: acme.com required: - id - name - domain additionalProperties: false IntroPath.Person: title: IntroPath.Person description: >- A person on an introduction path: the internal person making the introduction, the bridge person in a two-edge path, or the target. type: object properties: id: description: The person's unique identifier. type: integer format: int64 minimum: 1 maximum: 9007199254740991 example: 1 firstName: description: The person's first name, or `null` when not known. type: - string - 'null' example: Jane lastName: description: The person's last name, or `null` when not known. type: - string - 'null' example: Doe primaryEmailAddress: description: The person's primary email address, or `null` when not known. type: - string - 'null' format: email example: jane.doe@acme.co linkedinUrl: description: A link to the person's LinkedIn profile, or `null` when not known. type: - string - 'null' example: https://www.linkedin.com/in/janedoe required: - id - firstName - lastName - primaryEmailAddress - linkedinUrl additionalProperties: false IntroPath.ConnectionInfo: title: IntroPath.ConnectionInfo description: >- The signals connecting `from` and `to`. Any subset of properties may be present, since two people can be connected by more than one signal at once, such as an interaction history and a LinkedIn connection. type: object properties: interactionScore: description: >- The relationship strength between the two people from interaction history, between `0.0` and `1.0`, or `null` when there is no interaction history between them. type: - number - 'null' format: double minimum: 0 maximum: 1 example: 0.72 lastInteraction: description: >- The most recent interaction between the two people, or `null` when they have none. oneOf: - $ref: '#/components/schemas/IntroPath.ConnectionInfo.LastInteraction' - type: 'null' linkedIn: description: >- The LinkedIn connection signal between the two people, or `null` when absent. oneOf: - $ref: '#/components/schemas/IntroPath.ConnectionInfo.LinkedIn' - type: 'null' sharedWorkHistory: description: >- Every coworker-overlap signal between the two people, from shared past employment. Empty when there is no such signal. type: array maxItems: 50 items: $ref: '#/components/schemas/CoworkerInference' investmentHistory: description: >- Every investor-portfolio signal between the two people. Empty when there is no such signal. type: array maxItems: 50 items: $ref: '#/components/schemas/IntroPath.ConnectionInfo.InvestorPortfolio' required: - interactionScore - lastInteraction - linkedIn - sharedWorkHistory - investmentHistory additionalProperties: false example: interactionScore: 0.72 lastInteraction: type: email sentAt: '2026-08-14T15:00:00Z' linkedIn: null sharedWorkHistory: [] investmentHistory: [] AuthenticationError: title: AuthenticationError type: object properties: code: description: Error code type: string const: authentication example: authentication message: description: Error message type: string required: - code - message additionalProperties: false AuthorizationError: title: AuthorizationError type: object properties: code: description: Error code type: string const: authorization example: authorization message: description: Error message type: string required: - code - message additionalProperties: false ConflictError: title: ConflictError type: object properties: code: description: Error code type: string const: conflict example: conflict message: description: Error message type: string required: - code - message additionalProperties: false MethodNotAllowedError: title: MethodNotAllowedError type: object properties: code: description: Error code type: string const: method-not-allowed example: method-not-allowed message: description: Error message type: string required: - code - message additionalProperties: false NotAcceptableError: title: NotAcceptableError type: object properties: code: description: Error code type: string const: not-acceptable example: not-acceptable message: description: Error message type: string required: - code - message additionalProperties: false NotImplementedError: title: NotImplementedError type: object properties: code: description: Error code type: string const: not-implemented example: not-implemented message: description: Error message type: string required: - code - message additionalProperties: false RateLimitError: title: RateLimitError type: object properties: code: description: Error code type: string const: rate-limit example: rate-limit message: description: Error message type: string required: - code - message additionalProperties: false ServerError: title: ServerError type: object properties: code: description: Error code type: string const: server example: server message: description: Error message type: string required: - code - message additionalProperties: false TimeoutError: title: TimeoutError type: object properties: code: description: Error code type: string const: timeout example: timeout message: description: Error message type: string required: - code - message additionalProperties: false UnprocessableEntityError: title: UnprocessableEntityError type: object properties: code: description: Error code type: string const: unprocessable-entity example: unprocessable-entity message: description: Error message type: string required: - code - message additionalProperties: false UnsupportedMediaTypeError: title: UnsupportedMediaTypeError type: object properties: code: description: Error code type: string const: unsupported-media-type example: unsupported-media-type message: description: Error message type: string required: - code - message additionalProperties: false IntroPath.ConnectionInfo.LastInteraction: title: IntroPath.ConnectionInfo.LastInteraction description: >- The most recent interaction between an edge's two people, as evidence of how current their relationship is. `type` says which kind it was, and the properties carrying its timing follow from that: an `email` or `chat-message` has `sentAt`, a `meeting` or `call` has `startTime` and `endTime`. oneOf: - $ref: '#/components/schemas/IntroPath.ConnectionInfo.LastInteraction.Email' - $ref: >- #/components/schemas/IntroPath.ConnectionInfo.LastInteraction.ChatMessage - $ref: >- #/components/schemas/IntroPath.ConnectionInfo.LastInteraction.Meeting - $ref: '#/components/schemas/IntroPath.ConnectionInfo.LastInteraction.Call' IntroPath.ConnectionInfo.LinkedIn: title: IntroPath.ConnectionInfo.LinkedIn description: A LinkedIn connection signal between two people. type: object properties: connectedOn: description: The date the LinkedIn connection was established. type: string format: date example: '2022-06-15' required: - connectedOn additionalProperties: false CoworkerInference: title: CoworkerInference description: >- The belief that the source and target worked together: they were employed at the same company at the same time. The `sharedEmployer` is that company; `overlapStartDate` and `overlapEndDate` bound the period their employment overlapped. type: object properties: sharedEmployer: $ref: '#/components/schemas/InferredConnectionCompanyRef' description: >- The company at which the source and target were employed at the same time. overlapStartDate: description: >- The first date on which the source and target were both employed at the `sharedEmployer`. type: string format: date example: '2018-03-01' overlapEndDate: description: >- The last date on which the source and target were both employed at the `sharedEmployer`. type: string format: date example: '2020-11-30' required: - sharedEmployer - overlapStartDate - overlapEndDate additionalProperties: false example: sharedEmployer: id: 555 name: Globex domain: globex.com overlapStartDate: '2018-03-01' overlapEndDate: '2020-11-30' IntroPath.ConnectionInfo.InvestorPortfolio: title: IntroPath.ConnectionInfo.InvestorPortfolio description: >- An investor and portfolio-company relationship behind an investor-portfolio signal, and the deal that ties the two people together. type: object properties: inference: $ref: '#/components/schemas/InvestorExecutiveInference' description: The investor and portfolio-company relationship behind this signal. dealContext: $ref: '#/components/schemas/DealContext' description: The funding round behind this signal and each person's role in it. required: - inference - dealContext additionalProperties: false IntroPath.ConnectionInfo.LastInteraction.Email: title: IntroPath.ConnectionInfo.LastInteraction.Email description: >- The most recent interaction between an edge's two people, when it was an email. type: object properties: type: description: The kind of interaction. type: string const: email sentAt: description: The timestamp of when the email was sent. type: string format: date-time example: '2026-08-14T15:04:00Z' required: - type - sentAt additionalProperties: false example: type: email sentAt: '2026-08-14T15:04:00Z' IntroPath.ConnectionInfo.LastInteraction.ChatMessage: title: IntroPath.ConnectionInfo.LastInteraction.ChatMessage description: >- The most recent interaction between an edge's two people, when it was a chat message. type: object properties: type: description: The kind of interaction. type: string const: chat-message sentAt: description: The timestamp of when the chat message was sent. type: string format: date-time example: '2026-08-14T15:04:00Z' required: - type - sentAt additionalProperties: false example: type: chat-message sentAt: '2026-08-14T15:04:00Z' IntroPath.ConnectionInfo.LastInteraction.Meeting: title: IntroPath.ConnectionInfo.LastInteraction.Meeting description: >- The most recent interaction between an edge's two people, when it was a meeting. type: object properties: type: description: The kind of interaction. type: string const: meeting startTime: description: The timestamp of when the meeting starts. type: string format: date-time example: '2026-06-02T09:30:00Z' endTime: description: >- The timestamp of when the meeting ends, or `null` when it is not known. type: - string - 'null' format: date-time example: '2026-06-02T10:30:00Z' required: - type - startTime - endTime additionalProperties: false example: type: meeting startTime: '2026-06-02T09:30:00Z' endTime: '2026-06-02T10:30:00Z' IntroPath.ConnectionInfo.LastInteraction.Call: title: IntroPath.ConnectionInfo.LastInteraction.Call description: >- The most recent interaction between an edge's two people, when it was a call. type: object properties: type: description: The kind of interaction. type: string const: call startTime: description: The timestamp of when the call starts. type: string format: date-time example: '2026-06-02T09:30:00Z' endTime: description: The timestamp of when the call ends, or `null` when it is not known. type: - string - 'null' format: date-time example: '2026-06-02T10:00:00Z' required: - type - startTime - endTime additionalProperties: false example: type: call startTime: '2026-06-02T09:30:00Z' endTime: '2026-06-02T10:00:00Z' InvestorExecutiveInference: title: InvestorExecutiveInference description: >- The belief that the source invested in a company where the target was an executive. The `investingFirm` is the firm the source invested through, when known; the `portfolioCompany` is the company the target was an executive at. type: object properties: investingFirm: description: The firm the source invested through, or `null` when not known. oneOf: - $ref: '#/components/schemas/InferredConnectionCompanyRef' - type: 'null' portfolioCompany: $ref: '#/components/schemas/InferredConnectionCompanyRef' description: The company the target was an executive at. required: - investingFirm - portfolioCompany additionalProperties: false example: investingFirm: id: 456 name: Sequoia domain: sequoia.com portfolioCompany: id: 123 name: Acme domain: acme.com DealContext: title: DealContext description: >- The deal that ties the source and target together: the funding round, the source's role as the investor, and the target's role as the executive at the company that was funded. type: object properties: fundingEvent: $ref: '#/components/schemas/DealFundingEvent' description: The funding round behind the connection. investor: $ref: '#/components/schemas/DealMemberRole' description: The source's role as the investor, at the investing firm. executive: $ref: '#/components/schemas/DealMemberRole' description: The target's role as the executive, at the company that was funded. required: - fundingEvent - investor - executive additionalProperties: false example: fundingEvent: date: '2021-05-01' series: Series A amount: 15000000 currencyCode: USD investor: title: Partner startDate: '2018-06-01' endDate: null company: id: 456 name: Sequoia domain: sequoia.com executive: title: CEO startDate: '2019-02-01' endDate: '2022-03-31' company: id: 123 name: Acme domain: acme.com DealFundingEvent: title: DealFundingEvent description: 'The funding round behind the connection: when it happened and its size.' type: object properties: date: description: The date the funding round took place. type: string format: date example: '2021-05-01' series: description: The funding round's series, or `null` when not known. type: - string - 'null' example: Series A amount: description: >- The amount raised in the round, in `currencyCode`, or `null` when not known. type: - number - 'null' format: float example: 15000000 currencyCode: description: The ISO 4217 currency code for `amount`, or `null` when not known. type: - string - 'null' example: USD required: - date - series - amount - currencyCode additionalProperties: false DealMemberRole: title: DealMemberRole description: >- A party's role in the deal: their title and tenure at the `company` involved. For the investor this is the investing firm; for the executive it is the company they led. type: object properties: title: description: The person's title in the role, or `null` when not known. type: - string - 'null' example: Partner startDate: description: The date the person started the role. type: string format: date example: '2018-06-01' endDate: description: >- The date the person left the role, or `null` when they are still in it. type: - string - 'null' format: date example: '2022-03-31' company: $ref: '#/components/schemas/InferredConnectionCompanyRef' description: The company the person held the role at. required: - title - startDate - endDate - company additionalProperties: false examples: intro-paths: value: data: - rank: 1 tier: strong target: id: 55 name: Jane Doe title: CEO linkedinUrl: https://www.linkedin.com/in/janedoe currentCompany: id: 200 name: Acme domain: acme.co edges: - from: id: 42 firstName: Alice lastName: Roe primaryEmailAddress: alice@northpointvc.com linkedinUrl: https://www.linkedin.com/in/aliceroe to: id: 55 firstName: Jane lastName: Doe primaryEmailAddress: jane.doe@acme.co linkedinUrl: https://www.linkedin.com/in/janedoe connectionInfo: interactionScore: 0.85 lastInteraction: type: email sentAt: '2026-08-14T15:04:00Z' linkedIn: null sharedWorkHistory: [] investmentHistory: [] tier: strong - rank: 2 tier: moderate target: id: 55 name: Jane Doe title: CEO linkedinUrl: https://www.linkedin.com/in/janedoe currentCompany: id: 200 name: Acme domain: acme.co edges: - from: id: 42 firstName: Alice lastName: Roe primaryEmailAddress: alice@northpointvc.com linkedinUrl: https://www.linkedin.com/in/aliceroe to: id: 22 firstName: Alex lastName: Kim primaryEmailAddress: alex.kim@acme.co linkedinUrl: https://www.linkedin.com/in/alexkim connectionInfo: interactionScore: 0.55 lastInteraction: type: meeting startTime: '2026-06-02T09:30:00Z' endTime: '2026-06-02T10:30:00Z' linkedIn: null sharedWorkHistory: [] investmentHistory: [] tier: moderate - from: id: 22 firstName: Alex lastName: Kim primaryEmailAddress: alex.kim@acme.co linkedinUrl: https://www.linkedin.com/in/alexkim to: id: 55 firstName: Jane lastName: Doe primaryEmailAddress: jane.doe@acme.co linkedinUrl: https://www.linkedin.com/in/janedoe connectionInfo: interactionScore: null lastInteraction: null linkedIn: null sharedWorkHistory: - sharedEmployer: id: 555 name: Globex domain: globex.com overlapStartDate: '2018-03-01' overlapEndDate: '2020-11-30' investmentHistory: [] tier: moderate pagination: prevUrl: null nextUrl: null headers: X-Ratelimit-Limit-User: description: Number of requests allowed per minute for the user schema: type: integer X-Ratelimit-Limit-User-Remaining: description: Number of requests remaining for the user schema: type: integer X-Ratelimit-Limit-User-Reset: description: Time in seconds before the limit resets for the user schema: type: integer X-Ratelimit-Limit-Org: description: >- Number of requests allowed per month for the account. Absent when no monthly quota applies to the caller, for example a plan with no monthly cap. schema: type: integer X-Ratelimit-Limit-Org-Remaining: description: >- Number of requests remaining for the account. Absent when no monthly quota applies to the caller, for example a plan with no monthly cap. schema: type: integer X-Ratelimit-Limit-Org-Reset: description: >- Time in seconds before the limit resets for the account. Absent when no monthly quota applies to the caller, for example a plan with no monthly cap. schema: type: integer responses: '400': description: Bad Request content: application/json: schema: title: responses.400 type: object properties: errors: type: array items: oneOf: - $ref: '#/components/schemas/BadRequestError' - $ref: '#/components/schemas/ValidationError' discriminator: propertyName: code mapping: bad-request: '#/components/schemas/BadRequestError' validation: '#/components/schemas/ValidationError' required: - errors additionalProperties: false 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': description: Not Found content: application/json: schema: $ref: '#/components/schemas/NotFoundErrors' 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' default: description: Errors content: application/json: schema: $ref: '#/components/schemas/Errors' 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' securitySchemes: apiKeyAuth: type: http scheme: bearer description: A static Affinity API key, presented as a bearer token. ```` ## Related topics - [Previous Changes](https://developer.affinity.co/pages/changelog/previous-changes.md) - [Introduction](https://developer.affinity.co/pages/mcp/introduction.md) - [Working with Field Data](https://developer.affinity.co/pages/data-model/working-with-field-data.md) - [Persons](https://developer.affinity.co/pages/data-share/persons_v1_0.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.