Skip to main content

​
What can you do with it?

The Affinity integration allows you to access and manage your relationship intelligence data including lists, people, and custom field values. You can retrieve all accessible lists, get detailed field values for specific people, and access the structured data that powers Affinity’s relationship management capabilities. This integration is ideal for teams that need to programmatically access their relationship data and integrate it with other business processes.

​
How to use it?

​
Basic Command Structure

/your-affinity-connection [action] [required-parameters] [optional-parameters]

​
Parameters

Required:
  • action - The operation you want to perform (get_lists, get_field_values)
Optional:
  • person_id - The unique ID of a person for field value retrieval

​
Tools

​
Get Lists

Retrieve all lists that you have access to Parameters:
  • action (required) - Set to “get_lists”
Example: 
/your-affinity-connection
action: get_lists
Response: 
{
  "lists": "[Array of list objects with id, type, name, public status, owner_id, and list_size]"
}

​
Get Field Values for Person

Retrieve field values for a specific person by their ID Parameters:
  • action (required) - Set to “get_field_values”
  • person_id (required) - The unique ID of the person
Example: 
/your-affinity-connection
action: get_field_values
person_id: 38706
Response: 
{
  "field_values": "[Array of field value objects with id, field_id, entity_id, timestamps, and structured value data]"
}

​
Notes

Affinity uses numeric IDs for lists and people. Lists have a type field (0 for people lists) and can be public or private. Field values contain structured data that may include location information like city, state, country, and street address. The system tracks creation and update timestamps for all field values. Access is controlled by your Affinity permissions and you can only retrieve data for lists and people you have access to.
⌘I