# Affinity

Affinity helps private capital investors to find, manage, and close more deals

- **Category:** crm
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 20
- **Triggers:** 0
- **Slug:** `AFFINITY`
- **Version:** 20260203_01

## Tools

### Get a company s list entries

**Slug:** `AFFINITY_GET_A_COMPANY_S_LIST_ENTRIES`

Summarize company data across all lists, including list-specific fields and metadata like creation date and author. Access requires "Export data from Lists" permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Company ID |
| `limit` | integer | No | Number of items to include in the page |
| `cursor` | string | No | Cursor for the next or previous page |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a company s lists

**Slug:** `AFFINITY_GET_A_COMPANY_S_LISTS`

Returns metadata for all the Lists on which the given Company appears.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Company ID |
| `limit` | integer | No | Number of items to include in the page |
| `cursor` | string | No | Cursor for the next or previous page |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all companies

**Slug:** `AFFINITY_GET_ALL_COMPANIES`

Affinity API allows paginated access to company info and custom fields. Use `fieldIds` or `fieldTypes` to specify data in a request. Retrieve field IDs/Types via GET `/v2/companies/fields`. Export permission needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Company IDs |
| `limit` | integer | No | Number of items to include in the page |
| `cursor` | string | No | Cursor for the next or previous page |
| `fieldIds` | array | No | Field IDs for which to return field data |
| `fieldTypes` | array | No | Field Types for which to return field data |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all list entries on a list

**Slug:** `AFFINITY_GET_ALL_LIST_ENTRIES_ON_A_LIST`

Access and export essential data and metadata for Companies, Persons, or Opportunities from a List, specifying data via `fieldIds` or `fieldTypes`. "Export data from Lists" permission is necessary.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of items to include in the page |
| `cursor` | string | No | Cursor for the next or previous page |
| `listId` | integer | Yes | List ID |
| `fieldIds` | array | No | Field IDs for which to return field data |
| `fieldTypes` | array | No | Field Types for which to return field data |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all list entries on a saved view

**Slug:** `AFFINITY_GET_ALL_LIST_ENTRIES_ON_A_SAVED_VIEW`

Use the endpoint to access rows in a Saved View with specific filters and selected fields from a web app. It doesn't maintain sort order, supports only sheet-type views, and requires export permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of items to include in the page |
| `cursor` | string | No | Cursor for the next or previous page |
| `listId` | integer | Yes | List ID |
| `viewId` | integer | Yes | Saved view ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all opportunities

**Slug:** `AFFINITY_GET_ALL_OPPORTUNITIES`

Pagination through Opportunities in Affinity yields basic info but excludes field data. For field data, use specified GET endpoints. "Export data from Lists" permission needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Opportunity IDs |
| `limit` | integer | No | Number of items to include in the page |
| `cursor` | string | No | Cursor for the next or previous page |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all persons

**Slug:** `AFFINITY_GET_ALL_PERSONS`

The Affinity API offers paginated access to Person data using `fieldIds` or `fieldTypes`. Bulk extraction needs special permissions and supports multiple parameters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | People IDs |
| `limit` | integer | No | Number of items to include in the page |
| `cursor` | string | No | Cursor for the next or previous page |
| `fieldIds` | array | No | Field IDs for which to return field data |
| `fieldTypes` | array | No | Field Types for which to return field data |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a person s list entries

**Slug:** `AFFINITY_GET_A_PERSON_S_LIST_ENTRIES`

Summary: Browse rows for a Person in all Lists, showing field data and entry metadata like creation time and author. Requires "Export data from Lists" permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Persons ID |
| `limit` | integer | No | Number of items to include in the page |
| `cursor` | string | No | Cursor for the next or previous page |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a person s lists

**Slug:** `AFFINITY_GET_A_PERSON_S_LISTS`

Returns metadata for all the Lists on which the given Person appears.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Persons ID |
| `limit` | integer | No | Number of items to include in the page |
| `cursor` | string | No | Cursor for the next or previous page |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single company

**Slug:** `AFFINITY_GET_A_SINGLE_COMPANY`

Retrieve basic company info and specific field data by using `fieldIds` or `fieldTypes` parameters. Multiple fields can be queried. No field data if parameters aren't specified. Requires "Export All Organizations directory" permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Company ID |
| `fieldIds` | array | No | Field IDs for which to return field data |
| `fieldTypes` | array | No | Field Types for which to return field data |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single opportunity

**Slug:** `AFFINITY_GET_A_SINGLE_OPPORTUNITY`

Get basic details about an Opportunity without field data via provided endpoints. Field data requires using specific list entry APIs and the "Export data from Lists" permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Opportunity ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single person

**Slug:** `AFFINITY_GET_A_SINGLE_PERSON`

Use GET `/v2/persons/fields` with `fieldIds` or `fieldTypes` for detailed data; basic info by default. Request multiple fields at once. "Export All People" permission needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Person ID |
| `fieldIds` | array | No | Field IDs for which to return field data |
| `fieldTypes` | array | No | Field Types for which to return field data |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get current user

**Slug:** `AFFINITY_GET_CURRENT_USER`

Returns metadata about the current user.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get metadata on all lists

**Slug:** `AFFINITY_GET_METADATA_ON_ALL_LISTS`

Returns metadata on Lists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of items to include in the page |
| `cursor` | string | No | Cursor for the next or previous page |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get metadata on a single list

**Slug:** `AFFINITY_GET_METADATA_ON_A_SINGLE_LIST`

Returns metadata on a single List.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `listId` | integer | Yes | List ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get metadata on a single list s fields

**Slug:** `AFFINITY_GET_METADATA_ON_A_SINGLE_LIST_S_FIELDS`

Returns metadata on the Fields available on a single List. Use the returned Field IDs to request field data from the GET `/v2/lists/{listId}/list-entries` endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of items to include in the page |
| `cursor` | string | No | Cursor for the next or previous page |
| `listId` | integer | Yes | List ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get metadata on a single saved view

**Slug:** `AFFINITY_GET_METADATA_ON_A_SINGLE_SAVED_VIEW`

Returns metadata on a single Saved View.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `listId` | integer | Yes | List ID |
| `viewId` | integer | Yes | Saved view ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get metadata on company fields

**Slug:** `AFFINITY_GET_METADATA_ON_COMPANY_FIELDS`

Returns metadata on non-list-specific Company Fields. Use the returned Field IDs to request field data from the GET `/v2/companies` and GET `/v2/companies/{id}` endpoints.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of items to include in the page |
| `cursor` | string | No | Cursor for the next or previous page |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get metadata on person fields

**Slug:** `AFFINITY_GET_METADATA_ON_PERSON_FIELDS`

Returns metadata on non-list-specific Person Fields. Use the returned Field IDs to request field data from the GET `/v2/persons` and GET `/v2/persons/{id}` endpoints.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of items to include in the page |
| `cursor` | string | No | Cursor for the next or previous page |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get metadata on saved views

**Slug:** `AFFINITY_GET_METADATA_ON_SAVED_VIEWS`

Returns metadata on the Saved Views on a List.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of items to include in the page |
| `cursor` | string | No | Cursor for the next or previous page |
| `listId` | integer | Yes | List ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |