Skip to main content
Affinity logo
  • Category: crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 20
  • Triggers: 0
  • Slug: AFFINITY
  • Version: 20261101_00

Tools

Slug: AFFINITY_GET_A_COMPANY_S_LIST_ENTRIESSummarize 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

integer
required
Company ID
integer
Number of items to include in the page
string
Cursor for the next or previous page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AFFINITY_GET_A_COMPANY_S_LISTSReturns metadata for all the Lists on which the given Company appears.

Input Parameters

integer
required
Company ID
integer
Number of items to include in the page
string
Cursor for the next or previous page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AFFINITY_GET_ALL_COMPANIESRequest paginated company information, optionally filtering by company IDs and specifying field IDs or types. Export permission is needed.

Input Parameters

array
Company IDs
integer
Number of items to include in the page
string
Cursor for the next or previous page
array
Field IDs for which to return field data
array
Field Types for which to return field data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AFFINITY_GET_ALL_LIST_ENTRIES_ON_A_LISTRetrieve 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

integer
Number of items to include in the page
string
Cursor for the next or previous page
integer
required
List ID
array
Field IDs for which to return field data
array
Field Types for which to return field data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AFFINITY_GET_ALL_LIST_ENTRIES_ON_A_SAVED_VIEWUse 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

integer
Number of items to include in the page
string
Cursor for the next or previous page
integer
required
List ID
integer
required
Saved view ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AFFINITY_GET_ALL_OPPORTUNITIESPagination 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

array
Opportunity IDs
integer
Number of items to include in the page
string
Cursor for the next or previous page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AFFINITY_GET_ALL_PERSONSThe Affinity API offers paginated access to Person data using fieldIds or fieldTypes. Bulk extraction needs special permissions and supports multiple parameters.

Input Parameters

array
People IDs
integer
Number of items to include in the page
string
Cursor for the next or previous page
array
Field IDs for which to return field data
array
Field Types for which to return field data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AFFINITY_GET_A_PERSON_S_LIST_ENTRIESSummary: 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

integer
required
Persons ID
integer
Number of items to include in the page
string
Cursor for the next or previous page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AFFINITY_GET_A_PERSON_S_LISTSReturns metadata for all the Lists on which the given Person appears.

Input Parameters

integer
required
Persons ID
integer
Number of items to include in the page
string
Cursor for the next or previous page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AFFINITY_GET_A_SINGLE_COMPANYRetrieve 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

integer
required
Company ID
array
Field IDs for which to return field data
array
Field Types for which to return field data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AFFINITY_GET_A_SINGLE_OPPORTUNITYGet 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

integer
required
Opportunity ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AFFINITY_GET_A_SINGLE_PERSONRetrieve basic details for a person by ID. Requires “Export All People” permission.

Input Parameters

integer
required
Person ID
array
Field IDs for which to return field data
array
Field Types for which to return field data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AFFINITY_GET_CURRENT_USERReturns metadata about the current user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AFFINITY_GET_METADATA_ON_ALL_LISTSReturns metadata on Lists.

Input Parameters

integer
Number of items to include in the page
string
Cursor for the next or previous page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AFFINITY_GET_METADATA_ON_A_SINGLE_LISTReturns metadata on a single List.

Input Parameters

integer
required
List ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AFFINITY_GET_METADATA_ON_A_SINGLE_LIST_S_FIELDSReturns 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

integer
Number of items to include in the page
string
Cursor for the next or previous page
integer
required
List ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AFFINITY_GET_METADATA_ON_A_SINGLE_SAVED_VIEWReturns metadata on a single Saved View.

Input Parameters

integer
required
List ID
integer
required
Saved view ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AFFINITY_GET_METADATA_ON_COMPANY_FIELDSReturns 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

integer
Number of items to include in the page
string
Cursor for the next or previous page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AFFINITY_GET_METADATA_ON_PERSON_FIELDSReturns 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

integer
Number of items to include in the page
string
Cursor for the next or previous page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AFFINITY_GET_METADATA_ON_SAVED_VIEWSReturns metadata on the Saved Views on a List.

Input Parameters

integer
Number of items to include in the page
string
Cursor for the next or previous page
integer
required
List ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not