> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Affinity

> How to set up the Affinity connector, plus the actions that are available.

![Affinity](https://stackone-logos.com/api/affinity/filled/svg)

Betav2.0.1[See changelog](https://docs.stackone.com/connectors/affinity/changelog.md)

[140 actions](#actions) · 2 auth methods

CRM
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/affinity/guides/connector-profile/api-key.md)
>
> No app registration required. The key acts as the user who created it and inherits their Affinity permissions.

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/affinity/guides/connector-profile/oauth-2-0.md)
>
> Requires an admin to create a Confidential OAuth app in your own Affinity organization (early access). Access tokens las...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/affinity/guides/link-account/api-key.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/affinity/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

OAuth 2.0

No auth methods found

Scopes

Select all
|
Clear

api

api.read

No scopes found

140 actions

ActionDescriptionRequired scopes

Get Field Values On A Single Company`affinity_get_company_field_values`

List field values on one company

`api.read`

Get Metadata On Company Fields`affinity_get_company_fields`

List non-list-specific company field metadata

`api.read`

Get Values For A Single Field On A Company`affinity_get_company_field_values_for_field`

List all values of one field on one company, paginated

`api.read`

Get Dropdown Options For A Company Field`affinity_get_company_field_dropdown_options`

List dropdown options for a company dropdown or ranked-dropdown field

`api.read`

Get A Single Field Value On A Company`affinity_get_company_field_value`

Fetch one field value on a company

`api.read`

Perform Batch Operations On A Company's Fields`affinity_batch_update_company_field_values`

Update up to 100 field values on a company in one request

`api`

Update A Single Field Value On A Company`affinity_update_company_field_value`

Set or clear a single field value on a company

`api`

Get All Field Value Changes`affinity_get_field_value_changes`

List field value changes across all entities and fields (delta-sync feed, ascending changedAt)

`api.read`

Get Field Values`affinity_get_field_values`

List all field values for one person, organization, opportunity or list entry

`api.read`

Create A New Field Value`affinity_create_field_value`

Create a field value on a person, organization or opportunity

`api`

Update A Field Value`affinity_update_field_value`

Update the value of an existing field value

`api`

Delete A Field Value`affinity_delete_field_value`

Delete a field value by ID

`api`

List Fields`affinity_get_fields`

Retrieve field metadata definitions available in Affinity

`api.read`

Create Field`affinity_create_field`

Create a new field (custom column) on a list or globally

`api`

Delete A Field`affinity_delete_field`

Delete a field by ID

`api`

Get All Files`affinity_get_files`

List file metadata (id, name, size, type, creator, timestamps) for files visible to the caller, newest first

`api.read`

Search Files By Keyword`affinity_search_files`

Keyword search over file contents, returning one best-matching excerpt per file

`api.read`

Get A Single File`affinity_get_file`

Get one file's metadata plus a temporary signed downloadUrl

`api.read`

Download File`affinity_download_entity_file`

Download the binary content of an entity file by ID

`api.read`

Upload Files`affinity_upload_entity_files`

Upload a file and attach it to a person, organization or opportunity

`api`

Get Unified Credentials`affinity_unified_get_me`

Get the current Affinity connection's unified credentials and identity.

`api.read`

List Unified Organizations`affinity_unified_list_organizations`

List unified organizations in Affinity.

`api.read`

Get Unified Organization`affinity_unified_get_organization`

Get a unified Affinity organization by ID.

`api.read`

List Unified Resource Types`affinity_unified_list_resource_types`

List unified resource types in Affinity.

`api.read`

List Unified Resource Users`affinity_unified_list_resource_users`

List unified resource users in Affinity.

`api.read`

List Unified Roles`affinity_unified_list_roles`

List unified roles in Affinity, derived from account roles observed on API v2 users.

`api.read`

Get Unified Role`affinity_unified_get_role`

Get a unified Affinity role by ID.

`api.read`

List Unified Users`affinity_unified_list_users`

List unified users in Affinity, scoped to internal team members.

`api.read`

Get Unified User`affinity_unified_get_user`

Get a unified Affinity user by ID.

`api.read`

Get Metadata On All Calls`affinity_get_calls`

List call interactions with participants

`api.read`

Get Metadata On All Chat Messages`affinity_get_chat_messages`

List chat message interactions with participants

`api.read`

Get Metadata On All Emails`affinity_get_emails`

List email interaction metadata (subject, participants, timestamps)

`api.read`

Get Metadata On All Meetings`affinity_get_meetings`

List meeting interactions (past and future) with attendees

`api.read`

List Interactions`affinity_get_interactions`

Retrieve interactions (emails, meetings, etc.) associated with a person, organization, or opportunity

`api.read`

Get A Single Meeting`affinity_get_meeting`

Get one meeting by ID

`api.read`

Get A Specific Interaction`affinity_get_interaction`

Get one v1 interaction by id and type

`api.read`

Create A New Interaction`affinity_create_interaction`

Create a manually logged meeting, call or chat message

`api`

Update An Interaction`affinity_update_interaction`

Update content/date/persons of a manually logged interaction

`api`

Delete An Interaction`affinity_delete_interaction`

Delete an interaction by id and type

`api`

Get All List Entries On A List`affinity_get_list_entries`

Page through all List Entries (rows) on a List, optionally with field data

`api.read`

Search List Entries`affinity_search_list_entries`

Search list entries with filters, sorts and a keyword

`api.read`

Get Field Value Changes On A List Entry`affinity_get_list_entry_field_value_changes`

Page through the change history of field values on a List Entry (oldest first)

`api.read`

Get Field Values On A Single List Entry`affinity_get_list_entry_field_values`

List field values on a single List Entry

`api.read`

Get A Single List Entry On A List`affinity_get_list_entry`

Fetch one List Entry by id with optional field data

`api.read`

Get A Single Field Value`affinity_get_list_entry_field_value`

Get one field value on a List Entry

`api.read`

Add A List Entry To A List`affinity_add_list_entry`

Add an existing Company or Person to a List as a new List Entry (BETA)

`api`

Perform Batch Operations On A List Entry's Fields`affinity_batch_update_list_entry_field_values`

Update up to 100 field values on a List Entry in one request

`api`

Update A Single Field Value On A List Entry`affinity_update_list_entry_field_value`

Set or clear a single field value on a List Entry

`api`

Delete A Specific List Entry`affinity_delete_list_entry`

Delete a List Entry from a List (v1 API)

`api`

Get Metadata On All Lists`affinity_get_lists`

Page through all Lists the caller can view

`api.read`

Get Metadata On A Single List's Fields`affinity_get_list_fields`

List metadata for all fields on one list

`api.read`

Get Dropdown Options For A List Field`affinity_get_list_field_dropdown_options`

List dropdown options for a dropdown-type list field

`api.read`

Get Values For A Single Field On A List Entry`affinity_get_list_entry_field_values_for_field`

Page through all values of one field on a list entry

`api.read`

Get Metadata On Saved Views`affinity_get_saved_views`

Page through all Saved Views of a List

`api.read`

Get All List Entries On A Saved View`affinity_get_saved_view_list_entries`

Page through the rows of a sheet-type Saved View, returning only the columns and filters configured on that view

`api.read`

Get Metadata On A Single List`affinity_get_list`

Fetch metadata for a single List by ID

`api.read`

Get A Dropdown Option For A List Field`affinity_get_list_field_dropdown_option`

Fetch one dropdown option of a list field by ID

`api.read`

Get Metadata On A Single Saved View`affinity_get_saved_view`

Fetch one Saved View (id, name, type sheet/board/dashboard, createdAt)

`api.read`

Create A List`affinity_create_list`

Create a new List of companies, persons, or opportunities

`api`

Create A Dropdown Option For A List Field`affinity_create_list_field_dropdown_option`

Create a new dropdown option on a dropdown, ranked-dropdown or status-dropdown list field

`api`

Update A Dropdown Option For A List Field`affinity_update_list_field_dropdown_option`

Update text, rank, color, statusCategory or winRate of an existing dropdown option

`api`

Delete A Dropdown Option For A List Field`affinity_delete_list_field_dropdown_option`

Permanently delete a dropdown option from a list field

`api`

Get All Company Merges`affinity_get_company_merges`

List company merges for the organization, newest first

`api.read`

Get All Person Merges`affinity_get_person_merges`

List person merges with status, filterable by status or taskId

`api.read`

Get All Company Merge Tasks`affinity_get_company_merge_tasks`

List company merge tasks (batch merge operations) with status and per-task result counts

`api.read`

Get All Person Merge Tasks`affinity_get_person_merge_tasks`

List person merge tasks (batch merge operations) with status and per-task result counts

`api.read`

Get All Company Duplicate Suggestions`affinity_get_company_duplicate_suggestions`

List company duplicate merge suggestions (BETA)

`api.read`

Get All Person Duplicate Suggestions`affinity_get_person_duplicate_suggestions`

List person duplicate merge suggestions (BETA)

`api.read`

Get Company Merge`affinity_get_company_merge`

Get status and details of one company merge by mergeId

`api.read`

Get Person Merge`affinity_get_person_merge`

Get status and details (persons involved, timestamps, error info) of one person merge

`api.read`

Get Company Merge Task`affinity_get_company_merge_task`

Get status and result counts of one company merge task

`api.read`

Get Person Merge Task`affinity_get_person_merge_task`

Get status and result counts of one person merge task

`api.read`

Initiate Company Merge`affinity_initiate_company_merge`

Start an asynchronous merge of a duplicate company into a primary company

`api`

Initiate Person Merge`affinity_initiate_person_merge`

Start an asynchronous merge of a duplicate person into a primary person

`api`

Get All Notes`affinity_get_notes`

List all root notes (replies excluded) with optional filtering and cursor pagination

`api.read`

Search Notes By Keyword`affinity_search_notes`

Keyword-search notes, returning one note (id, kind) plus a matching preview passage per result, ordered by relevance

`api.read`

Get Companies Attached To A Note`affinity_get_note_attached_companies`

List the companies directly attached to a Note

`api.read`

Get Opportunities Attached To A Note`affinity_get_note_attached_opportunities`

List the opportunities directly attached to a Note

`api.read`

Get Persons Attached To A Note`affinity_get_note_attached_persons`

List the persons directly attached to a Note

`api.read`

Get Replies For A Note`affinity_get_note_replies`

List reply notes of a given Note, optionally filtered

`api.read`

Get A Single Note`affinity_get_note`

Fetch one note by ID, including content, creator, mentions and timestamps

`api.read`

Create A Note`affinity_create_note`

Create a note attached to persons/companies/opportunities, anchored to a meeting/call/chat message, or as a reply to a r...

`api`

Update A Single Note`affinity_update_note`

Update a note's HTML content and/or replace its person/company/opportunity associations

`api`

Delete A Single Note`affinity_delete_note`

Permanently delete a note you created

`api`

Get All Opportunities`affinity_get_opportunities`

List opportunities with cursor pagination

`api.read`

Get Notes For An Opportunity`affinity_get_opportunity_notes`

List notes for one opportunity, including notes attached directly and those attached to persons on it, with filtering an...

`api.read`

Get A Single Opportunity`affinity_get_opportunity`

Fetch a single opportunity by ID

`api.read`

Create A New Opportunity`affinity_create_opportunity`

Create a new opportunity on an opportunity-type list

`api`

Update An Opportunity`affinity_update_opportunity`

Partially update an opportunity (currently only its name)

`api`

Delete An Opportunity`affinity_delete_opportunity`

Delete an opportunity by ID

`api`

Get All Companies`affinity_get_companies`

List companies with cursor pagination

`api.read`

Search Companies`affinity_search_companies`

Search companies with filters, sorts and a keyword term, returning cursor-paginated Company records

`api.read`

Get A Company's List Entries`affinity_get_company_list_entries`

List the list entries (rows) of one company across all lists, with list-specific field data and creation metadata

`api.read`

Get A Company's Lists`affinity_get_company_lists`

List all lists the given company appears in (basic list info only) that the caller can view

`api.read`

Get Notes For A Company`affinity_get_company_notes`

List notes for a company, including notes attached directly and notes attached to persons on the company

`api.read`

Get Relationships For A Company`affinity_get_company_relationships`

List person-to-person relationships related to a company with interaction scores (0.0-1.0) and LinkedIn connection dates

`api.read`

Get A Single Company`affinity_get_company`

Fetch a single company by ID with optional field data

`api.read`

Create A New Organization`affinity_create_organization`

Create a new organization (company) in Affinity

`api`

Update An Organization`affinity_update_organization`

Update an organization's name, domain or associated persons

`api`

Delete An Organization`affinity_delete_organization`

Delete an organization

`api`

Get Field Values On A Single Person`affinity_get_person_field_values`

Paginate field values on one Person (enriched, global, relationship-intelligence by default)

`api.read`

Get Metadata On Person Fields`affinity_get_person_fields`

List metadata for non-list-specific Person fields (IDs, names, types)

`api.read`

Get Values For A Single Field On A Person`affinity_get_person_field_values_for_field`

Paginate all values of a single field on one Person (multi-value fields return many)

`api.read`

Get Dropdown Options For A Person Field`affinity_get_person_field_dropdown_options`

List dropdown options for a Person dropdown or ranked-dropdown field

`api.read`

Get A Single Field On A Person`affinity_get_person_field_value`

Fetch one non-list field and its value on a Person

`api.read`

Perform Batch Operations On A Person's Fields`affinity_batch_update_person_field_values`

Update up to 100 person field values in one request via the update-fields operation

`api`

Update A Single Field Value On A Person`affinity_update_person_field_value`

Set or clear one non-list field value on a Person

`api`

Get All Persons`affinity_get_persons`

List all Persons with cursor pagination, optionally filtered by IDs and with field data attached

`api.read`

Search Persons`affinity_search_persons`

Search Persons with nested filters, sorts and a keyword

`api.read`

Get A Person's List Entries`affinity_get_person_list_entries`

List a Person's List Entries across all Lists with list-specific field data

`api.read`

Get A Person's Lists`affinity_get_person_lists`

List the Lists that contain a given Person

`api.read`

Get Notes For A Person`affinity_get_person_notes`

List notes related to a Person (attached, from attended meetings, or mentioning them), with optional filtering

`api.read`

Get Relationships For A Person`affinity_get_person_relationships`

List a Person's relationships with interaction scores (0.0-1.0) and LinkedIn connection dates

`api.read`

Get A Single Person`affinity_get_person`

Fetch a single Person by ID, optionally with field data

`api.read`

Create A Person`affinity_create_person`

Create a new Person

`api`

Update A Person`affinity_update_person`

Update a person (v1 API) - only supplied attributes change

`api`

Delete A Person`affinity_delete_person`

Delete a Person by ID

`api`

List Introduction Paths`affinity_get_introduction_paths`

List ranked introduction paths (BETA) from internal people to a target person or any person at a target company

`api.read`

Get Coworker Inferred Connections`affinity_get_coworker_inferred_connections`

List inferred coworker connections (source in your data may know a target via overlapping employment at a shared company...

`api.read`

Get Investor-Executive Inferred Connections`affinity_get_investor_executive_inferred_connections`

List inferred investor-executive connections (source invested in a company where the target was an executive), grouped b...

`api.read`

Semantic Search`affinity_semantic_search`

Natural-language semantic search over companies, returning matches with relevance scores

`api.read`

Get Relationship Strengths`affinity_get_relationship_strengths`

Get relationship strengths between internal people and a given external person

`api.read`

Get All Reminders`affinity_get_reminders`

List reminders visible to the caller with filter and cursor pagination

`api.read`

Get A Single Reminder`affinity_get_reminder`

Fetch one reminder by ID

`api.read`

Create A Reminder`affinity_create_reminder`

Create a one-time or recurring reminder tied to one company, person, or opportunity

`api`

Update A Reminder`affinity_update_reminder`

Partially update a reminder (content, dueDate, owner, completion, recurrence)

`api`

Delete A Reminder`affinity_delete_reminder`

Delete a reminder by ID

`api`

Get Metadata On All Teams`affinity_get_teams`

List all Teams visible to the caller

`api.read`

Get All Lists A Team Has Access To`affinity_get_team_accessible_lists`

List all Lists a Team can access (id, name, creatorId, ownerId, isPublic, type, createdAt)

`api.read`

Get All Members Of A Team`affinity_get_team_members`

List all members of a Team (membership id, user, addedAt, optional privacyType)

`api.read`

Get Metadata On A Single Team`affinity_get_team`

Get one Team by id

`api.read`

Get All Transcripts`affinity_get_transcripts`

List transcripts (metadata only) visible to the caller

`api.read`

Get Fragments Of A Transcript`affinity_get_transcript_fragments`

List all fragments of one transcript, paginated

`api.read`

Get A Single Transcript`affinity_get_transcript`

Fetch one transcript with its first 100 fragments

`api.read`

Delete A Single Transcript`affinity_delete_transcript`

Delete a transcript (BETA)

`api`

Get All Users`affinity_get_users`

List internal users in the Affinity organization

`api.read`

Get A Single User`affinity_get_user`

Fetch a single internal user by ID

`api.read`

Get Current User`affinity_get_current_user`

Return the authenticated user, tenant, and grant (type and scopes) for the current credential

`api.read`

Get Rate Limit Usage`affinity_get_rate_limit_usage`

Get current rate limit usage (per-minute and, if applicable, monthly) for the authenticated caller

`api.read`

Send Feedback`affinity_send_feedback`

Send feedback to Affinity about a product area or feature

`api`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.