Affinity
Affinity helps private capital investors to find, manage, and close more deals
Tools (130)
Add a List Entry to a List
Beta Affinity API v2 action. Add a List Entry to a List. Adds a Company or Person to a List as a new List Entry. Opportunities cannot be added with this endpoint. The type of the entity referenced by `entity.id` is determined by the List's type: a Company ID for a company List, a Person ID for a person List. If no entity of the List's type exists with the given ID, the request is rejected with `400 Bad Request`. Only the List's own required fields are checked. Required fields on the entity itself were already enforced when the entity was created, so they are not re-checked here. If the List has a required field, the request is rejected with `400 Bad Request` and the missing field IDs are returned in the response body. This endpoint does not accept field values, so there is no API-level remediation: populate such a List through a UI flow that provides values at add time, or remove the required flag from the List's field configuration.
Inputs: body, listId
Create a Company Field
Beta Affinity API v2 action. Create a Company Field. Creates a Company Field. A Company Field is available on every company in the organization. Values for the new Field can be set on each company via `POST /v2/companies/{companyId}/fields/{fieldId}`. Requires the Manage global fields permission. Fields of value type `dropdown`, `dropdown-multi`, and `ranked-dropdown` are created without any dropdown options.
Inputs: body
Create a dropdown option for a List Field
Affinity API v2 action. Create a dropdown option for a List Field. Create a dropdown option for a List Field.
Inputs: body, listId, fieldId
Create a List
Affinity API v2 action. Create a List. Create a new List. The List type determines the kind of entities (Companies, Persons, or Opportunities) that can be added. The requester is recorded as the creator and the owner.
Inputs: body
Create a List Field
Beta Affinity API v2 action. Create a List Field. | This endpoint is currently in BETA | |--| Creates a list-specific Field on a List. Values for the new Field can be set on each List Entry via `POST /v2/lists/{listId}/list-entries/{listEntryId}/fields/{fieldId}`. Requires the Standard role or higher on the List. Creating a field with `isRequired` set to `true` requires the Admin role on the List. Fields of value type `dropdown`, `dropdown-multi`, and `ranked-dropdown` are created without any dropdown options.
Inputs: body, listId
Create an Opportunity
Beta Affinity API v2 action. Create an Opportunity. | This endpoint is currently in BETA | |--| Creates an Opportunity on an opportunity List. The Opportunity is added to the List as a List Entry. When `listId` is not an opportunity List, the request fails. The new List Entry gets the default values of the List. When the List has a Status Field, the Status is the first open status. When the List has an Owners Field, the requester is added as an Owner. The name must be unique on the List. The request cannot include Field values, so the required Fields of the List are not checked. When `isRestricted` is `true`, the Opportunity is restricted, and the requester is added to its allow list. When a Person Field of the List sets the allow list, the requester is added to that Field. When the requester cannot access the new Opportunity, the response is redacted. When your organization does not allow the requested type of Opportunity, the request fails. Requires access to the List.
Inputs: body
Create a Note
Affinity API v2 action. Create a Note. Create a new note. By default it is authored by the calling user; set `creator` to attribute it to a different internal person in your organization. Notes can be attached directly to entities (`Persons`, `Companies`, `Opportunities`), anchored to an interaction (`meeting`, `call`, or `chat message`), or written as a reply to an existing note. The `type` field selects the shape of the request body. AI Notetaker note types (`ai-notetaker`, `ai-notetaker-reply`) are system-generated and cannot be created through this endpoint.
Inputs: body
Create a Person
Beta Affinity API v2 action. Create a Person. This endpoint is currently in BETA. Creates a new Person. Setting `fields` values requires the "Edit Global Field Values" permission and returns a 403 error if the caller lacks it.
Inputs: body
Create a Person Field
Beta Affinity API v2 action. Create a Person Field. Creates a Person Field. A Person Field is available on every person in the organization. Values for the new Field can be set on each person via `POST /v2/persons/{personId}/fields/{fieldId}`. Requires the Manage global fields permission. Fields of value type `dropdown`, `dropdown-multi`, and `ranked-dropdown` are created without any dropdown options.
Inputs: body
Create a Reminder
Affinity API v2 action. Create a Reminder. Creates a new Reminder. Exactly one of `company`, `person`, or `opportunity` must be provided. The `creator` of the new reminder is the user associated with the API key.
Inputs: body
Delete a Company Field
Beta Affinity API v2 action. Delete a Company Field. Deletes a Company Field. **Warning:** This permanently removes the field and clears every field value set on it across all companies. The cleared values cannot be recovered. Requires the Manage global fields permission. Accepts the Field ID of a custom field (`field-<number>`), of an enriched field (for example, `affinity-data-location`), or of a native field (for example, `source-of-introduction`). An enriched or native field by its `field-<number>` ID returns 404. A field from a restricted data partner (see Partner Data Restrictions) returns 404. Native and enriched fields cannot be deleted and return 400. Fields that are computed by Affinity, such as `first-email`, return 404.
Inputs: fieldId
Delete a dropdown option for a List Field
Affinity API v2 action. Delete a dropdown option for a List Field. Delete a dropdown option for a List Field. **Warning:** This permanently removes the option and clears every field value currently set to it across all List Entries. The cleared values cannot be recovered.
Inputs: listId, fieldId, dropdownOptionId
Delete a List Field
Beta Affinity API v2 action. Delete a List Field. | This endpoint is currently in BETA | |--| Deletes a list-specific Field from a List. **Warning:** This permanently removes the field and clears every field value set on it across all List Entries in the List. The cleared values cannot be recovered. Only list-specific (custom) fields can be removed via this endpoint. Native list-managed fields cannot be deleted. Requires the Admin role on the List. A user with the Standard role on the List can delete a field only when no values are set on it.
Inputs: listId, fieldId
Delete an Opportunity
Beta Affinity API v2 action. Delete an Opportunity. | This endpoint is currently in BETA | |--| Deletes an Opportunity. Requires manage access to the opportunity.
Inputs: opportunityId
Delete a Person
Beta Affinity API v2 action. Delete a Person. This endpoint is currently in BETA. Deletes a Person. Returns a 403 error if the Person is internal or inferred internal, since those Persons cannot be deleted.
Inputs: personId
Delete a Person Field
Beta Affinity API v2 action. Delete a Person Field. Deletes a Person Field. **Warning:** This permanently removes the field and clears every field value set on it across all persons. The cleared values cannot be recovered. Requires the Manage global fields permission. Accepts the Field ID of a custom field (`field-<number>`), of an enriched field (for example, `affinity-data-current-job-title`), or of a native field (for example, `source-of-introduction`). An enriched or native field by its `field-<number>` ID returns 404. Native and enriched fields cannot be deleted and return 400. Fields that are computed by Affinity, such as `first-email`, return 404.
Inputs: fieldId
Delete a Reminder
Beta Affinity API v2 action. Delete a Reminder. Deletes a Reminder. Only the reminder's creator or owner may delete it.
Inputs: reminderId
Delete a single Note
Affinity API v2 action. Delete a single Note. Delete a note. You can only delete notes you created. Deleting a root note also deletes its replies (both user replies and AI Notetaker replies); deleting a reply removes only that reply.
Inputs: noteId
Delete a single Transcript
Beta Affinity API v2 action. Delete a single Transcript. Delete a transcript. The AI Notetaker summary note the transcript belongs to is kept. You can only delete transcripts of notes you created.
Inputs: transcriptId
Generate suggested field updates
Beta Affinity API v2 action. Generate suggested field updates. The endpoint returns 404 when AI agents access is not enabled for the organization. Generate suggested field updates from a note or a meeting. Generation runs asynchronously: poll the returned `taskUrl` until the task finishes, then retrieve the set. The set can also be retrieved while generation runs, with `status` `pending`. Sets belong to the user who requested them. Sets generated automatically for a new note belong to the note's creator. You have at most one `pending` set per subject. While it is generating, repeated requests return its task. Otherwise each request generates a new set, and your `open` set for the subject becomes `done`. Its undecided suggestions can no longer be decided. Other users' sets for the subject are not affected. Returns `404` when the subject does not exist or is not accessible to you.
Inputs: body
Get a company s list entries
Summarize company data across all lists, including list-specific fields and metadata like creation date and author. Access requires "Export data from Lists" permission.
Inputs: id, limit, cursor
Get a company s lists
Returns metadata for all the Lists on which the given Company appears.
Inputs: id, limit, cursor
Get a dropdown option for a List Field
Affinity API v2 action. Get a dropdown option for a List Field. Get a single dropdown option for a List Field.
Inputs: listId, fieldId, dropdownOptionId
Get all companies
Request paginated company information, optionally filtering by company IDs and specifying field IDs or types. Export permission is needed.
Inputs: ids, limit, cursor, fieldIds, fieldTypes
Get All Company Duplicate Suggestions
Beta Affinity API v2 action. Get All Company Duplicate Suggestions. Retrieves company duplicate suggestions detected for your organization. Each suggestion contains a recommended `primaryProfile` and a `duplicateProfiles` array containing the single company profile Affinity has identified as a likely duplicate, along with the `matchCriteria` that produced the suggestion. The full company payload is returned for both sides so that an automated agent can evaluate the suggestion without additional lookups. Only actionable suggestions are returned: pairs that have no feedback recorded yet (not merged, not marked as not-duplicates, and not skipped) and whose underlying company profiles are still active and eligible to be merged. Suggestions that have already been acted on are omitted. You can narrow the results using the `filter` query parameter, which accepts the Affinity Filtering Language.
Inputs: term, limit, cursor, filter, orderBy, totalCount
Get All Company Merges
Affinity API v2 action. Get All Company Merges. Retrieve paginated company merges for the organization. Returns all company merges initiated by users in your organization, including their current status, 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: | **Property Name** | **Type** | **Allowed Operators** | **Examples** | |---|---|---|---| | `status` | `enum` | `=` | `status=in-progress`, `status=success`, `status=failed` | | `taskId` | `text` | `=` | `taskId=789e0123-e45b-67c8-d901-234567890123` | Company merges are returned in reverse chronological order (most recent first). Requires the "Manage duplicates" [permission](/pages/external-api-v2/permissions) and organization admin role.
Inputs: limit, cursor, filter
Get All Company Merge Tasks
Affinity API v2 action. Get All Company Merge Tasks. Retrieve paginated company merge tasks for the organization. Returns all merge tasks initiated by users in your organization, including their current status, the companies involved, and task details. You can filter tasks using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties: | **Property Name** | **Type** | **Allowed Operators** | **Examples** | |---|---|---|---| | `status` | `enum` | `=` | `status=in-progress`, `status=success`, `status=failed` | Tasks are returned in reverse chronological order (most recent first). Requires the "Manage duplicates" [permission](/pages/external-api-v2/permissions) and organization admin role.
Inputs: limit, cursor, filter
Get all field value changes
Affinity API v2 action. Get all field value changes. Retrieve field value changes across all entities and fields in your Affinity workspace. For an overview of field value changes, including which fields support change tracking and how the action types behave, see [Field Value Changes](/pages/data-model/working-with-field-data#field-value-changes). This endpoint is built for delta-sync. Within a single sync, follow `pagination.nextUrl` to page through results until it becomes `null`, which means you have reached the most recent change. To run the next incremental sync, record the `changedAt` of the last change you processed and, on your next sync, filter for changes newer than that timestamp (for example, `filter=changedAt>2024-06-01T12:00:00Z`). Do not persist `nextUrl` between syncs, since it is `null` once you are caught up. Changes are returned in ascending order of `changedAt`, then by internal change ID. Only fields with change tracking enabled are included.
Inputs: limit, cursor, filter, orderBy
Get all Files
Beta Affinity API v2 action. Get all Files. | This endpoint is currently in BETA | |--| Returns a page of Files visible to the caller. You can filter files using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties. | **Property Name** | **Type** | **Allowed Operators** | **Examples** | |---|---|---|---| | `createdAt` | `datetime` | `>`, `<`, `>=`, `<=` | `createdAt>=2026-01-01T00:00:00Z` | | `creator.id` | `int64` | `=` | `creator.id=1` | | `person.id` | `int64` | `=` | `person.id=1` | | `company.id` | `int64` | `=` | `company.id=1` | | `opportunity.id` | `int64` | `=` | `opportunity.id=1` | Results are ordered by `createdAt` descending (most recently uploaded first).
Inputs: limit, cursor, filter, totalCount
Get all list entries on a list
Retrieve list entries and entity metadata for companies, persons, or opportunities on a list. The request accepts field IDs or types and requires "Export data from Lists" permission.
Inputs: limit, cursor, listId, fieldIds, fieldTypes
Get all list entries on a saved view
Use the endpoint to access rows in a Saved View with specific filters and selected fields from a web app. It doesn't maintain sort order, supports only sheet-type views, and requires export permissions.
Inputs: limit, cursor, listId, viewId
Get all Lists a Team has access to
Beta Affinity API v2 action. Get all Lists a Team has access to. Paginate through all Lists this Team has been granted access to. This endpoint backs the `accessibleListsPreview` returned by `GET /v2/teams/{teamId}?includes=accessibleListsPreview`.
Inputs: limit, cursor, teamId, totalCount
Get all members of a Team
Beta Affinity API v2 action. Get all members of a Team. Paginate through all members of a specific Team. This endpoint backs the `membersPreview` returned by `GET /v2/teams/{teamId}?includes=membersPreview`.
Inputs: limit, cursor, teamId, totalCount
Get all Notes
Affinity API v2 action. Get all Notes. Returns all notes, with the exception of replies. You can filter notes using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties. | **Property Name** | **Type** | **Allowed Operators** | **Examples** | |---|---|---|---| | `id` | `int32` | `=` | `id=1\|id=2\|id=3` | | `creator.id` | `int32` | `=` | `creator.id=1` | | `createdAt` | `datetime` | `>`, `<`, `>=`, `<=` | `createdAt<2025-02-04T10:48:24Z` | | `updatedAt` | `datetime` | `>`, `<`, `>=`, `<=` | `updatedAt>=2025-02-03T10:48:24Z` |
Inputs: limit, cursor, filter, includes, totalCount
Get all opportunities
Pagination through Opportunities in Affinity yields basic info but excludes field data. For field data, use specified GET endpoints. "Export data from Lists" permission needed.
Inputs: ids, limit, cursor
Get All Person Duplicate Suggestions
Beta Affinity API v2 action. Get All Person Duplicate Suggestions. Retrieves person duplicate suggestions detected for your organization. Each suggestion contains a recommended `primaryProfile` and a `duplicateProfiles` array containing the single person profile Affinity has identified as a likely duplicate, along with the `matchCriteria` that produced the suggestion. The full person payload is returned for both sides so that an automated agent can evaluate the suggestion without additional lookups. Only actionable suggestions are returned: pairs that have no feedback recorded yet (not merged, not marked as not-duplicates, and not skipped) and whose underlying person profiles are still active and eligible to be merged. Suggestions that have already been acted on are omitted. You can narrow the results using the `filter` query parameter, which accepts the Affinity Filtering Language.
Inputs: term, limit, cursor, filter, orderBy, totalCount
Get All Person Merges
Affinity API v2 action. Get All Person Merges. Retrieve paginated person merges for the organization. Returns all person merges initiated by users in your organization, including their current status, the persons involved, and merge details. You can filter person merges using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties: | **Property Name** | **Type** | **Allowed Operators** | **Examples** | |---|---|---|---| | `status` | `enum` | `=` | `status=in-progress`, `status=success`, `status=failed` | | `taskId` | `text` | `=` | `taskId=789e0123-e45b-67c8-d901-234567890123` | Person merges are returned in reverse chronological order (most recent first). Requires the "Manage duplicates" [permission](/pages/external-api-v2/permissions) and organization admin role.
Inputs: limit, cursor, filter
Get All Person Merge Tasks
Affinity API v2 action. Get All Person Merge Tasks. Retrieve paginated person merge tasks for the organization. Returns all merge tasks initiated by users in your organization, including their current status, the persons involved, and task details. You can filter tasks using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties: | **Property Name** | **Type** | **Allowed Operators** | **Examples** | |---|---|---|---| | `status` | `enum` | `=` | `status=in-progress`, `status=success`, `status=failed` | Tasks are returned in reverse chronological order (most recent first). Requires the "Manage duplicates" [permission](/pages/external-api-v2/permissions) and organization admin role.
Inputs: limit, cursor, filter
Get all persons
The Affinity API offers paginated access to Person data using `fieldIds` or `fieldTypes`. Bulk extraction needs special permissions and supports multiple parameters.
Inputs: ids, limit, cursor, fieldIds, fieldTypes
Get all Reminders
Affinity API v2 action. Get all Reminders. Returns a page of Reminders visible to the caller. You can filter reminders using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties.
Inputs: limit, cursor, filter, totalCount
Get all suggested field update sets
Beta Affinity API v2 action. Get all suggested field update sets. The endpoint returns 404 when AI agents access is not enabled for the organization. Paginate through your suggested field update sets, newest first. Items omit `suggestions`; retrieve a set to get them. Sets generated automatically for a new note belong to the note's creator. Sets whose subject is not accessible to you are not returned. Sets where the agent found nothing to suggest are not listed. Retrieving such a set by id reports it as `done`. You can filter sets using the `filter` query parameter. Combine conditions with `&` (AND). | **Property Name** | **Type** | **Allowed Operators** | **Examples** | |---|---|---|---| | `status` | `enum` | `=` | `status=open`, `status=pending` | | `subject.type` | `enum` | `=` | `subject.type=note`, `subject.type=meeting` | | `subject.id` | `int64` | `=` | `subject.id=6789` | | `createdAt` | `datetime` | `>=` | `createdAt>=2026-10-01T00:00:00Z` | `createdAt` supports a lower bound only.
Inputs: limit, cursor, filter
Get all suggested field update tasks
Beta Affinity API v2 action. Get all suggested field update tasks. The endpoint returns 404 when AI agents access is not enabled for the organization. Paginate through your suggested field update generation tasks, newest first. You can filter tasks using the `filter` query parameter. | **Property Name** | **Type** | **Allowed Operators** | **Examples** | |---|---|---|---| | `status` | `enum` | `=` | `status=in-progress`, `status=success`, `status=failed` |
Inputs: limit, cursor, filter
Get all Transcripts
Affinity API v2 action. Get all Transcripts. Paginate through all transcripts and return basic metadata only. Use the single transcript endpoint to fetch the entire transcript data. Will only return transcripts that the current authenticated user has permission to see. You can filter transcripts using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties. | **Property Name** | **Type** | **Allowed Operators** | **Examples** | |---|---|---|---| | `id` | `int32` | `=` | `id=1` | | `createdAt` | `datetime` | `>`, `<`, `>=`, `<=` | `createdAt<2025-02-04T10:48:24Z` |
Inputs: limit, cursor, filter, totalCount
Get all Users
Beta Affinity API v2 action. Get all Users. Paginate through internal Users in your organization. Returns information about each User, including name, primary email address, all email addresses, photo URL, account status, and account role. The `emailAddresses` and `role` properties are only returned to callers with the "Manage Users" [permission](/pages/external-api-v2/permissions). Use the optional `term` parameter to filter by first name, last name, or primary email address. You can also filter users using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties. | **Property Name** | **Type** | **Allowed Operators** | **Examples** | |---|---|---|---| | `id` | `int32` | `=` | `id=1\|id=2\|id=3` | | `status` | `enum` | `=` | `status=active` |
Inputs: term, limit, cursor, filter
Get a person s list entries
Summary: Browse rows for a Person in all Lists, showing field data and entry metadata like creation time and author. Requires "Export data from Lists" permission.
Inputs: id, limit, cursor
Get a person s lists
Returns metadata for all the Lists on which the given Person appears.
Inputs: id, limit, cursor
Get a single company
Retrieve basic company info and specific field data by using `fieldIds` or `fieldTypes` parameters. Multiple fields can be queried. No field data if parameters aren't specified. Requires "Export All Organizations directory" permission.
Inputs: id, fieldIds, fieldTypes
Get a single field on a Person
Beta Affinity API v2 action. Get a single field on a Person. Retrieve a single field on a person. Returns basic information and the field value.
Inputs: fieldId, personId
Get a single field value
Affinity API v2 action. Get a single field value. Returns a single field value on a list entry.
Inputs: listId, fieldId, listEntryId
Get a single field value on a Company
Beta Affinity API v2 action. Get a single field value on a Company. Retrieve a single field on a company. Returns basic information and the field value.
Inputs: fieldId, companyId
Get a single File
Beta Affinity API v2 action. Get a single File. | This endpoint is currently in BETA | |--| Returns a single file's metadata and a temporary signed download URL.
Inputs: fileId
Get a single List Entry on a List
Affinity API v2 action. Get a single List Entry on a List. Retrieve a single list entry. Returns basic information and field data, including list-specific field data. To retrieve field data, you must use either the `fieldIds` or the `fieldTypes` parameter to specify the Fields for which you want data returned. These Field IDs and Types can be found using the GET `/v2/lists/{listId}/fields` endpoint. When no `fieldIds` or `fieldTypes` are provided, the List Entry will be returned without any field data attached. To supply multiple `fieldIds` or `fieldTypes` parameters, generate a query string that looks like this: `?fieldIds=field-1234&fieldIds=affinity-data-location` or `?fieldTypes=enriched&fieldTypes=global`.
Inputs: listId, fieldIds, fieldTypes, listEntryId
Get a single Meeting
Beta Affinity API v2 action. Get a single Meeting. Retrieve detailed information about a specific Meeting you have access to view. Returns meeting details including title, timing, organizer, creator, and attendee information.
Inputs: meetingId
Get a single Note
Affinity API v2 action. Get a single Note. Get a Note with a given id.
Inputs: noteId, includes
Get a single opportunity
Get basic details about an Opportunity without field data via provided endpoints. Field data requires using specific list entry APIs and the "Export data from Lists" permission.
Inputs: id
Get a single person
Retrieve basic details for a person by ID. Requires "Export All People" permission.
Inputs: id, fieldIds, fieldTypes
Get a single Reminder
Beta Affinity API v2 action. Get a single Reminder. Returns a single Reminder. Responds with `404` when the reminder does not exist or is not visible to the caller.
Inputs: reminderId
Get a single Transcript
Affinity API v2 action. Get a single Transcript. Get a transcript with a given id with the first 100 fragments of the transcript. Use the /fragments endpoint to fetch all fragments of the transcript.
Inputs: transcriptId
Get a single User
Beta Affinity API v2 action. Get a single User. Returns information about a single internal User, including name, primary email address, all email addresses, photo URL, account status, and account role. The `userId` path parameter is the same identifier as the User's corresponding Person ID — every internal User has a matching Person record, and they share the same numeric ID. You can use a Person ID returned from any Persons endpoint here, and vice versa. The `emailAddresses` and `role` properties are only returned to callers with the "Manage Users" [permission](/pages/external-api-v2/permissions).
Inputs: userId
Get a suggested field update set
Beta Affinity API v2 action. Get a suggested field update set. The endpoint returns 404 when AI agents access is not enabled for the organization. Retrieve a set of suggested field updates with all of its suggestions. `suggestions` is empty while `status` is `pending`. Returns `404` when the set is not yours or its subject is not accessible to you.
Inputs: suggestedFieldUpdateId
Get a suggested field update task
Beta Affinity API v2 action. Get a suggested field update task. The endpoint returns 404 when AI agents access is not enabled for the organization. Retrieve a suggested field update generation task. On `success`, retrieve the set named by `suggestedFieldUpdate`.
Inputs: taskId
Get Companies attached to a Note
Affinity API v2 action. Get Companies attached to a Note. Returns directly attached companies for a given Note.
Inputs: limit, cursor, noteId, totalCount
Get Company Merge
Affinity API v2 action. Get Company Merge. Retrieve the status and details of a specific company merge. Returns information about the company merge including its current status, the companies involved, timestamps, and any error information if the merge failed. The `mergeId` can be obtained from the response of the [Get All Company Merges](/api-reference/company-merges/get-all-company-merges) endpoint, or by filtering company merges by task ID using `/v2/company-merges?filter=taskId={taskId}` after initiating a merge. Requires the "Manage duplicates" [permission](/pages/external-api-v2/permissions) and organization admin role.
Inputs: mergeId
Get Company Merge Task
Affinity API v2 action. Get Company Merge Task. Retrieve the status and details of a specific task for company merges. Returns information about the company merges for a specific task including its overall status, number of merges in-progress, completed, and failed. Detailed information about individual merges for this task can be found by querying: `/v2/company-merges?filter=taskId={taskId}` See [Company Merges](/api-reference/company-merges/get-all-company-merges) for more details. Task statuses: - `in-progress`: The merge task is currently being processed. - `success`: The merge task completed successfully. - `failed`: The merge task failed. Requires the "Manage duplicates" [permission](/pages/external-api-v2/permissions) and organization admin role.
Inputs: taskId
Get Coworker Inferred Connections
Beta Affinity API v2 action. Get Coworker Inferred Connections. Returns inferred connections based on shared work history, grouped by the target person, strongest first. A connection is the belief that a `source` (a person in your Affinity data, with an `id`, whom you know) might know a `target` (a person not in your Affinity data, described only, whom you want to know), because the two had overlapping employment at a shared company. The same target can be reachable through several people you know. Connections are grouped by target: each item in `data` is one target together with the `connections` to them. Within a target, connections are ordered strongest first; targets are ordered by their strongest connection, strongest first. Each `target` carries the company they work at **today** in `target.currentCompany`: the company at which they are a potential contact now, which is not necessarily the shared employer behind the connection. The `filter` parameter is required and must contain at least one filter.
Inputs: limit, cursor, filter, totalCount
Get current user
Returns metadata about the current user.
Get dropdown options for a Company Field
Affinity API v2 action. Get dropdown options for a Company Field. Returns the dropdown options for a specific dropdown or ranked-dropdown field on a Company. Use the returned dropdown option IDs when writing dropdown field values via the field update endpoints.
Inputs: limit, cursor, fieldId
Get dropdown options for a List Field
Affinity API v2 action. Get dropdown options for a List Field. Returns the dropdown options for a specific dropdown, ranked-dropdown, or status-dropdown field on a List. Use the returned dropdown option IDs when writing dropdown field values via the field update endpoints.
Inputs: limit, cursor, listId, fieldId
Get dropdown options for a Person Field
Affinity API v2 action. Get dropdown options for a Person Field. Returns the dropdown options for a specific dropdown or ranked-dropdown field on a Person. Use the returned dropdown option IDs when writing dropdown field values via the field update endpoints.
Inputs: limit, cursor, fieldId
Get Field Value Changes on a List Entry
Affinity API v2 action. Get Field Value Changes on a List Entry. Paginate through the historical value changes on the fields of a List Entry. For an overview of field value changes, including which fields support change tracking and how the action types behave, see [Field Value Changes](/pages/data-model/working-with-field-data#field-value-changes). Each change includes who made the change, when it occurred, the action that was performed, and the value that was set. Changes are sorted by `changedAt` in ascending order (oldest first). You can filter field value changes using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties.
Inputs: limit, cursor, filter, listId, listEntryId
Get field values on a single Company
Beta Affinity API v2 action. Get field values on a single Company. Paginate through field values on a single company. Enriched, global, and relationship-intelligence fields will be included by default. The `ids` and `types` parameters can be used to filter the collection. These parameters are mutually exclusive. List fields are not returned by this endpoint. To retrieve or update list field values, use the [list entry fields](/api-reference/lists/get-field-values-on-a-single-list-entry) endpoints.
Inputs: ids, limit, types, cursor, companyId
Get field values on a single List Entry
Affinity API v2 action. Get field values on a single List Entry. Paginate through all field values on a single list entry. All fields will be included by default. The `ids` and `types` parameters can be used to filter the collection.
Inputs: ids, limit, types, cursor, listId, listEntryId
Get field values on a single Person
Beta Affinity API v2 action. Get field values on a single Person. Paginate through field values on a single person. Enriched, global, and relationship-intelligence fields will be included by default. The `ids` and `types` parameters can be used to filter the collection. These parameters are mutually exclusive. List fields are not returned by this endpoint. To retrieve or update list field values, use the [list entry fields](/api-reference/lists/get-field-values-on-a-single-list-entry) endpoints.
Inputs: ids, limit, types, cursor, personId
Get fragments of a transcript
Affinity API v2 action. Get fragments of a transcript. Get fragments of a transcript given a transcript id.
Inputs: limit, cursor, totalCount, transcriptId
Get Introduction Paths
Affinity API v2 action. Get Introduction Paths. 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.
Inputs: limit, cursor, filter, totalCount
Get Investor-Executive Inferred Connections
Beta Affinity API v2 action. Get Investor-Executive Inferred Connections. Returns investor-executive inferred connections, grouped by the target person, strongest first. A connection is the belief that a `source` (a person in your Affinity data, with an `id`, whom you know) might know a `target` (a person not in your Affinity data, described only, whom you want to know). In this connection type the source is an investor and the target is an executive: the source invested in a company where the target was an executive. The same target can be reachable through several people you know. Connections are grouped by target: each item in `data` is one target together with the `connections` to them. Within a target, connections are ordered strongest first; targets are ordered by their strongest connection, strongest first.
Inputs: limit, cursor, filter, totalCount
Get metadata on a Company Field
Beta Affinity API v2 action. Get metadata on a Company Field. Returns metadata on a single non-list-specific Company Field. Accepts any Field ID from GET `/v2/companies/fields`, including enriched and native fields. List-specific fields and fields of other entity types return 404.
Inputs: fieldId
Get metadata on a List Field
Beta Affinity API v2 action. Get metadata on a List Field. | This endpoint is currently in BETA | |--| Returns metadata on a single Field on a List.
Inputs: listId, fieldId
Get metadata on all Calls
Affinity API v2 action. Get metadata on all Calls. Paginate through all calls in Affinity. Returns basic information about the call interaction and its participants. Will only return calls that the current authenticated user has permission to see. You can filter calls using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties. | **Property Name** | **Type** | **Allowed Operators** | **Examples** | |---|---|---|---| | `id` | `int64` | `=` | `id=1\|id=2\|id=3` | | `startTime` | `datetime` | `>`, `<`, `>=`, `<=` | `sentAt>2025-01-01T01:00:00Z` | | `createdAt` | `datetime` | `>`, `<`, `>=`, `<=` | `createdAt<2025-01-01T01:00:00Z` | | `updatedAt` | `datetime` | `>`, `<`, `>=`, `<=` | `updatedAt>=2025-01-01T01:00:00Z` |
Inputs: limit, cursor, filter
Get metadata on all Chat Messages
Affinity API v2 action. Get metadata on all Chat Messages. Paginate through all chat messages in Affinity. Returns basic information about the chat message interaction and its participants. Will only return chat messages that the current authenticated user has permission to see. You 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. | **Property Name** | **Type** | **Allowed Operators** | **Examples** | |---|---|---|---| | `id` | `int64` | `=` | `id=1\|id=2\|id=3` | | `sentAt` | `datetime` | `>`, `<`, `>=`, `<=` | `sentAt>2025-01-01T01:00:00Z` | | `createdAt` | `datetime` | `>`, `<`, `>=`, `<=` | `createdAt<2025-01-01T01:00:00Z` | | `updatedAt` | `datetime` | `>`, `<`, `>=`, `<=` | `updatedAt>=2025-01-01T01:00:00Z` |
Inputs: limit, cursor, filter
Get metadata on all Emails
Affinity API v2 action. Get metadata on all Emails. Paginate through all emails in Affinity. Returns basic information about the email interaction and its participants. Will only return emails or subject lines that the current authenticated user has permission to see. Email bodies (the message content) are not available through the API. Only metadata such as the subject, participants, and timestamps is returned. If the authenticated user does not have permission to see an email's subject, the `subject` field is obfuscated and returned as `********` rather than the actual subject line. You can filter emails using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties.
Inputs: limit, cursor, filter
Get metadata on all lists
Returns metadata on Lists.
Inputs: limit, cursor
Get metadata on all Meetings
Affinity API v2 action. Get metadata on all Meetings. Paginate through all Meetings in Affinity. Returns basic information about past and future meeting interactions and its attendees. You can filter meetings using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties. | **Property Name** | **Type** | **Allowed Operators** | **Examples** | |---|---|---|---| | `id` | `int64` | `=` | `id=1\|id=2\|id=3` | | `startTime` | `datetime` | `>`, `<`, `>=`, `<=` | `startTime>2025-01-01T01:00:00Z` | | `createdAt` | `datetime` | `>`, `<`, `>=`, `<=` | `createdAt<2025-01-01T01:00:00Z` | | `updatedAt` | `datetime` | `>`, `<`, `>=`, `<=` | `updatedAt>=2025-01-01T01:00:00Z` |
Inputs: limit, cursor, filter
Get metadata on all Teams
Beta Affinity API v2 action. Get metadata on all Teams. Paginate through all Teams in your organization that you have access to view. Use the `includes` query parameter to add `membersPreview` and `accessibleListsPreview` to each team. Each preview carries a `totalCount` and a short `data` sample; the full collections are available at `GET /v2/teams/{teamId}/members` and `GET /v2/teams/{teamId}/accessible-lists`. The team's `privacyType` is gated and only returned when the caller has the "Manage Teams" [permission](/pages/external-api-v2/permissions), the organization has team-based privacy controls enabled, and cross-team visibility is enabled for the organization; it is omitted from every team in the response otherwise.
Inputs: limit, cursor, filter, orderBy, includes, totalCount
Get metadata on a Person Field
Beta Affinity API v2 action. Get metadata on a Person Field. Returns metadata on a single non-list-specific Person Field. Accepts any Field ID from GET `/v2/persons/fields`, including enriched and native fields. List-specific fields and fields of other entity types return 404.
Inputs: fieldId
Get metadata on a single list
Returns metadata on a single List.
Inputs: listId
Get metadata on a single list s fields
Returns metadata on the Fields available on a single List. Use the returned Field IDs to request field data from the GET `/v2/lists/{listId}/list-entries` endpoint.
Inputs: limit, cursor, listId
Get metadata on a single saved view
Returns metadata on a single Saved View.
Inputs: listId, viewId
Get metadata on a single Team
Beta Affinity API v2 action. Get metadata on a single Team. Retrieve detailed information about a specific Team. Optional opt-in properties can be requested via the `includes` query parameter.
Inputs: teamId, includes
Get metadata on company fields
Returns metadata on non-list-specific Company Fields. Use the returned Field IDs to request field data from the GET `/v2/companies` and GET `/v2/companies/{id}` endpoints.
Inputs: limit, cursor
Get metadata on person fields
Returns metadata on non-list-specific Person Fields. Use the returned Field IDs to request field data from the GET `/v2/persons` and GET `/v2/persons/{id}` endpoints.
Inputs: limit, cursor
Get metadata on saved views
Returns metadata on the Saved Views on a List.
Inputs: limit, cursor, listId
Get Notes for a Company
Affinity API v2 action. Get Notes for a Company. Returns relevant notes for a given company which includes directly attached notes and notes attached to persons on this company. You can filter notes using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties. | **Property Name** | **Type** | **Allowed Operators** | **Examples** | |---|---|---|---| | `creator.id` | `int32` | `=` | `creator.id=1` | | `createdAt` | `datetime` | `>`, `<`, `>=`, `<=` | `createdAt<2025-02-04T10:48:24Z` | | `updatedAt` | `datetime` | `>`, `<`, `>=`, `<=` | `updatedAt>=2025-02-03T10:48:24Z` |
Inputs: limit, cursor, filter, companyId, totalCount
Get Notes for an Opportunity
Affinity API v2 action. Get Notes for an Opportunity. Returns Notes for a given Opportunity which includes directly attached notes and those attached to persons on this Opportunity. You can filter notes using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties. | **Property Name** | **Type** | **Allowed Operators** | **Examples** | |---|---|---|---| | `creator.id` | `int32` | `=` | `creator.id=1` | | `createdAt` | `datetime` | `>`, `<`, `>=`, `<=` | `createdAt<2025-02-04T10:48:24Z` | | `updatedAt` | `datetime` | `>`, `<`, `>=`, `<=` | `updatedAt>=2025-02-03T10:48:24Z` |
Inputs: limit, cursor, filter, totalCount, opportunityId
Get Notes for a Person
Affinity API v2 action. Get Notes for a Person. Returns notes for a given person id which includes directly attached notes, notes on meetings this person attended, and notes where this person is mentioned. You can filter notes using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties. | **Property Name** | **Type** | **Allowed Operators** | **Examples** | |---|---|---|---| | `creator.id` | `int32` | `=` | `creator.id=1` | | `createdAt` | `datetime` | `>`, `<`, `>=`, `<=` | `createdAt<2025-02-04T10:48:24Z` | | `updatedAt` | `datetime` | `>`, `<`, `>=`, `<=` | `updatedAt>=2025-02-03T10:48:24Z` |
Inputs: limit, cursor, filter, personId, totalCount
Get Opportunities attached to a Note
Affinity API v2 action. Get Opportunities attached to a Note. Returns directly attached opportunities for a given Note.
Inputs: limit, cursor, noteId, totalCount
Get Person Merge
Affinity API v2 action. Get Person Merge. Retrieve the status and details of a specific person merge. Returns information about the person merge including its current status, the persons involved, timestamps, and any error information if the merge failed. The `mergeId` can be obtained from the response of the [Get All Person Merges](/api-reference/person-merges/get-all-person-merges) endpoint, or by filtering person merges by task ID using `/v2/person-merges?filter=taskId={taskId}` after initiating a merge. Requires the "Manage duplicates" [permission](/pages/external-api-v2/permissions) and organization admin role.
Inputs: mergeId
Get Person Merge Task
Affinity API v2 action. Get Person Merge Task. Retrieve the status and details of a specific task for person merges. Returns information about the person merges for a specific task including its overall status, number of merges in-progress, completed, and failed. Detailed information about individual merges for this task can be found by querying: `/v2/person-merges?filter=taskId={taskId}` See [Person Merges](/api-reference/person-merges/get-all-person-merges) for more details. Task statuses: - `in-progress`: The merge task is currently being processed. - `success`: The merge task completed successfully. - `failed`: The merge task failed. Requires the "Manage duplicates" [permission](/pages/external-api-v2/permissions) and organization admin role.
Inputs: taskId
Get Persons attached to a Note
Affinity API v2 action. Get Persons attached to a Note. Returns directly attached persons for a given Note.
Inputs: limit, cursor, noteId, totalCount
Get rate limit usage
Beta Affinity API v2 action. Get rate limit usage. Returns the current rate limit usage for the authenticated caller. `orgPerMonth` is included only for callers that have a monthly quota; it is absent for callers that don't have one.
Get Relationships for a Company
Affinity API v2 action. Get Relationships for a Company. Returns the relationships for a given company, including the interaction score that measures the strength of each relationship based on communication patterns such as emails, meetings, and other interactions. Each relationship includes two persons (person1 and person2) who have a connection related to this company.
Inputs: limit, cursor, filter, orderBy, companyId, totalCount
Get Relationships for a Person
Affinity API v2 action. Get Relationships for a Person. Returns the relationships for a given person, including the interaction score that measures the strength of each relationship based on communication patterns such as emails, meetings, and other interactions. Each relationship includes two persons (person1 and person2) who have a connection.
Inputs: limit, cursor, filter, orderBy, personId, totalCount
Get replies for a Note
Affinity API v2 action. Get replies for a Note. This endpoint returns reply notes for a given note id. You can filter replies using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties. | **Property Name** | **Type** | **Allowed Operators** | **Examples** | |---|---|---|---| | `creator.id` | `int32` | `=` | `creator.id=1` | | `createdAt` | `datetime` | `>`, `<`, `>=`, `<=` | `createdAt<2025-02-04T10:48:24Z` | | `updatedAt` | `datetime` | `>`, `<`, `>=`, `<=` | `updatedAt>=2025-02-03T10:48:24Z` |
Inputs: limit, cursor, filter, noteId, totalCount
Get values for a single field on a Company
Beta Affinity API v2 action. Get values for a single field on a Company. Paginate through all values for a field on a company.
Inputs: limit, cursor, fieldId, companyId
Get values for a single field on a List Entry
Beta Affinity API v2 action. Get values for a single field on a List Entry. Paginate through all values for a field on a list entry.
Inputs: limit, cursor, listId, fieldId, listEntryId
Get values for a single field on a Person
Beta Affinity API v2 action. Get values for a single field on a Person. Paginate through all values for a field on a person.
Inputs: limit, cursor, fieldId, personId
Initiate Company Merge
Affinity API v2 action. Initiate Company Merge. Initiate a company merge to combine a duplicate company profile into a primary company profile. This is an asynchronous process that will merge all data from the duplicate company into the primary company. Once the merge is initiated, you can track its progress using the returned task URL. Requires the "Manage duplicates" [permission](/pages/external-api-v2/permissions) and organization admin role.
Inputs: body
Initiate Person Merge
Affinity API v2 action. Initiate Person Merge. Initiate a person merge to combine a duplicate person profile into a primary person profile. This is an asynchronous process that will merge all data from the duplicate person into the primary person. Once the merge is initiated, you can track its progress using the returned task URL. Requires the "Manage duplicates" [permission](/pages/external-api-v2/permissions) and organization admin role.
Inputs: body
Perform batch operations on a company's fields
Affinity API v2 action. Perform batch operations on a company's fields. Perform batch operations on a company's fields. Currently the only operation at the endpoint is `update-fields`, which allows you to update multiple field values with a single request. This is equivalent to calling [the single field update](/api-reference/companies/update-a-single-field-value-on-a-company) endpoint multiple times. You can update up to 100 fields per request.
Inputs: body, companyId
Perform batch operations on a list entry's fields
Affinity API v2 action. Perform batch operations on a list entry's fields. Perform batch operations on a list entry's fields. Currently the only operation at the endpoint is `update-fields`, which allows you to update multiple field values with a single request. This is equivalent to calling [the single field update](/api-reference/lists/update-a-single-field-value-on-a-list-entry) endpoint multiple times. You can update up to 100 fields per request. Requires the "Export data from Lists" [permission](/pages/external-api-v2/permissions).
Inputs: body, listId, listEntryId
Perform batch operations on a person's fields
Affinity API v2 action. Perform batch operations on a person's fields. Perform batch operations on a person's fields. Currently the only operation at the endpoint is `update-fields`, which allows you to update multiple field values with a single request. This is equivalent to calling [the single field update](/api-reference/persons/update-a-single-field-value-on-a-person) endpoint multiple times. You can update up to 100 fields per request.
Inputs: body, personId
Perform batch operations on suggestions in a set
Beta Affinity API v2 action. Perform batch operations on suggestions in a set. The endpoint returns 404 when AI agents access is not enabled for the organization. Accept or reject suggestions in a set. Accepted values are written to the CRM. - `apply-suggested-field-updates`: decide every `pending` suggestion. `acceptedValue` overrides the suggested value. - `dismiss`: reject all `pending` suggestions. Writes are not atomic: one suggestion failing does not stop the others. A `failed` outcome carries a `failureReason`. The set is `done` after either operation. Returns `400`, writing nothing, when the set is not `open`, a `pending` suggestion has no decision, or a decision names an unknown, duplicate, or decided suggestion, pairs `acceptedValue` with `rejected`, or has an `acceptedValue` type that does not match the field.
Inputs: body, suggestedFieldUpdateId
Search Companies
Beta Affinity API v2 action. Search Companies. Search for Companies matching the given criteria. Accepts an optional combination of filters, sorts, and a search term. Omitting the body is equivalent to `GET /v2/companies` with default pagination. Requires the "Export All Organizations directory" [permission](/pages/external-api-v2/permissions).
Inputs: body, limit, cursor, fieldIds, fieldTypes, totalCount
Search Files by Keyword
Affinity API v2 action. Search Files by Keyword. Search files by keyword. The scope of the search is controlled by the request body: - Provide `fileIds` to limit the search to specific files. - Provide `companyId` to limit the search to files associated with a specific company. - Omit both to search across your entire account. `fileIds` and `companyId` are mutually exclusive. Returns up to `limit` files ordered by relevance. Prompts with no strong matches may still return low-relevance results. Each result contains a matched file and a single representative excerpt (a matching passage from that file). Even if a file contains multiple matching passages, it appears exactly once in the response with one excerpt.
Inputs: body
Search List Entries
Beta Affinity API v2 action. Search List Entries. Search for List Entries on a List matching the given criteria. Accepts an optional combination of filters, sorts, and a search term. All fields in the request body are optional. Omitting the body entirely is equivalent to `GET /v2/lists/{listId}/list-entries` with default pagination. Requires the "Export data from Lists" [permission](/pages/external-api-v2/permissions).
Inputs: body, limit, cursor, listId, fieldIds, fieldTypes, totalCount
Search Notes by Keyword
Affinity API v2 action. Search Notes by Keyword. Search notes by keyword. The scope of the search is controlled by the request body: - Provide `noteIds` to limit the search to specific notes. - Provide `companyId` to limit the search to notes associated with a specific company. - Omit both to search across your entire account. `noteIds` and `companyId` are mutually exclusive. Returns up to `limit` notes ordered by relevance. Prompts with no strong matches may still return low-relevance results. Each result contains a matched note and a single representative excerpt (a matching passage from that note). Even if a note contains multiple matching passages, it appears exactly once in the response with one excerpt.
Inputs: body
Search Persons
Beta Affinity API v2 action. Search Persons. Search for Persons matching the given criteria. Accepts an optional combination of filters, sorts, and a search term. Omitting the body is equivalent to `GET /v2/persons` with default pagination. Requires the "Export All People directory" [permission](/pages/external-api-v2/permissions).
Inputs: body, limit, cursor, fieldIds, fieldTypes, totalCount
Semantic Search
Affinity API v2 action. Semantic Search. Perform an AI-powered semantic search. Use the `entityType` field in the request body to specify which entity type to search. Currently only supports companies. The `prompt` field accepts natural language describing the companies to find.
Inputs: body
Send Feedback
Affinity API v2 action. Send Feedback. Send feedback to Affinity about a particular product area or feature.
Inputs: body
Update a Company Field
Beta Affinity API v2 action. Update a Company Field. Updates a Company Field. Only the provided properties are updated. Requires the Manage global fields permission. Accepts the Field ID of a custom field (`field-<number>`), of an enriched field (for example, `affinity-data-location`), or of a native field (for example, `source-of-introduction`). An enriched or native field by its `field-<number>` ID returns 404. A field from a restricted data partner (see Partner Data Restrictions) returns 404. On native and enriched fields, only `isRequired` can be updated. Fields that are computed by Affinity, such as `first-email`, return 404.
Inputs: body, fieldId
Update a dropdown option for a List Field
Affinity API v2 action. Update a dropdown option for a List Field. Update a dropdown option for a List Field.
Inputs: body, listId, fieldId, dropdownOptionId
Update a List Field
Beta Affinity API v2 action. Update a List Field. | This endpoint is currently in BETA | |--| Updates a list-specific Field on a List. Only the provided properties are updated. Requires the Standard role or higher on the List. Updating the List's Status or Owners field, or changing `isRequired`, requires the Admin role on the List.
Inputs: body, listId, fieldId
Update an Opportunity
Beta Affinity API v2 action. Update an Opportunity. | This endpoint is currently in BETA | |--| Updates an Opportunity. Only provided properties are updated; properties omitted from the request keep their current value. Requires manage access to the opportunity.
Inputs: body, opportunityId
Update a Person
Beta Affinity API v2 action. Update a Person. Updates a Person. Only properties included in the request body are changed; any property omitted from the request body is left alone. Likewise, only field-value entries listed in `fields` are updated. Any field not included in `fields` keeps its current value.
Inputs: body, personId
Update a Person Field
Beta Affinity API v2 action. Update a Person Field. Updates a Person Field. Only the provided properties are updated. Requires the Manage global fields permission. Accepts the Field ID of a custom field (`field-<number>`), of an enriched field (for example, `affinity-data-current-job-title`), or of a native field (for example, `source-of-introduction`). An enriched or native field by its `field-<number>` ID returns 404. On native and enriched fields, only `isRequired` can be updated. Fields that are computed by Affinity, such as `first-email`, return 404.
Inputs: body, fieldId
Update a Reminder
Beta Affinity API v2 action. Update a Reminder. Updates a Reminder. Only provided fields are changed; omitted fields keep their current value. Setting `completedAt` marks the reminder complete (for `recurring` reminders, this advances `dueDate` by `recurrence.periodDays` and `completedAt` remains `null` on the resource). Setting `completedAt` to `null` marks the reminder incomplete and is rejected for `recurring` reminders. Only the reminder's creator or owner may update it (including completing or uncompleting it).
Inputs: body, reminderId
Update a single field value on a Company
Affinity API v2 action. Update a single field value on a Company. Update a single field value on a company. To clear the value, send `null` as `data`; a required field cannot be cleared. For a multi-value field, `data` replaces all current values: to remove one value, send the values to keep.
Inputs: body, fieldId, companyId
Update a single field value on a List Entry
Affinity API v2 action. Update a single field value on a List Entry. Update a single field value. To clear the value, send `null` as `data`; a required field cannot be cleared. For a multi-value field, `data` replaces all current values: to remove one value, send the values to keep. Requires the "Export data from Lists" [permission](/pages/external-api-v2/permissions).
Inputs: body, listId, fieldId, listEntryId
Update a single field value on a Person
Affinity API v2 action. Update a single field value on a Person. Update a single field value on a person. To clear the value, send `null` as `data`; a required field cannot be cleared. For a multi-value field, `data` replaces all current values: to remove one value, send the values to keep.
Inputs: body, fieldId, personId
Update a single Note
Affinity API v2 action. Update a single Note. Make an update to an existing note's body content or its entity associations. You can only update notes you have write access to. You can update any type of note including AI Notetaker notes (`ai-notetaker`, `ai-notetaker-reply`), but a note's type itself cannot be changed. All body properties are optional: only the properties supplied are updated, and other properties are left unchanged. For each of `persons`, `companies`, and `opportunities`, you may: - omit the field to leave existing associations unchanged - send an empty array (`[]`) to clear all associations of that kind - send a non-empty array to replace the existing set with the supplied list. Reply notes (`user-reply`, `ai-notetaker-reply`) have no entity associations, so only `content` can be updated for replies. Updating `content` is subject to the same HTML restrictions as creation; submitting restricted HTML will cause the request to fail. See the request examples below.
Inputs: body, noteId