Aimfox

Aimfox integration (Marketing, Communication). Imported from open-connector.

API key11 toolshttps://api.aimfox.com/api/v2

GET

aimfox_list_campaigns

List Aimfox campaigns, optionally filtering by outreach type or profile inserts.

/campaigns

2 parameters

Param	Type	Required	Description
outreach_type	string	optional	The outreach type to filter campaigns by.
accepts_profiles	boolean	optional	Whether to return only campaigns that accept profile inserts.

GET

aimfox_get_campaign

Fetch one Aimfox campaign by campaign ID.

/campaigns/{campaign_id}

1 parameter

Param	Type	Required	Description
campaign_id	string	required	The Aimfox campaign ID.

GET

aimfox_get_campaign_metrics

Fetch interaction metrics for one Aimfox campaign.

/campaigns/{campaign_id}/metrics

1 parameter

Param	Type	Required	Description
campaign_id	string	required	The Aimfox campaign ID.

POST

aimfox_add_profile_to_campaign

Add one LinkedIn profile URL to an Aimfox campaign audience.

/campaigns/{campaign_id}/audience

2 parameters

Param	Type	Required	Description
campaign_id	string	required	The Aimfox campaign ID.
profile_url	string	required	The LinkedIn profile URL to add to the campaign audience.

DELETE

aimfox_remove_profile_from_campaign

Remove one LinkedIn profile from an Aimfox campaign audience by URN or public ID.

/campaigns/{campaign_id}/audience/{urn}

2 parameters

Param	Type	Required	Description
campaign_id	string	required	The Aimfox campaign ID.
urn	string	required	The LinkedIn profile URN or public identifier to remove.

GET

aimfox_get_lead

Fetch one Aimfox lead by lead ID.

/leads/{lead_id}

1 parameter

Param	Type	Required	Description
lead_id	string	required	The Aimfox lead ID.

POST

aimfox_search_leads

Search Aimfox leads with documented facet filters and offset pagination.

14 parameters

Param	Type	Required	Description
keywords	string	optional	Keywords to search for in Aimfox leads.
current_companies	array	optional	Filter values for an Aimfox lead search facet.
past_companies	array	optional	Filter values for an Aimfox lead search facet.
education	array	optional	Filter values for an Aimfox lead search facet.
interests	array	optional	Filter values for an Aimfox lead search facet.
labels	array	optional	Filter values for an Aimfox lead search facet.
languages	array	optional	Filter values for an Aimfox lead search facet.
locations	array	optional	Filter values for an Aimfox lead search facet.
origins	array	optional	Filter values for an Aimfox lead search facet.
skills	array	optional	Filter values for an Aimfox lead search facet.
lead_of	array	optional	Filter values for an Aimfox lead search facet.
optimize	boolean	optional	Whether Aimfox should optimize the lead search.
start	integer	optional	The zero-based offset for the lead search results.
count	integer	optional	The number of lead search results to return.

POST

aimfox_get_total_leads_count

Count Aimfox leads that match the documented lead search filters.

12 parameters

Param	Type	Required	Description
keywords	string	optional	Keywords to search for in Aimfox leads.
current_companies	array	optional	Filter values for an Aimfox lead search facet.
past_companies	array	optional	Filter values for an Aimfox lead search facet.
education	array	optional	Filter values for an Aimfox lead search facet.
interests	array	optional	Filter values for an Aimfox lead search facet.
labels	array	optional	Filter values for an Aimfox lead search facet.
languages	array	optional	Filter values for an Aimfox lead search facet.
locations	array	optional	Filter values for an Aimfox lead search facet.
origins	array	optional	Filter values for an Aimfox lead search facet.
skills	array	optional	Filter values for an Aimfox lead search facet.
lead_of	array	optional	Filter values for an Aimfox lead search facet.
optimize	boolean	optional	Whether Aimfox should optimize the lead search.

GET

aimfox_list_recent_leads

List recent Aimfox lead transition events for the workspace.

/analytics/recent-leads

GET

aimfox_list_interactions

List Aimfox interaction buckets for a timestamp range.

/analytics/interactions

5 parameters

Param	Type	Required	Description
bucket	string	required	The interval used to group interaction metrics.
from	integer	required	The range start timestamp in milliseconds.
to	integer	required	The range end timestamp in milliseconds.
account_ids	array	optional	Aimfox account IDs to filter interactions by.
campaign_id	string	optional	The Aimfox campaign ID to filter interactions by.

GET

aimfox_list_workspace_labels

List labels configured in the Aimfox workspace.

/labels