Authentication
API Key based authentication.
The API Key acts as the username. API keys are per-organization and can be generated and deleted in the Settings page.
API Key Auth lets you build a form to request an API key, along with any additional fields your API requires for authentication. Zapier then passes the data users enter in those fields with every API call.
API Base URL:
Example XHR request with an api key.
Triggers
Campaign
The API fetches the list of active Campaigns.
Campaign API should be passed with API_KEY as request parameter.
Example of Request & response:
[ { "dropdown": true, "id": 324, "key": "campaign", "label": "2nd level marketing campaign", "required": true } ]Leads
Leads API fetches all leads of a user.
Leads API should be passed with API_KEY as request parameter.
Example of Request & response
[ { "campaign": { "auto_approve_leads": true, "campaign_type": "linkedin search", "created_at": "2020-04-17 05:51:54+00:00", "exclude_invited_profiles": true, "exclude_no_photos": false, "excluded_profiles": 0, "get_new_leads": true, "key": 46, "limit_exceeded": null, "max_search_amount": 1000, "name": "Viewing Profiles of 2nd degree Google Employees", "next_search_at": "2020-04-17 12:02:03+00:00", "next_search_index": 0, "num_pending_leads": 0, "num_touches": 1, "open_link_only": false, "premium_only": false, "removed": false, "run_state": "paused", "sales_navigator_url": null, "search_ended": true, "search_parameters": { "connections": { "first": false, "second": false, "third": false }, "currentCompanies": [], "industries": [], "keywords": "", "locations": [], "nonprofitInterests": { "boardService": false, "skilledVounteering": false }, "pastCompanies": [], "profileLanguages": { "english": false, "french": false, "polish": false, "portuguese": false, "russian": false, "spanish": false }, "schools": [], "specifyKeywords": { "company": "", "firstName": "", "lastName": "", "school": "", "title": "" } }, "search_url": "https://www.linkedin.com/search/results/people/?facetCurrentCompany=%5B%221441%22%5D&facetNetwork=%5B%22S%22%5D&origin=FACETED_SEARCH", "status": "active", "team_key": 28, "touch_sequence": { "sequence": [ { "delay_number": 0, "delay_time_unit": "day(s)", "tags": [], "type": "LI View" } ] }, "updated_at": "2020-04-19 10:43:33+00:00", "user_key": 27 }, "connect_followup": false, "conversation_urn": null, "custom_data": {}, "id": "ACoAAA0AScIBPV3AwuzAXDTxmF8pPgfBQQ92ziU", "last_action": { "campaign_key": 46, "campaign_name": "Viewing Profiles of 2nd degree Google Employees", "created_at": "2020-04-17 06:01:19+00:00", "desc": "found", "key": 4434, "msg": null, "msg_created_at": null }, "next_touch_at": null, "next_touch_index": 0, "person": { "angellist_handle": null, "current_employer": null, "current_employer_size": null, "current_title": "Weblant", "email": null, "facebook_handle": null, "first_name": null, "github_handle": null, "gravatar_handle": null, "key": "ACoAAA0AScIBPV3AwuzAXDTxmF8pPgfBQQ92ziU", "last_name": null, "linkedin_data": { "connectionLevel": "2nd", "handle": "shaban-ali-4aa07061", "headline": "Weblant", "location": "Saudi Arabia", "name": "Shaban Ali", "pic": "https://daekjd9c602b4.cloudfront.net/ACoAAA0AScIBPV3AwuzAXDTxmF8pPgfBQQ92ziU.png", "sharedConnections": "4 shared connections", "subHeadline": "", "urn": "ACoAAA0AScIBPV3AwuzAXDTxmF8pPgfBQQ92ziU" }, "linkedin_handle": "shaban-ali-4aa07061", "location": "Saudi Arabia", "name": "Shaban Ali", "personal_email": null, "phone": null, "twitter_handle": null, "work_email": null }, "request_connect_at": null, "return_to_campaign": false, "return_to_campaign_date": null, "status": "approved", "tags": [], "thread_id": null } ]Connections
Connections API fetches all LinkedIn connections of a user.
Connections API should be passed with API_KEY as request parameter.
Example of Request & response
[ { "AIM": null, "BLOG_WEBSITE": null, "COMPANY_WEBSITE": null, "GTALK": null, "ICQ": null, "OTHER_WEBSITE": null, "PERSONAL_WEBSITE": null, "PORTFOLIO_WEBSITE": null, "QQ": null, "RSS_WEBSITE": null, "SKYPE": "", "WECHAT": null, "YAHOO_MESSENGER": null, "address": null, "birthday": null, "companyName": null, "connectedAt": "Mon, 16 Mar 2020 02:46:13 GMT", "conversation_id": null, "degree": 1, "email": "", "entityUrn": "ACoAACzgX3IBM7Jn9BYSesLbHOAM_6QqDml3Y40", "fieldOfStudy": null, "firstName": "Anshitha", "headline": "SEO Analyst at Brihaspathi Technologies Pvt.Ltd", "id": "ACoAACzgX3IBM7Jn9BYSesLbHOAM_6QqDml3Y40", "industryCode": null, "languages": null, "lastName": "sripadha", "locationName": null, "name": "Anshitha sripadha", "notes": null, "objectUrn": "752902002", "openLink": null, "phone": "", "picture": "https://media-exp1.licdn.com/dms/image/C5103AQGkXvdgZjQO9g/profile-displayphoto-shrink_200_200/0?e=1592438400&v=beta&t=syFyGmd3dxs9XlcZ1rHDW6o3ITfdLlob0QuWHXsDwwE", "postalCode": null, "premium": null, "publicIdentifier": "anshitha-sripadha-21618b190", "schoolName": null, "skills": null, "startedMonth": null, "startedYear": null, "tags": [], "tenureMonths": null, "tenureYears": null, "title": null, "trackingId": null, "twitter": "", "versionTag": null } ]Actions
Add Lead to Campaign
The API expects Name, Headline, Location, Picture, LinkedIn profile URL, Campaign Key as request parameters.
This API should be passed with API_KEY as request parameter along with other parameters.
Example of Request & response
POST method
{ "id": 1, "message": "Well done! Your lead was added to your campaign in Alfred.", "success": true }
If you have any questions, don't hesitate to contact our customer support team available 24/7 using the orange chat bubble on your screen. We're always happy to help! 😊
“Feature not available on the Personal plan”