> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Affinity

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

![Affinity logo](https://mintcdn.com/composio-preview/qzegrvAapILigeDI/images/toolkits/affinity.svg?fit=max\&auto=format\&n=qzegrvAapILigeDI\&q=85\&s=0b0547af390c0aa104b6585d99467f2b)

* **Category:** crm
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 20
* **Triggers:** 0
* **Slug:** `AFFINITY`
* **Version:** 20261101\_00

## Tools

> [accordion] 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
>
> **id** `integer` *required*
>
> Company ID
>
> **limit** `integer`
>
> Number of items to include in the page
>
> **cursor** `string`
>
> Cursor for the next or previous page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **id** `integer` *required*
>
> Company ID
>
> **limit** `integer`
>
> Number of items to include in the page
>
> **cursor** `string`
>
> Cursor for the next or previous page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get all companies
>
> **Slug:** `AFFINITY_GET_ALL_COMPANIES`
>
> Request paginated company information, optionally filtering by company IDs and specifying field IDs or types. Export permission is needed.
>
> #### Input Parameters
>
> **ids** `array`
>
> Company IDs
>
> **limit** `integer`
>
> Number of items to include in the page
>
> **cursor** `string`
>
> Cursor for the next or previous page
>
> **fieldIds** `array`
>
> Field IDs for which to return field data
>
> **fieldTypes** `array`
>
> Field Types for which to return field data
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get all list entries on a list
>
> **Slug:** `AFFINITY_GET_ALL_LIST_ENTRIES_ON_A_LIST`
>
> Retrieve list entries and entity metadata for companies, persons, or opportunities on a list. The request accepts field IDs or types and requires "Export data from Lists" permission.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of items to include in the page
>
> **cursor** `string`
>
> Cursor for the next or previous page
>
> **listId** `integer` *required*
>
> List ID
>
> **fieldIds** `array`
>
> Field IDs for which to return field data
>
> **fieldTypes** `array`
>
> Field Types for which to return field data
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Number of items to include in the page
>
> **cursor** `string`
>
> Cursor for the next or previous page
>
> **listId** `integer` *required*
>
> List ID
>
> **viewId** `integer` *required*
>
> Saved view ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **ids** `array`
>
> Opportunity IDs
>
> **limit** `integer`
>
> Number of items to include in the page
>
> **cursor** `string`
>
> Cursor for the next or previous page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **ids** `array`
>
> People IDs
>
> **limit** `integer`
>
> Number of items to include in the page
>
> **cursor** `string`
>
> Cursor for the next or previous page
>
> **fieldIds** `array`
>
> Field IDs for which to return field data
>
> **fieldTypes** `array`
>
> Field Types for which to return field data
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **id** `integer` *required*
>
> Persons ID
>
> **limit** `integer`
>
> Number of items to include in the page
>
> **cursor** `string`
>
> Cursor for the next or previous page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **id** `integer` *required*
>
> Persons ID
>
> **limit** `integer`
>
> Number of items to include in the page
>
> **cursor** `string`
>
> Cursor for the next or previous page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **id** `integer` *required*
>
> Company ID
>
> **fieldIds** `array`
>
> Field IDs for which to return field data
>
> **fieldTypes** `array`
>
> Field Types for which to return field data
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **id** `integer` *required*
>
> Opportunity ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get a single person
>
> **Slug:** `AFFINITY_GET_A_SINGLE_PERSON`
>
> Retrieve basic details for a person by ID. Requires "Export All People" permission.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Person ID
>
> **fieldIds** `array`
>
> Field IDs for which to return field data
>
> **fieldTypes** `array`
>
> Field Types for which to return field data
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get current user
>
> **Slug:** `AFFINITY_GET_CURRENT_USER`
>
> Returns metadata about the current user.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get metadata on all lists
>
> **Slug:** `AFFINITY_GET_METADATA_ON_ALL_LISTS`
>
> Returns metadata on Lists.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of items to include in the page
>
> **cursor** `string`
>
> Cursor for the next or previous page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get metadata on a single list
>
> **Slug:** `AFFINITY_GET_METADATA_ON_A_SINGLE_LIST`
>
> Returns metadata on a single List.
>
> #### Input Parameters
>
> **listId** `integer` *required*
>
> List ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Number of items to include in the page
>
> **cursor** `string`
>
> Cursor for the next or previous page
>
> **listId** `integer` *required*
>
> List ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **listId** `integer` *required*
>
> List ID
>
> **viewId** `integer` *required*
>
> Saved view ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Number of items to include in the page
>
> **cursor** `string`
>
> Cursor for the next or previous page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Number of items to include in the page
>
> **cursor** `string`
>
> Cursor for the next or previous page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get metadata on saved views
>
> **Slug:** `AFFINITY_GET_METADATA_ON_SAVED_VIEWS`
>
> Returns metadata on the Saved Views on a List.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of items to include in the page
>
> **cursor** `string`
>
> Cursor for the next or previous page
>
> **listId** `integer` *required*
>
> List ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
