Run in Enrichment Spreadsheet
Use this function as a column step in
deepline enrich.deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=affinity_get_persons:{}' --json
Map payload values to spreadsheet columns with
{{column_name}} placeholders.Input Schema
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
payload.term | string | No | A string used to search all the persons in your team’s address book. This could be an email address, a first name or a last name. | |
payload.with_interaction_dates | string | No | When true, interaction dates will be present on the returned resources. Only persons that have interactions will be returned. | |
payload.with_interaction_persons | string | No | When true, persons for each interaction will be returned. Used in conjunction with with_interaction_dates | |
payload.with_opportunities | string | No | When true, opportunity IDs will be returned for each person. | |
payload.with_current_organizations | string | No | When true, the organization IDs of each person’s current organizations (according to the Affinity Data: Current Organizations column) will be returned. | |
payload.min_first_email_date | string | No | Only returns persons with the first_email above the given value. This would be used with max interation. | |
payload.min_last_email_date | string | No | Only returns persons with the last_email above the given value. This would be used with max interation. | |
payload.min_last_interaction_date | string | No | Only returns persons with the last_interaction above the given value. This would be used with max interation. | |
payload.min_last_event_date | string | No | Only returns persons with the last_event above the given value. This would be used with max interation. | |
payload.min_first_event_date | string | No | Only returns persons with the first_event above the given value. This would be used with max interation. | |
payload.min_next_event_date | string | No | Only returns persons with the next_event above the given value. This would be used with max interation. | |
payload.max_first_email_date | string | No | Only returns persons with the first_email below the given value. This would be used with min interation. | |
payload.max_last_email_date | string | No | Only returns persons with the last_email below the given value. This would be used with min interation. | |
payload.max_last_interaction_date | string | No | Only returns persons with the last_interaction below the given value. This would be used with min interation. | |
payload.max_last_event_date | string | No | Only returns persons with the last_event below the given value. This would be used with min interation. | |
payload.max_first_event_date | string | No | Only returns persons with the first_event below the given value. This would be used with min interation. | |
payload.max_next_event_date | string | No | Only returns persons with the next_event below the given value. This would be used with min interation. | |
payload.page_size | string | No | How many results to return per page. (Default is the maximum value of 500.) | |
payload.page_token | string | No | The next_page_token from the previous response required to retrieve the next page of results. |
Output Schema
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
result.data | object | Yes | Provider response payload. | |
result.meta | object | No | Additional response metadata (status, paging). |
Advanced: Direct CLI
Use direct execution for single payload debugging.
deepline tools execute affinity_get_persons --payload '{}' --json
CLI flags
| Flag | Description |
|---|---|
--json | Print machine-readable output. |
--wait | Wait for terminal provider status when supported. |
--debug | Enable wait mode with additional status/log output. |
--wait-timeout SECONDS | Max seconds to wait in wait mode. |
--poll-interval SECONDS | Polling interval in seconds during wait mode. |
--timeout SECONDS | Request timeout in seconds. |
--connect-timeout SECONDS | Connection timeout in seconds. |
Cost
- Pricing model:
fixed(per call). - Estimated Deepline credits:
0per pricing unit. - Provider-native pricing may still exist outside Deepline credit billing.
- Billing mode:
no_bill.