affinity

# Affinity

Affinity is a relationship intelligence platform that helps sales, investment banking, and consulting teams close more deals. It automates the collection of relationship data to provide insights into who in your network knows a potential customer. This allows users to prioritize outreach and leverage warm introductions.

Official docs: https://affinity.help/

## Affinity Overview

- **Document**
  - **Section**
- **Project**
- **Tag**

Use action names and parameters as needed.

## Working with Affinity

This skill uses the Membrane CLI to interact with Affinity. Membrane handles authentication and credentials refresh automatically — so you can focus on the integration logic rather than auth plumbing.

### Install the CLI

Install the Membrane CLI so you can run `membrane` from the terminal:

```bash
npm install -g @membranehq/cli@latest
```

### Authentication

```bash
membrane login --tenant --clientName=<agentType>
```

This will either open a browser for authentication or print an authorization URL to the console, depending on whether interactive mode is available.

**Headless environments:** The command will print an authorization URL. Ask the user to open it in a browser. When they see a code after completing login, finish with:

```bash
membrane login complete <code>
```

Add `--json` to any command for machine-readable JSON output.

**Agent Types** : claude, openclaw, codex, warp, windsurf, etc. Those will be used to adjust tooling to be used best with your harness

### Connecting to Affinity

Use `membrane connection ensure` to find or create a connection by app URL or domain:

```bash
membrane connection ensure "https://www.affinity.co/" --json
```
The user completes authentication in the browser. The output contains the new connection id.

This is the fastest way to get a connection. The URL is normalized to a domain and matched against known apps. If no app is found, one is created and a connector is built automatically.

If the returned connection has `state: "READY"`, skip to **Step 2**.

#### 1b. Wait for the connection to be ready

If the connection is in `BUILDING` state, poll until it's ready:

```bash
npx @membranehq/cli connection get <id> --wait --json
```

The `--wait` flag long-polls (up to `--timeout` seconds, default 30) until the state changes. Keep polling until `state` is no longer `BUILDING`.

The resulting state tells you what to do next:

- **`READY`** — connection is fully set up. Skip to **Step 2**.
- **`CLIENT_ACTION_REQUIRED`** — the user or agent needs to do something. The `clientAction` object describes the required action:
  - `clientAction.type` — the kind of action needed:
    - `"connect"` — user needs to authenticate (OAuth, API key, etc.). This covers initial authentication and re-authentication for disconnected connections.
    - `"provide-input"` — more information is needed (e.g. which app to connect to).
  - `clientAction.description` — human-readable explanation of what's needed.
  - `clientAction.uiUrl` (optional) — URL to a pre-built UI where the user can complete the action. Show this to the user when present.
  - `clientAction.agentInstructions` (optional) — instructions for the AI agent on how to proceed programmatically.

  After the user completes the action (e.g. authenticates in the browser), poll again with `membrane connection get <id> --json` to check if the state moved to `READY`.

- **`CONFIGURATION_ERROR`** or **`SETUP_FAILED`** — something went wrong. Check the `error` field for details.

### Searching for actions

Search using a natural language description of what you want to do:

```bash
membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json
```

You should always search for actions in the context of a specific connection.

Each result includes `id`, `name`, `description`, `inputSchema` (what parameters the action accepts), and `outputSchema` (what it returns).

## Popular actions

| Name | Key | Description |
|---|---|---|
| Get Lists | get-lists | Get all lists visible to the user |
| Get List Entries | get-list-entries | Get all entries in a specific list |
| Get Notes | get-notes | Get all notes associated with a person, organization, or opportunity |
| Search Organizations | search-organizations | Search for organizations in Affinity by name, domain, or other criteria |
| Search Persons | search-persons | Search for persons in Affinity by name, email, or other criteria |
| Search Opportunities | search-opportunities | Search for opportunities in Affinity |
| Get Person | get-person | Retrieve a specific person by their ID |
| Get Organization | get-organization | Retrieve a specific organization by its ID |
| Get Opportunity | get-opportunity | Retrieve a specific opportunity by its ID |
| Get Note | get-note | Retrieve a specific note by its ID |
| Get List | get-list | Retrieve a specific list by its ID with its fields |
| Create Person | create-person | Create a new person in Affinity |
| Create Organization | create-organization | Create a new organization in Affinity |
| Create Opportunity | create-opportunity | Create a new opportunity in Affinity |
| Create Note | create-note | Create a new note in Affinity |
| Create List Entry | create-list-entry | Add an entity (person, organization, or opportunity) to a list |
| Create List | create-list | Create a new list in Affinity |
| Update Person | update-person | Update an existing person in Affinity |
| Update Organization | update-organization | Update an existing organization in Affinity |
| Update Opportunity | update-opportunity | Update an existing opportunity in Affinity |

### Running actions

```bash
membrane action run <actionId> --connectionId=CONNECTION_ID --json
```

To pass JSON parameters:

```bash
membrane action run <actionId> --connectionId=CONNECTION_ID --input '{"key": "value"}' --json
```

The result is in the `output` field of the response.


### Proxy requests

When the available actions don't cover