Affinity
affinityAffinity helps private capital investors to find, manage, and close more deals
Acciones disponibles (20)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Get a company s list entriesAFFINITY_GET_A_COMPANY_S_LIST_ENTRIESAcciónSummarize company data across all lists, including list-specific fields and metadata like creation date and author. access requires "export data from lists" permission.
AFFINITY_GET_A_COMPANY_S_LIST_ENTRIESAcciónSummarize company data across all lists, including list-specific fields and metadata like creation date and author. access requires "export data from lists" permission.
Parámetros de entrada
idintegerObligatorioCompany ID
limitintegerNumber of items to include in the page
cursorstringCursor for the next or previous page
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get a company s listsAFFINITY_GET_A_COMPANY_S_LISTSAcciónReturns metadata for all the lists on which the given company appears.
AFFINITY_GET_A_COMPANY_S_LISTSAcciónReturns metadata for all the lists on which the given company appears.
Parámetros de entrada
idintegerObligatorioCompany ID
limitintegerNumber of items to include in the page
cursorstringCursor for the next or previous page
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get all companiesAFFINITY_GET_ALL_COMPANIESAcciónAffinity 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.
AFFINITY_GET_ALL_COMPANIESAcciónAffinity 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.
Parámetros de entrada
idsinteger[]Company IDs
limitintegerNumber of items to include in the page
cursorstringCursor for the next or previous page
fieldIdsstring[]Field IDs for which to return field data
fieldTypesstring[]Field Types for which to return field data
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get all list entries on a listAFFINITY_GET_ALL_LIST_ENTRIES_ON_A_LISTAcciónAccess 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.
AFFINITY_GET_ALL_LIST_ENTRIES_ON_A_LISTAcciónAccess 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.
Parámetros de entrada
limitintegerNumber of items to include in the page
cursorstringCursor for the next or previous page
listIdintegerObligatorioList ID
fieldIdsstring[]Field IDs for which to return field data
fieldTypesstring[]Field Types for which to return field data
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get all list entries on a saved viewAFFINITY_GET_ALL_LIST_ENTRIES_ON_A_SAVED_VIEWAcciónUse 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.
AFFINITY_GET_ALL_LIST_ENTRIES_ON_A_SAVED_VIEWAcciónUse 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.
Parámetros de entrada
limitintegerNumber of items to include in the page
cursorstringCursor for the next or previous page
listIdintegerObligatorioList ID
viewIdintegerObligatorioSaved view ID
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get all opportunitiesAFFINITY_GET_ALL_OPPORTUNITIESAcciónPagination through opportunities in affinity yields basic info but excludes field data. for field data, use specified get endpoints. "export data from lists" permission needed.
AFFINITY_GET_ALL_OPPORTUNITIESAcciónPagination through opportunities in affinity yields basic info but excludes field data. for field data, use specified get endpoints. "export data from lists" permission needed.
Parámetros de entrada
idsinteger[]Opportunity IDs
limitintegerNumber of items to include in the page
cursorstringCursor for the next or previous page
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get all personsAFFINITY_GET_ALL_PERSONSAcciónThe affinity api offers paginated access to person data using `fieldids` or `fieldtypes`. bulk extraction needs special permissions and supports multiple parameters.
AFFINITY_GET_ALL_PERSONSAcciónThe affinity api offers paginated access to person data using `fieldids` or `fieldtypes`. bulk extraction needs special permissions and supports multiple parameters.
Parámetros de entrada
idsinteger[]People IDs
limitintegerNumber of items to include in the page
cursorstringCursor for the next or previous page
fieldIdsstring[]Field IDs for which to return field data
fieldTypesstring[]Field Types for which to return field data
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get a person s list entriesAFFINITY_GET_A_PERSON_S_LIST_ENTRIESAcciónSummary: 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.
AFFINITY_GET_A_PERSON_S_LIST_ENTRIESAcciónSummary: 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.
Parámetros de entrada
idintegerObligatorioPersons ID
limitintegerNumber of items to include in the page
cursorstringCursor for the next or previous page
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get a person s listsAFFINITY_GET_A_PERSON_S_LISTSAcciónReturns metadata for all the lists on which the given person appears.
AFFINITY_GET_A_PERSON_S_LISTSAcciónReturns metadata for all the lists on which the given person appears.
Parámetros de entrada
idintegerObligatorioPersons ID
limitintegerNumber of items to include in the page
cursorstringCursor for the next or previous page
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get a single companyAFFINITY_GET_A_SINGLE_COMPANYAcciónRetrieve 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.
AFFINITY_GET_A_SINGLE_COMPANYAcciónRetrieve 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.
Parámetros de entrada
idintegerObligatorioCompany ID
fieldIdsstring[]Field IDs for which to return field data
fieldTypesstring[]Field Types for which to return field data
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get a single opportunityAFFINITY_GET_A_SINGLE_OPPORTUNITYAcciónGet 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.
AFFINITY_GET_A_SINGLE_OPPORTUNITYAcciónGet 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.
Parámetros de entrada
idintegerObligatorioOpportunity ID
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get a single personAFFINITY_GET_A_SINGLE_PERSONAcciónUse 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.
AFFINITY_GET_A_SINGLE_PERSONAcciónUse 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.
Parámetros de entrada
idintegerObligatorioPerson ID
fieldIdsstring[]Field IDs for which to return field data
fieldTypesstring[]Field Types for which to return field data
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get current userAFFINITY_GET_CURRENT_USERAcciónReturns metadata about the current user.
AFFINITY_GET_CURRENT_USERAcciónReturns metadata about the current user.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get metadata on all listsAFFINITY_GET_METADATA_ON_ALL_LISTSAcciónReturns metadata on lists.
AFFINITY_GET_METADATA_ON_ALL_LISTSAcciónReturns metadata on lists.
Parámetros de entrada
limitintegerNumber of items to include in the page
cursorstringCursor for the next or previous page
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get metadata on a single listAFFINITY_GET_METADATA_ON_A_SINGLE_LISTAcciónReturns metadata on a single list.
AFFINITY_GET_METADATA_ON_A_SINGLE_LISTAcciónReturns metadata on a single list.
Parámetros de entrada
listIdintegerObligatorioList ID
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get metadata on a single list s fieldsAFFINITY_GET_METADATA_ON_A_SINGLE_LIST_S_FIELDSAcciónReturns 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.
AFFINITY_GET_METADATA_ON_A_SINGLE_LIST_S_FIELDSAcciónReturns 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.
Parámetros de entrada
limitintegerNumber of items to include in the page
cursorstringCursor for the next or previous page
listIdintegerObligatorioList ID
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get metadata on a single saved viewAFFINITY_GET_METADATA_ON_A_SINGLE_SAVED_VIEWAcciónReturns metadata on a single saved view.
AFFINITY_GET_METADATA_ON_A_SINGLE_SAVED_VIEWAcciónReturns metadata on a single saved view.
Parámetros de entrada
listIdintegerObligatorioList ID
viewIdintegerObligatorioSaved view ID
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get metadata on company fieldsAFFINITY_GET_METADATA_ON_COMPANY_FIELDSAcciónReturns 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.
AFFINITY_GET_METADATA_ON_COMPANY_FIELDSAcciónReturns 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.
Parámetros de entrada
limitintegerNumber of items to include in the page
cursorstringCursor for the next or previous page
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get metadata on person fieldsAFFINITY_GET_METADATA_ON_PERSON_FIELDSAcciónReturns 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.
AFFINITY_GET_METADATA_ON_PERSON_FIELDSAcciónReturns 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.
Parámetros de entrada
limitintegerNumber of items to include in the page
cursorstringCursor for the next or previous page
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get metadata on saved viewsAFFINITY_GET_METADATA_ON_SAVED_VIEWSAcciónReturns metadata on the saved views on a list.
AFFINITY_GET_METADATA_ON_SAVED_VIEWSAcciónReturns metadata on the saved views on a list.
Parámetros de entrada
limitintegerNumber of items to include in the page
cursorstringCursor for the next or previous page
listIdintegerObligatorioList ID
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not