Affinity connector

Bearer TokenCRM & Sales

Connect to Affinity relationship intelligence CRM to manage deal flow, relationships, pipeline opportunities, and network connections for private capital...

Affinity connector

Install the SDK
Section titled “Install the SDK”
- Node.js
- Python
Terminal window
1 npm install @scalekit-sdk/node
Terminal window
1 pip install scalekit
Full SDK reference: Node.js | Python
Set your credentials
Section titled “Set your credentials”

Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.
.env
```
SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
SCALEKIT_CLIENT_ID=<your-client-id>
SCALEKIT_CLIENT_SECRET=<your-client-secret>
```

1
import { ScalekitClient } from '@scalekit-sdk/node'
2
import 'dotenv/config'
3

4
const scalekit = new ScalekitClient(
5
  process.env.SCALEKIT_ENV_URL,
6
  process.env.SCALEKIT_CLIENT_ID,
7
  process.env.SCALEKIT_CLIENT_SECRET,
8
)
9
const actions = scalekit.actions
10

11
const connector = 'affinity'
12
const identifier = 'user_123'
13

14
// Make your first call
15
const result = await actions.executeTool({
16
  connector,
17
  identifier,
18
  toolName: 'affinity_list_lists',
19
  toolInput: {},
20
})
21
console.log(result)

1
import os
2
from scalekit.client import ScalekitClient
3
from dotenv import load_dotenv
4
load_dotenv()
5

6
scalekit_client = ScalekitClient(
7
    env_url=os.getenv("SCALEKIT_ENV_URL"),
8
    client_id=os.getenv("SCALEKIT_CLIENT_ID"),
9
    client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
10
)
11
actions = scalekit_client.actions
12

13
connection_name = "affinity"
14
identifier = "user_123"
15

16
# Make your first call
17
result = actions.execute_tool(
18
    tool_input={},
19
    tool_name="affinity_list_lists",
20
    connection_name=connection_name,
21
    identifier=identifier,
22
)
23
print(result)

What you can do

Connect this agent connector to let your agent:

Update v2, person — Updates a single field’s value on a person
Search v2, persons — Searches persons matching a combination of filters, sorts, and a search term
List v2 — Paginates through persons in your Affinity organization using the V2 API
Get v2 — Retrieves a single field’s value on a person
Delete note, person, organization — Permanently delete a note from Affinity
Create person, organization, note — Create a new person record in Affinity

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

affinity_add_to_list#Add a person or organization to an Affinity list by creating a new list entry. Use this to add a founder to a deal pipeline, add a company to a watchlist, or track a new contact in a relationship list. Provide either entity_id for persons/organizations.2 params

Add a person or organization to an Affinity list by creating a new list entry. Use this to add a founder to a deal pipeline, add a company to a watchlist, or track a new contact in a relationship list. Provide either entity_id for persons/organizations.

NameTypeRequiredDescription

entity_idintegerrequiredID of the person or organization to add to the list

list_idintegerrequiredID of the Affinity list to add the entity to

affinity_create_note#Create a note on a person, organization, or opportunity in Affinity. Notes support plain text content and can be attached to multiple entity types simultaneously. Use this to log meeting summaries, due diligence findings, or relationship context directly on a CRM record.4 params

Create a note on a person, organization, or opportunity in Affinity. Notes support plain text content and can be attached to multiple entity types simultaneously. Use this to log meeting summaries, due diligence findings, or relationship context directly on a CRM record.

NameTypeRequiredDescription

contentstringrequiredPlain text content of the note

opportunity_idsarrayoptionalList of opportunity IDs to attach this note to

organization_idsarrayoptionalList of organization IDs to attach this note to

person_idsarrayoptionalList of person IDs to attach this note to

affinity_create_opportunity#Create a new deal or opportunity record in Affinity and add it to a pipeline list. Supports associating persons and organizations, setting the deal name, and assigning an owner. Ideal for logging inbound deals or sourcing new investment targets.4 params

Create a new deal or opportunity record in Affinity and add it to a pipeline list. Supports associating persons and organizations, setting the deal name, and assigning an owner. Ideal for logging inbound deals or sourcing new investment targets.

NameTypeRequiredDescription

list_idintegerrequiredID of the Affinity list to add this opportunity to

namestringrequiredName of the opportunity or deal

organization_idsarrayoptionalList of Affinity organization IDs to associate with this opportunity

person_idsarrayoptionalList of Affinity person IDs to associate with this opportunity

affinity_create_organization#Create a new organization/company record in Affinity. The connector could already search and get organizations but had no way to create one. Optionally link the new organization to existing persons immediately.3 params

Create a new organization/company record in Affinity. The connector could already search and get organizations but had no way to create one. Optionally link the new organization to existing persons immediately.

NameTypeRequiredDescription

namestringrequiredName of the organization to create.

domainstringoptionalThe organization's primary web domain.

person_idsarrayoptionalList of Affinity person IDs to associate with this organization.

affinity_create_person#Create a new person record in Affinity. The connector could already search and get persons but had no way to create one.4 params

Create a new person record in Affinity. The connector could already search and get persons but had no way to create one.

NameTypeRequiredDescription

emailsarrayrequiredEmail addresses for the person. Pass an empty array if none are known.

first_namestringrequiredThe person's first name.

last_namestringrequiredThe person's last name.

organization_idsarrayoptionalList of Affinity organization IDs to associate with this person.

affinity_delete_opportunity#Permanently delete a deal or opportunity from Affinity. Create/Get/List/Update already exist for opportunities (affinity_create_opportunity, affinity_get_opportunity, affinity_list_opportunities, affinity_update_opportunity) but Delete did not.1 param

Permanently delete a deal or opportunity from Affinity. Create/Get/List/Update already exist for opportunities (affinity_create_opportunity, affinity_get_opportunity, affinity_list_opportunities, affinity_update_opportunity) but Delete did not.

NameTypeRequiredDescription

opportunity_idintegerrequiredUnique numeric ID of the opportunity to delete.

affinity_delete_organization#Permanently delete an organization from Affinity. This also removes it from any lists and detaches it from associated notes and opportunities.1 param

Permanently delete an organization from Affinity. This also removes it from any lists and detaches it from associated notes and opportunities.

NameTypeRequiredDescription

organization_idintegerrequiredUnique numeric ID of the organization to delete.

affinity_delete_person#Permanently delete a person from Affinity. This also removes them from any lists and detaches them from associated notes and opportunities.1 param

Permanently delete a person from Affinity. This also removes them from any lists and detaches them from associated notes and opportunities.

NameTypeRequiredDescription

person_idintegerrequiredUnique numeric ID of the person to delete.

affinity_get_opportunity#Retrieve full details of a deal or opportunity in Affinity including current stage, owner, associated persons and organizations, custom field values, and list membership. Use this before updating a deal or generating a deal memo.1 param

Retrieve full details of a deal or opportunity in Affinity including current stage, owner, associated persons and organizations, custom field values, and list membership. Use this before updating a deal or generating a deal memo.

NameTypeRequiredDescription

opportunity_idintegerrequiredUnique numeric ID of the opportunity to retrieve

affinity_get_organization#Retrieve an organization's full profile from Affinity including domain, team member connections, associated people, deal history, and interaction metadata. Use this for deep company diligence or to understand team relationships before an investment.2 params

Retrieve an organization's full profile from Affinity including domain, team member connections, associated people, deal history, and interaction metadata. Use this for deep company diligence or to understand team relationships before an investment.

NameTypeRequiredDescription

organization_idintegerrequiredUnique numeric ID of the organization to retrieve

with_interaction_datesbooleanoptionalInclude first and last interaction dates in the response

affinity_get_person#Retrieve a person's full profile from Affinity including contact information, email addresses, phone numbers, organization memberships, interaction history, and relationship score. Use this to deeply evaluate a contact before a meeting or investment decision.2 params

Retrieve a person's full profile from Affinity including contact information, email addresses, phone numbers, organization memberships, interaction history, and relationship score. Use this to deeply evaluate a contact before a meeting or investment decision.

NameTypeRequiredDescription

person_idintegerrequiredUnique numeric ID of the person to retrieve

with_interaction_datesbooleanoptionalInclude first and last interaction dates in the response

affinity_get_relationship_strength#Retrieve relationship strength scores between your team members and an external contact (person) in Affinity. Scores reflect email and meeting interaction frequency and recency. Use this to identify the best warm introduction path to a founder, LP, or co-investor.2 params

Retrieve relationship strength scores between your team members and an external contact (person) in Affinity. Scores reflect email and meeting interaction frequency and recency. Use this to identify the best warm introduction path to a founder, LP, or co-investor.

NameTypeRequiredDescription

external_idintegerrequiredAffinity person ID of the external contact to evaluate relationship strength against

internal_idintegeroptionalAffinity person ID of the internal team member (optional — omit to get scores for all team members)

affinity_list_lists#Retrieve all Affinity lists available in the workspace, including people lists, organization lists, and opportunity/deal pipeline lists. Returns list IDs, names, types, and owner information. Use this to discover list IDs before adding entries or filtering opportunities.0 params

Retrieve all Affinity lists available in the workspace, including people lists, organization lists, and opportunity/deal pipeline lists. Returns list IDs, names, types, and owner information. Use this to discover list IDs before adding entries or filtering opportunities.

affinity_list_notes#Retrieve notes associated with a specific person, organization, or opportunity in Affinity. Returns paginated note records including content, creator, and creation timestamp. Use this to review interaction history, meeting summaries, or due diligence logs on a CRM entity.5 params

Retrieve notes associated with a specific person, organization, or opportunity in Affinity. Returns paginated note records including content, creator, and creation timestamp. Use this to review interaction history, meeting summaries, or due diligence logs on a CRM entity.

NameTypeRequiredDescription

opportunity_idintegeroptionalFilter notes by opportunity ID

organization_idintegeroptionalFilter notes by organization ID

page_sizeintegeroptionalNumber of results to return per page (max 500)

page_tokenstringoptionalPagination token from a previous response to fetch the next page

person_idintegeroptionalFilter notes by person ID

affinity_list_opportunities#List pipeline opportunities in Affinity with optional filters by list ID, owner, or stage. Returns paginated deal records including stage, value, associated people and organizations, and custom field values. Designed for deal flow monitoring and portfolio tracking.3 params

List pipeline opportunities in Affinity with optional filters by list ID, owner, or stage. Returns paginated deal records including stage, value, associated people and organizations, and custom field values. Designed for deal flow monitoring and portfolio tracking.

NameTypeRequiredDescription

list_idintegeroptionalFilter opportunities belonging to a specific Affinity list ID

page_sizeintegeroptionalNumber of results to return per page (max 500)

page_tokenstringoptionalPagination token from a previous response to fetch the next page

affinity_note_delete#Permanently delete a note from Affinity.1 param

Permanently delete a note from Affinity.

NameTypeRequiredDescription

note_idintegerrequiredUnique numeric ID of the note to delete.

affinity_note_update#Update the text content of an existing note in Affinity. affinity_create_note and affinity_list_notes exist but there was no way to edit a note afterward.2 params

Update the text content of an existing note in Affinity. affinity_create_note and affinity_list_notes exist but there was no way to edit a note afterward.

NameTypeRequiredDescription

contentstringrequiredThe new plain text content of the note, replacing the existing content.

note_idintegerrequiredUnique numeric ID of the note to update.

affinity_remove_from_list#Remove a person, organization, or opportunity from a list by deleting its list entry. affinity_add_to_list creates entries with no corresponding removal tool until now.2 params

Remove a person, organization, or opportunity from a list by deleting its list entry. affinity_add_to_list creates entries with no corresponding removal tool until now.

NameTypeRequiredDescription

list_entry_idintegerrequiredThe ID of the list entry to remove.

list_idintegerrequiredID of the Affinity list the entry belongs to.

affinity_search_organizations#Search for companies and organizations in the Affinity network by name or domain. Returns a paginated list of matching organization records including team connections, domain info, and interaction metadata. Useful for deal sourcing and company diligence lookups.4 params

Search for companies and organizations in the Affinity network by name or domain. Returns a paginated list of matching organization records including team connections, domain info, and interaction metadata. Useful for deal sourcing and company diligence lookups.

NameTypeRequiredDescription

page_sizeintegeroptionalNumber of results to return per page (max 500)

page_tokenstringoptionalPagination token from a previous response to fetch the next page

termstringoptionalSearch term to filter organizations by name or domain

with_interaction_datesbooleanoptionalInclude first and last interaction dates in the response

affinity_search_persons#Search for people in the Affinity network by name, email, or relationship strength. Returns a paginated list of matching person records including contact information and relationship metadata. Ideal for finding contacts before creating notes or evaluating deal connections.4 params

Search for people in the Affinity network by name, email, or relationship strength. Returns a paginated list of matching person records including contact information and relationship metadata. Ideal for finding contacts before creating notes or evaluating deal connections.

NameTypeRequiredDescription

page_sizeintegeroptionalNumber of results to return per page (max 500)

page_tokenstringoptionalPagination token from a previous response to fetch the next page

termstringoptionalSearch term to filter persons by name or email address

with_interaction_datesbooleanoptionalInclude first and last interaction dates in the response

affinity_update_opportunity#Update an existing deal or opportunity in Affinity. Supports renaming the deal, adding or removing associated persons and organizations. Use this to reflect changes in deal status, team assignment, or company involvement during a pipeline review.4 params

Update an existing deal or opportunity in Affinity. Supports renaming the deal, adding or removing associated persons and organizations. Use this to reflect changes in deal status, team assignment, or company involvement during a pipeline review.

NameTypeRequiredDescription

opportunity_idintegerrequiredUnique numeric ID of the opportunity to update

namestringoptionalUpdated name for the opportunity

organization_idsarrayoptionalUpdated list of Affinity organization IDs associated with this opportunity

person_idsarrayoptionalUpdated list of Affinity person IDs associated with this opportunity

affinity_update_organization#Update an existing organization's name, domain, or person associations in Affinity.4 params

Update an existing organization's name, domain, or person associations in Affinity.

NameTypeRequiredDescription

organization_idintegerrequiredUnique numeric ID of the organization to update.

domainstringoptionalUpdated primary web domain for the organization.

namestringoptionalUpdated name for the organization.

person_idsarrayoptionalUpdated list of Affinity person IDs associated with this organization. Replaces the full set of linked persons.

affinity_update_person#Update an existing person's name, emails, or organization associations in Affinity.5 params

Update an existing person's name, emails, or organization associations in Affinity.

NameTypeRequiredDescription

person_idintegerrequiredUnique numeric ID of the person to update.

emailsarrayoptionalUpdated list of email addresses for the person. Replaces the full set.

first_namestringoptionalUpdated first name.

last_namestringoptionalUpdated last name.

organization_idsarrayoptionalUpdated list of Affinity organization IDs associated with this person. Replaces the full set.

affinity_v2_get_company#Retrieves basic information for a single company using the V2 API. Pass field_ids or field_types to also receive field data.3 params

Retrieves basic information for a single company using the V2 API. Pass field_ids or field_types to also receive field data.

NameTypeRequiredDescription

company_idintegerrequiredThe unique numeric ID of the company.

field_idsarrayoptionalSpecific field IDs to return field data for. Mutually exclusive with field_types.

field_typesarrayoptionalCategory of fields to return field data for. Mutually exclusive with field_ids.

affinity_v2_get_company_field_dropdown_options#Returns the dropdown options for a specific dropdown or ranked-dropdown company field. Use the returned option IDs when writing dropdown field values.3 params

Returns the dropdown options for a specific dropdown or ranked-dropdown company field. Use the returned option IDs when writing dropdown field values.

NameTypeRequiredDescription

field_idstringrequiredThe ID of the dropdown field.

cursorstringoptionalPagination cursor from a previous response's nextUrl/cursor.

limitintegeroptionalNumber of items to return per page (max 100).

affinity_v2_get_company_field_value#Retrieves a single field's value on a company.2 params

Retrieves a single field's value on a company.

NameTypeRequiredDescription

company_idintegerrequiredThe unique numeric ID of the company.

field_idstringrequiredThe ID of the field to retrieve.

affinity_v2_get_current_user#Returns information about the authenticated user, their current organization, and the permissions granted to the API key in use. Useful for verifying authentication before making other V2 API calls.0 params

Returns information about the authenticated user, their current organization, and the permissions granted to the API key in use. Useful for verifying authentication before making other V2 API calls.

affinity_v2_get_person#Retrieves basic information for a single person using the V2 API. Pass field_ids or field_types to also receive field data.3 params

Retrieves basic information for a single person using the V2 API. Pass field_ids or field_types to also receive field data.

NameTypeRequiredDescription

person_idintegerrequiredThe unique numeric ID of the person.

field_idsarrayoptionalSpecific field IDs to return field data for. Mutually exclusive with field_types.

field_typesarrayoptionalCategory of fields to return field data for. Mutually exclusive with field_ids.

affinity_v2_get_person_field_dropdown_options#Returns the dropdown options for a specific dropdown or ranked-dropdown person field. Use the returned option IDs when writing dropdown field values.3 params

Returns the dropdown options for a specific dropdown or ranked-dropdown person field. Use the returned option IDs when writing dropdown field values.

NameTypeRequiredDescription

field_idstringrequiredThe ID of the dropdown field.

cursorstringoptionalPagination cursor from a previous response's nextUrl/cursor.

limitintegeroptionalNumber of items to return per page (max 100).

affinity_v2_get_person_field_value#Retrieves a single field's value on a person.2 params

Retrieves a single field's value on a person.

NameTypeRequiredDescription

field_idstringrequiredThe ID of the field to retrieve.

person_idintegerrequiredThe unique numeric ID of the person.

affinity_v2_list_companies#Paginates through companies in your Affinity organization using the V2 API. Returns basic information; pass field_ids or field_types to also receive field data (omit both to skip field data entirely).5 params

Paginates through companies in your Affinity organization using the V2 API. Returns basic information; pass field_ids or field_types to also receive field data (omit both to skip field data entirely).

NameTypeRequiredDescription

cursorstringoptionalPagination cursor from a previous response's nextUrl/cursor.

field_idsarrayoptionalSpecific field IDs to return field data for. Mutually exclusive with field_types.

field_typesarrayoptionalCategory of fields to return field data for. Mutually exclusive with field_ids.

idsarrayoptionalFilter to specific company IDs.

limitintegeroptionalNumber of items to return per page (max 100).

affinity_v2_list_company_field_values#Paginates through field values on a single company. Enriched, global, and relationship-intelligence fields are included by default; use ids or types to filter. List fields are not returned here — use the list entry fields endpoints instead.5 params

Paginates through field values on a single company. Enriched, global, and relationship-intelligence fields are included by default; use ids or types to filter. List fields are not returned here — use the list entry fields endpoints instead.

NameTypeRequiredDescription

company_idintegerrequiredThe unique numeric ID of the company.

cursorstringoptionalPagination cursor from a previous response's nextUrl/cursor.

idsarrayoptionalField IDs to filter the returned field values to. Mutually exclusive with types.

limitintegeroptionalNumber of items to return per page (max 100).

typesarrayoptionalField type categories to filter the returned field values to. Mutually exclusive with ids.

affinity_v2_list_company_fields#Returns metadata on non-list-specific company fields, including each field's ID and value type. Use the returned field IDs with the list/get company endpoints to request field data.2 params

Returns metadata on non-list-specific company fields, including each field's ID and value type. Use the returned field IDs with the list/get company endpoints to request field data.

NameTypeRequiredDescription

cursorstringoptionalPagination cursor from a previous response's nextUrl/cursor.

filterstringoptionalFilter expression restricting the results. See Affinity's filtering syntax docs for the fields and operators supported by this endpoint.

affinity_v2_list_company_list_entries#Paginates through the list entries (rows) for a given company across all lists it appears on, including list-specific field data and creation metadata.3 params

Paginates through the list entries (rows) for a given company across all lists it appears on, including list-specific field data and creation metadata.

NameTypeRequiredDescription

company_idintegerrequiredThe unique numeric ID of the company.

cursorstringoptionalPagination cursor from a previous response's nextUrl/cursor.

limitintegeroptionalNumber of items to return per page (max 100).

affinity_v2_list_company_lists#Paginates through all lists where the given company appears as an entry and that the caller has access to view.3 params

Paginates through all lists where the given company appears as an entry and that the caller has access to view.

NameTypeRequiredDescription

company_idintegerrequiredThe unique numeric ID of the company.

cursorstringoptionalPagination cursor from a previous response's nextUrl/cursor.

limitintegeroptionalNumber of items to return per page (max 100).

affinity_v2_list_company_notes#Returns notes for a given company, including directly attached notes, notes on meetings the company attended (for persons), and notes where the company is mentioned. Supports filtering via the filter parameter.4 params

Returns notes for a given company, including directly attached notes, notes on meetings the company attended (for persons), and notes where the company is mentioned. Supports filtering via the filter parameter.

NameTypeRequiredDescription

company_idintegerrequiredThe unique numeric ID of the company.

cursorstringoptionalPagination cursor from a previous response's nextUrl/cursor.

filterstringoptionalFilter expression restricting the results. See Affinity's filtering syntax docs for the fields and operators supported by this endpoint.

limitintegeroptionalNumber of items to return per page (max 100).

affinity_v2_list_company_relationships#Returns the relationships for a given company, including an interaction score (0.0-1.0) measuring relationship strength based on emails, meetings, and other interactions. Useful for finding the best warm introduction path.3 params

Returns the relationships for a given company, including an interaction score (0.0-1.0) measuring relationship strength based on emails, meetings, and other interactions. Useful for finding the best warm introduction path.

NameTypeRequiredDescription

company_idintegerrequiredThe unique numeric ID of the company.

cursorstringoptionalPagination cursor from a previous response's nextUrl/cursor.

limitintegeroptionalNumber of items to return per page (max 100).

affinity_v2_list_list_entries#Paginates through every entry (row) on a given list — a list's actual contents/pipeline view. The existing V2 tools only go the opposite direction (affinity_v2_list_company_list_entries / affinity_v2_list_person_list_entries list which lists a company/person appears on); there was no way to browse what's ON a list.3 params

Paginates through every entry (row) on a given list — a list's actual contents/pipeline view. The existing V2 tools only go the opposite direction (affinity_v2_list_company_list_entries / affinity_v2_list_person_list_entries list which lists a company/person appears on); there was no way to browse what's ON a list.

NameTypeRequiredDescription

list_idintegerrequiredThe unique numeric ID of the list.

cursorstringoptionalPagination cursor from a previous response's nextUrl/cursor.

limitintegeroptionalNumber of items to return per page (max 100).

affinity_v2_list_person_field_values#Paginates through field values on a single person. Enriched, global, and relationship-intelligence fields are included by default; use ids or types to filter. List fields are not returned here — use the list entry fields endpoints instead.5 params

Paginates through field values on a single person. Enriched, global, and relationship-intelligence fields are included by default; use ids or types to filter. List fields are not returned here — use the list entry fields endpoints instead.

NameTypeRequiredDescription

person_idintegerrequiredThe unique numeric ID of the person.

cursorstringoptionalPagination cursor from a previous response's nextUrl/cursor.

idsarrayoptionalField IDs to filter the returned field values to. Mutually exclusive with types.

limitintegeroptionalNumber of items to return per page (max 100).

typesarrayoptionalField type categories to filter the returned field values to. Mutually exclusive with ids.

affinity_v2_list_person_fields#Returns metadata on non-list-specific person fields, including each field's ID and value type. Use the returned field IDs with the list/get person endpoints to request field data.2 params

Returns metadata on non-list-specific person fields, including each field's ID and value type. Use the returned field IDs with the list/get person endpoints to request field data.

NameTypeRequiredDescription

cursorstringoptionalPagination cursor from a previous response's nextUrl/cursor.

filterstringoptionalFilter expression restricting the results. See Affinity's filtering syntax docs for the fields and operators supported by this endpoint.

affinity_v2_list_person_list_entries#Paginates through the list entries (rows) for a given person across all lists it appears on, including list-specific field data and creation metadata.3 params

Paginates through the list entries (rows) for a given person across all lists it appears on, including list-specific field data and creation metadata.

NameTypeRequiredDescription

person_idintegerrequiredThe unique numeric ID of the person.

cursorstringoptionalPagination cursor from a previous response's nextUrl/cursor.

limitintegeroptionalNumber of items to return per page (max 100).

affinity_v2_list_person_lists#Paginates through all lists where the given person appears as an entry and that the caller has access to view.3 params

Paginates through all lists where the given person appears as an entry and that the caller has access to view.

NameTypeRequiredDescription

person_idintegerrequiredThe unique numeric ID of the person.

cursorstringoptionalPagination cursor from a previous response's nextUrl/cursor.

limitintegeroptionalNumber of items to return per page (max 100).

affinity_v2_list_person_notes#Returns notes for a given person, including directly attached notes, notes on meetings the person attended (for persons), and notes where the person is mentioned. Supports filtering via the filter parameter.4 params

Returns notes for a given person, including directly attached notes, notes on meetings the person attended (for persons), and notes where the person is mentioned. Supports filtering via the filter parameter.

NameTypeRequiredDescription

person_idintegerrequiredThe unique numeric ID of the person.

cursorstringoptionalPagination cursor from a previous response's nextUrl/cursor.

filterstringoptionalFilter expression restricting the results. See Affinity's filtering syntax docs for the fields and operators supported by this endpoint.

limitintegeroptionalNumber of items to return per page (max 100).

affinity_v2_list_person_relationships#Returns the relationships for a given person, including an interaction score (0.0-1.0) measuring relationship strength based on emails, meetings, and other interactions. Useful for finding the best warm introduction path.3 params

Returns the relationships for a given person, including an interaction score (0.0-1.0) measuring relationship strength based on emails, meetings, and other interactions. Useful for finding the best warm introduction path.

NameTypeRequiredDescription

person_idintegerrequiredThe unique numeric ID of the person.

cursorstringoptionalPagination cursor from a previous response's nextUrl/cursor.

limitintegeroptionalNumber of items to return per page (max 100).

affinity_v2_list_persons#Paginates through persons in your Affinity organization using the V2 API. Returns basic information; pass field_ids or field_types to also receive field data (omit both to skip field data entirely).5 params

Paginates through persons in your Affinity organization using the V2 API. Returns basic information; pass field_ids or field_types to also receive field data (omit both to skip field data entirely).

NameTypeRequiredDescription

cursorstringoptionalPagination cursor from a previous response's nextUrl/cursor.

field_idsarrayoptionalSpecific field IDs to return field data for. Mutually exclusive with field_types.

field_typesarrayoptionalCategory of fields to return field data for. Mutually exclusive with field_ids.

idsarrayoptionalFilter to specific person IDs.

limitintegeroptionalNumber of items to return per page (max 100).

affinity_v2_search_companies#Searches companies matching a combination of filters, sorts, and a search term. Omitting the request body is equivalent to listing all companies with default pagination. Requires the appropriate export permission.8 params

Searches companies matching a combination of filters, sorts, and a search term. Omitting the request body is equivalent to listing all companies with default pagination. Requires the appropriate export permission.

NameTypeRequiredDescription

cursorstringoptionalPagination cursor from a previous response's nextUrl/cursor.

field_idsarrayoptionalSpecific field IDs to return field data for. Mutually exclusive with field_types.

field_typesarrayoptionalCategory of fields to return field data for. Mutually exclusive with field_ids.

filtersobjectoptionalA logical group of filter conditions combined with AND/OR, optionally nested. Up to 50 items per group.

limitintegeroptionalNumber of items to return per page (max 100).

searchobjectoptionalA single keyword or phrase to match against field values.

sortsarrayoptionalUp to 5 sort criteria, applied in order.

total_countbooleanoptionalWhen true, includes the total matching count in the pagination response. Adds query cost; use only when needed.

affinity_v2_search_persons#Searches persons matching a combination of filters, sorts, and a search term. Omitting the request body is equivalent to listing all persons with default pagination. Requires the appropriate export permission.8 params

Searches persons matching a combination of filters, sorts, and a search term. Omitting the request body is equivalent to listing all persons with default pagination. Requires the appropriate export permission.