Getting Started
1
Create or Select a Project
Set up a new project or select an existing one. See Organizations & Projects.
2
Configure the Connector
Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.

API Key · Connector Profile
No app registration required. The key acts as the user who created it and inherits their Affinity permissions.
OAuth 2.0 · Connector Profile
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 (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

API Key · Link Account
OAuth 2.0 · Link Account
4
Use Actions
Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.
Actions
|
No auth methods found
|
No scopes found
140 actions
Action
Description
Required scopes
Get Field Values On A Single Company
List field values on one company
Get Metadata On Company Fields
List non-list-specific company field metadata
Get Values For A Single Field On A Company
List all values of one field on one company, paginated
Get Dropdown Options For A Company Field
List dropdown options for a company dropdown or ranked-dropdown field
Get A Single Field Value On A Company
Fetch one field value on a company
Perform Batch Operations On A Company’s Fields
Update up to 100 field values on a company in one request
Update A Single Field Value On A Company
Set or clear a single field value on a company
Get All Field Value Changes
List field value changes across all entities and fields (delta-sync feed, ascending changedAt)
Get Field Values
List all field values for one person, organization, opportunity or list entry
Create A New Field Value
Create a field value on a person, organization or opportunity
Update A Field Value
Update the value of an existing field value
Delete A Field Value
Delete a field value by ID
List Fields
Retrieve field metadata definitions available in Affinity
Create Field
Create a new field (custom column) on a list or globally
Delete A Field
Delete a field by ID
Get All Files
List file metadata (id, name, size, type, creator, timestamps) for files visible to the caller, newest first
Search Files By Keyword
Keyword search over file contents, returning one best-matching excerpt per file
Get A Single File
Get one file’s metadata plus a temporary signed downloadUrl
Download File
Download the binary content of an entity file by ID
Upload Files
Upload a file and attach it to a person, organization or opportunity
Get Unified Credentials
Get the current Affinity connection’s unified credentials and identity.
List Unified Organizations
List unified organizations in Affinity.
Get Unified Organization
Get a unified Affinity organization by ID.
List Unified Resource Types
List unified resource types in Affinity.
List Unified Resource Users
List unified resource users in Affinity.
List Unified Roles
List unified roles in Affinity, derived from account roles observed on API v2 users.
Get Unified Role
Get a unified Affinity role by ID.
List Unified Users
List unified users in Affinity, scoped to internal team members.
Get Unified User
Get a unified Affinity user by ID.
Get Metadata On All Calls
List call interactions with participants
Get Metadata On All Chat Messages
List chat message interactions with participants
Get Metadata On All Emails
List email interaction metadata (subject, participants, timestamps)
Get Metadata On All Meetings
List meeting interactions (past and future) with attendees
List Interactions
Retrieve interactions (emails, meetings, etc.) associated with a person, organization, or opportunity
Get A Single Meeting
Get one meeting by ID
Get A Specific Interaction
Get one v1 interaction by id and type
Create A New Interaction
Create a manually logged meeting, call or chat message
Update An Interaction
Update content/date/persons of a manually logged interaction
Delete An Interaction
Delete an interaction by id and type
Get All List Entries On A List
Page through all List Entries (rows) on a List, optionally with field data
Search List Entries
Search list entries with filters, sorts and a keyword
Get Field Value Changes On A List Entry
Page through the change history of field values on a List Entry (oldest first)
Get Field Values On A Single List Entry
List field values on a single List Entry
Get A Single List Entry On A List
Fetch one List Entry by id with optional field data
Get A Single Field Value
Get one field value on a List Entry
Add A List Entry To A List
Add an existing Company or Person to a List as a new List Entry (BETA)
Perform Batch Operations On A List Entry’s Fields
Update up to 100 field values on a List Entry in one request
Update A Single Field Value On A List Entry
Set or clear a single field value on a List Entry
Delete A Specific List Entry
Delete a List Entry from a List (v1 API)
Get Metadata On All Lists
Page through all Lists the caller can view
Get Metadata On A Single List’s Fields
List metadata for all fields on one list
Get Dropdown Options For A List Field
List dropdown options for a dropdown-type list field
Get Values For A Single Field On A List Entry
Page through all values of one field on a list entry
Get Metadata On Saved Views
Page through all Saved Views of a List
Get All List Entries On A Saved View
Page through the rows of a sheet-type Saved View, returning only the columns and filters configured on that view
Get Metadata On A Single List
Fetch metadata for a single List by ID
Get A Dropdown Option For A List Field
Fetch one dropdown option of a list field by ID
Get Metadata On A Single Saved View
Fetch one Saved View (id, name, type sheet/board/dashboard, createdAt)
Create A List
Create a new List of companies, persons, or opportunities
Create A Dropdown Option For A List Field
Create a new dropdown option on a dropdown, ranked-dropdown or status-dropdown list field
Update A Dropdown Option For A List Field
Update text, rank, color, statusCategory or winRate of an existing dropdown option
Delete A Dropdown Option For A List Field
Permanently delete a dropdown option from a list field
Get All Company Merges
List company merges for the organization, newest first
Get All Person Merges
List person merges with status, filterable by status or taskId
Get All Company Merge Tasks
List company merge tasks (batch merge operations) with status and per-task result counts
Get All Person Merge Tasks
List person merge tasks (batch merge operations) with status and per-task result counts
Get All Company Duplicate Suggestions
List company duplicate merge suggestions (BETA)
Get All Person Duplicate Suggestions
List person duplicate merge suggestions (BETA)
Get Company Merge
Get status and details of one company merge by mergeId
Get Person Merge
Get status and details (persons involved, timestamps, error info) of one person merge
Get Company Merge Task
Get status and result counts of one company merge task
Get Person Merge Task
Get status and result counts of one person merge task
Initiate Company Merge
Start an asynchronous merge of a duplicate company into a primary company
Initiate Person Merge
Start an asynchronous merge of a duplicate person into a primary person
Get All Notes
List all root notes (replies excluded) with optional filtering and cursor pagination
Search Notes By Keyword
Keyword-search notes, returning one note (id, kind) plus a matching preview passage per result, ordered by relevance
Get Companies Attached To A Note
List the companies directly attached to a Note
Get Opportunities Attached To A Note
List the opportunities directly attached to a Note
Get Persons Attached To A Note
List the persons directly attached to a Note
Get Replies For A Note
List reply notes of a given Note, optionally filtered
Get A Single Note
Fetch one note by ID, including content, creator, mentions and timestamps
Create A Note
Create a note attached to persons/companies/opportunities, anchored to a meeting/call/chat message, or as a reply to a r…
Update A Single Note
Update a note’s HTML content and/or replace its person/company/opportunity associations
Delete A Single Note
Permanently delete a note you created
Get All Opportunities
List opportunities with cursor pagination
Get Notes For An Opportunity
List notes for one opportunity, including notes attached directly and those attached to persons on it, with filtering an…
Get A Single Opportunity
Fetch a single opportunity by ID
Create A New Opportunity
Create a new opportunity on an opportunity-type list
Update An Opportunity
Partially update an opportunity (currently only its name)
Delete An Opportunity
Delete an opportunity by ID
Get All Companies
List companies with cursor pagination
Search Companies
Search companies with filters, sorts and a keyword term, returning cursor-paginated Company records
Get A Company’s List Entries
List the list entries (rows) of one company across all lists, with list-specific field data and creation metadata
Get A Company’s Lists
List all lists the given company appears in (basic list info only) that the caller can view
Get Notes For A Company
List notes for a company, including notes attached directly and notes attached to persons on the company
Get Relationships For A Company
List person-to-person relationships related to a company with interaction scores (0.0-1.0) and LinkedIn connection dates
Get A Single Company
Fetch a single company by ID with optional field data
Create A New Organization
Create a new organization (company) in Affinity
Update An Organization
Update an organization’s name, domain or associated persons
Delete An Organization
Delete an organization
Get Field Values On A Single Person
Paginate field values on one Person (enriched, global, relationship-intelligence by default)
Get Metadata On Person Fields
List metadata for non-list-specific Person fields (IDs, names, types)
Get Values For A Single Field On A Person
Paginate all values of a single field on one Person (multi-value fields return many)
Get Dropdown Options For A Person Field
List dropdown options for a Person dropdown or ranked-dropdown field
Get A Single Field On A Person
Fetch one non-list field and its value on a Person
Perform Batch Operations On A Person’s Fields
Update up to 100 person field values in one request via the update-fields operation
Update A Single Field Value On A Person
Set or clear one non-list field value on a Person
Get All Persons
List all Persons with cursor pagination, optionally filtered by IDs and with field data attached
Search Persons
Search Persons with nested filters, sorts and a keyword
Get A Person’s List Entries
List a Person’s List Entries across all Lists with list-specific field data
Get A Person’s Lists
List the Lists that contain a given Person
Get Notes For A Person
List notes related to a Person (attached, from attended meetings, or mentioning them), with optional filtering
Get Relationships For A Person
List a Person’s relationships with interaction scores (0.0-1.0) and LinkedIn connection dates
Get A Single Person
Fetch a single Person by ID, optionally with field data
Create A Person
Create a new Person
Update A Person
Update a person (v1 API) - only supplied attributes change
Delete A Person
Delete a Person by ID
List Introduction Paths
List ranked introduction paths (BETA) from internal people to a target person or any person at a target company
Get Coworker Inferred Connections
List inferred coworker connections (source in your data may know a target via overlapping employment at a shared company…
Get Investor-Executive Inferred Connections
List inferred investor-executive connections (source invested in a company where the target was an executive), grouped b…
Semantic Search
Natural-language semantic search over companies, returning matches with relevance scores
Get Relationship Strengths
Get relationship strengths between internal people and a given external person
Get All Reminders
List reminders visible to the caller with filter and cursor pagination
Get A Single Reminder
Fetch one reminder by ID
Create A Reminder
Create a one-time or recurring reminder tied to one company, person, or opportunity
Update A Reminder
Partially update a reminder (content, dueDate, owner, completion, recurrence)
Delete A Reminder
Delete a reminder by ID
Get Metadata On All Teams
List all Teams visible to the caller
Get All Lists A Team Has Access To
List all Lists a Team can access (id, name, creatorId, ownerId, isPublic, type, createdAt)
Get All Members Of A Team
List all members of a Team (membership id, user, addedAt, optional privacyType)
Get Metadata On A Single Team
Get one Team by id
Get All Transcripts
List transcripts (metadata only) visible to the caller
Get Fragments Of A Transcript
List all fragments of one transcript, paginated
Get A Single Transcript
Fetch one transcript with its first 100 fragments
Delete A Single Transcript
Delete a transcript (BETA)
Get All Users
List internal users in the Affinity organization
Get A Single User
Fetch a single internal user by ID
Get Current User
Return the authenticated user, tenant, and grant (type and scopes) for the current credential
Get Rate Limit Usage
Get current rate limit usage (per-minute and, if applicable, monthly) for the authenticated caller
Send Feedback
Send feedback to Affinity about a product area or feature