Affinity

Learn how to use Affinity with Composio

Overview

Enum

AFFINITY

Description

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

Authentication Details

apiKey
stringRequired

Actions

Returns metadata on lists.

Action Parameters

cursor
string
limit
integerDefaults to 100

Action Response

data
object
successful
boolean
error

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.

Action Parameters

id
integerRequired
cursor
string
limit
integerDefaults to 100

Action Response

data
object
successful
boolean
error

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.

Action Parameters

cursor
string
limit
integerDefaults to 100

Action Response

data
object
successful
boolean
error

Returns metadata about the current user.

Action Parameters

Action Response

data
object
successful
boolean
error

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.

Action Parameters

listId
integerRequired
viewId
integerRequired
cursor
string
limit
integerDefaults to 100

Action Response

data
object
successful
boolean
error

Returns metadata on the saved views on a list.

Action Parameters

listId
integerRequired
cursor
string
limit
integerDefaults to 100

Action Response

data
object
successful
boolean
error

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.

Action Parameters

id
integerRequired
fieldIds
array
fieldTypes
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

cursor
string
limit
integerDefaults to 100
ids
array

Action Response

data
object
successful
boolean
error

Summarize company data across all lists, including list-specific fields and metadata like creation date and author. access requires “export data from lists” permission.

Action Parameters

id
integerRequired
cursor
string
limit
integerDefaults to 100

Action Response

data
object
successful
boolean
error

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.

Action Parameters

cursor
string
limit
integerDefaults to 100
ids
array
fieldIds
array
fieldTypes
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

cursor
string
limit
integerDefaults to 100

Action Response

data
object
successful
boolean
error

Returns metadata on a single list.

Action Parameters

listId
integerRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

listId
integerRequired
cursor
string
limit
integerDefaults to 100

Action Response

data
object
successful
boolean
error

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.

Action Parameters

listId
integerRequired
cursor
string
limit
integerDefaults to 100
fieldIds
array
fieldTypes
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

id
integerRequired
fieldIds
array
fieldTypes
array

Action Response

data
object
successful
boolean
error

The affinity api offers paginated access to person data using fieldids or fieldtypes. bulk extraction needs special permissions and supports multiple parameters.

Action Parameters

cursor
string
limit
integerDefaults to 100
ids
array
fieldIds
array
fieldTypes
array

Action Response

data
object
successful
boolean
error

Returns metadata for all the lists on which the given company appears.

Action Parameters

id
integerRequired
cursor
string
limit
integerDefaults to 100

Action Response

data
object
successful
boolean
error

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.

Action Parameters

id
integerRequired

Action Response

data
object
successful
boolean
error

Returns metadata for all the lists on which the given person appears.

Action Parameters

id
integerRequired
cursor
string
limit
integerDefaults to 100

Action Response

data
object
successful
boolean
error

Returns metadata on a single saved view.

Action Parameters

listId
integerRequired
viewId
integerRequired

Action Response

data
object
successful
boolean
error