Web API Documentation
Table of Contents
- Business Endpoints
- Business Detail Endpoints
- Contact Endpoints
- Daily Contact Update Endpoints
- Daily Contact Alert Endpoints
- Business Search Endpoints
- Contact Search Endpoints
General Information
All endpoints are located at https://api.winmo.com/web_api
.
Business Endpoints
Show Business
Returns a business with their details.
Route GET /business
Parameters
Parameter | Type | Description |
---|---|---|
id | Integer | (Required) Business ID |
entity_type | String | (Required) Business Type (company, agency, brand) |
Sample Request
curl -H "Authorization: Bearer TOKEN_HERE" -k https://api.winmo.com/web_api/business?id=6675&entity_type=company
Sample Response
{ "result": [{ "id": 6675, "name": "Taco Bell Corporation", "company_pressroom": "www.tacobell.com/company/newsreleases", "website": "www.tacobell.com", "type": "Public", "employees": 38000, "fiscal_close": "December", "description": "fast food, restaurants", "profile_url": "https://my.winmo.com/hubignite/corporate_profile/6675", "phone": "(949) 863-4500", "industries": { "Food": [ "restaurants" ] }, "location": { "address1": "One Glen Bell Way", "address2": "", "city": "Irvine", "state": "CA", "zip_code": "92618", "country": "USA" }, "agency_relationships": [ { "id": 57126, "name": "R/GA", "brand": { "id": 11426, "name": "Taco Bell" }, "services": [ "AOR", "Digital" ], "status": "Past" } ], "founded": "1962", "contact_count": 47, "revenues": 5652, "contacts": [ { "title": "Chief Executive Officer", "person_id": 45954 }, { "person_id": 152707, "title": "Senior Director, Communications & Engagement" } ], "company_nickname": "TacoBell, YUM, Taco Bell Corp", "media_spend": "$250-500 Million", "stocksymbol": "YUM", "edge_articles": [ { "id": 1461, "tags": null, "published_date": "2007-05-07", "title": "Taco Bell names new CMO", "article_preview": "New hire to cover all communications 'til they're 'good to go'", "article_url": "https://my.winmo.com/hubnews/articles/1461", "featured_video": null, "featured_image": null } ], "notes": "Taco Bell, headquartered in Irvine, CA, is one of the country's top quick-serve Mexican eateries. With locations throughout the U.S., the majority are owned and operated by independent franchisees. Taco Bell is a subsidiary of Yum! Brands. ** NOTE: As a privately held subsidiary of a publicly traded parent company, annual revenue and employee count are not readily available. Therefore, the revenue and employee figures presented below are those of the parent company. **", "naics": "722211", "related_brands": [ { "id": 11426, "name": "Taco Bell" } ], "parent": { "id": 3815, "name": "Yum! Brands" } }] }
Business Detail Endpoints
Show Business Details
Returns a business with their details and list of related contacts.
Route GET /business_details
Parameters
Parameter | Type | Description |
---|---|---|
id | Integer | (Required) Business ID |
entity_type | String | (Required) Business Type (company, agency, brand) |
Sample Request
curl -H "Authorization: Bearer TOKEN_HERE" -k https://api.winmo.com/web_api/business_details?id=6675&entity_type=company
Sample Response
{ "result" : { "employees" : 38000, "id" : 6675, "related_brands" : [ { "name" : "Taco Bell", "id" : 26070 } ], "media_spend" : "312921008.0", "agency_relationships" : [ { "name" : "R/GA", "id" : 57126, "brand" : { "id" : 26070, "name" : "Taco Bell Corporation" }, "status" : "Past", "services" : [ "AOR - digital" ] }, { "services" : [ "media buying & planning" ], "status" : "Past", "brand" : { "id" : 26070, "name" : "Taco Bell Corporation" }, "id" : 6653, "name" : "TracyLocke" } ], "name" : "Taco Bell Corporation", "location" : { "address1" : "One Glen Bell Way", "address2" : "", "zip_code" : "92618", "state" : "CA", "city" : "Irvine", "country" : "USA" }, "industries" : { "Food" : [ "restaurants" ] }, "company_pressroom" : "www.tacobell.com/company/newsreleases", "type" : "Public", "phone" : "(949) 863-4500", "fiscal_close" : "December", "description" : "fast food, restaurants", "stocksymbol" : "YUM", "founded" : "1962", "contact_count" : 47, "contacts" : [ { "title" : "Chief Executive Officer", "email" : "mark.king@yum.com", "asst_phone" : "", "id" : 45954, "lname" : "King", "phone_extension" : null, "fname" : "Mark", "prefix" : "Mr.", "asst_email" : "", "rank" : "Chief", "brands" : [ { "name" : null, "id" : 6675 } ], "asst_name" : "", "location" : { "country" : "USA", "city" : "Irvine", "state" : "CA", "zip_code" : "92618", "address2" : "", "address1" : "One Glen Bell Way" }, "phone" : "", "profile_url" : "https://my.winmo.com/hubignite/contact/45954/" } ], "parent" : { "id" : 3815, "name" : "Yum! Brands" }, "notes" : "Taco Bell, headquartered in Irvine, CA, is one of the country's top quick-serve Mexican eateries. With locations throughout the U.S., the majority are owned and operated by independent franchisees. Taco Bell is a subsidiary of Yum! Brands. ** NOTE: As a privately held subsidiary of a publicly traded parent company, annual revenue and employee count are not readily available. Therefore, the revenue and employee figures presented below are those of the parent company. **", "revenues" : 5652, "website" : "www.tacobell.com", "naics" : "722211", "profile_url" : "https://my.winmo.com/hubignite/corporate_profile/6675/", "company_nickname" : "TacoBell, YUM, Taco Bell Corp" } }
Contact Endpoints
Show Contacts
Returns an array of contacts with their details.
Route GET /contacts
Parameters
Parameter | Type | Description |
---|---|---|
ids | Array of Integers | (Required) Contact IDs |
Sample Request
curl -H "Authorization: Bearer TOKEN_HERE" -k -g "https://api.winmo.com/web_api/contacts?ids[]=563341&ids[]=119"
Sample Response
{ "result": [ { "id": 585200, "fname": "Anna", "lname": "Jennings", "prefix": "Ms.", "email": "anna.jennings@mediacom.com", "asst_name": "", "asst_email": "", "asst_phone": "", "phone": "", "phone_extension": "", "title": "Paid Social Manager", "rank": "Manager", "profile_url": "https://my.winmo.com/hubignite/contact/585200/", "agency": { "id": 4658, "name": "MediaCom", "holding_company": "WPP" }, "location": { "address1": "Three World Trade Center", "address2": "175 Greenwich Street", "city": "New York", "state": "NY", "zip_code": "10007", "country": "USA" }, "brands": [ { "id": 22187, "name": "Bose Corporation" } ] } ] }
Daily Contact Update Endpoints
Show Contact Updates
Returns an array of contacts updated with their details.
Route GET /contacts
Parameters
Parameter | Type | Description |
---|---|---|
days | Integer | (Required) Number of days ago |
Sample Request
curl -H "Authorization: Bearer TOKEN_HERE" -k https://api.winmo.com/web_api/daily_updates/contacts?days_ago=1
Sample Response
{ "result" : [ { "created_date" : "2005-09-30", "email" : "mturk@purdierogers.com", "updated_date" : "2022-03-23", "updated_at" : "2022-03-24T03:30:05.000-04:00", "last_name" : "Turk", "company_or_agency_id" : 17741, "first_name" : "Marybeth", "id" : 2814164, "person_id" : 2013, "created_at" : "2022-03-24T03:30:05.000-04:00", "prefix" : "Ms.", "status" : "updated", "dphone" : "", "dfax" : "(425) 556-7642" }, { "updated_at" : "2022-03-24T03:30:05.000-04:00", "last_name" : "Brill", "created_date" : "2005-09-30", "email" : "judy.brill@tbwachiat.com", "updated_date" : "2022-03-23", "status" : "updated", "dphone" : "(310) 305-5343", "dfax" : "", "company_or_agency_id" : 6861, "first_name" : "Judy", "id" : 2814165, "prefix" : "Ms.", "created_at" : "2022-03-24T03:30:05.000-04:00", "person_id" : 5031 }, { "updated_at" : "2022-03-24T03:30:05.000-04:00", "last_name" : "Anthony", "email" : "matt.anthony@vmlyr.com", "updated_date" : "2022-03-23", "created_date" : "2005-09-30", "dfax" : "", "dphone" : "(212) 210-4742", "status" : "updated", "id" : 2814166, "person_id" : 6032, "created_at" : "2022-03-24T03:30:05.000-04:00", "prefix" : "Mr.", "first_name" : "Matt", "company_or_agency_id" : 7719 } ] }
Daily Contact Alert Endpoints
Show Contact Alerts
Returns an array of alerts and contacts with their details.
Route GET /alerts
Parameters
Parameter | Type | Description |
---|---|---|
days | Integer | (Required) Number of days ago |
Sample Request
curl -H "Authorization: Bearer TOKEN_HERE" -k https://api.winmo.com/web_api/daily_updates/alerts?days_ago=1
Sample Response
{ "result" : { "updates_hash" : { "190992" : { "manual_follow" : {}, "location_industry_follow" : {}, "auto_follow" : { "dv_articles" : { "agencies" : { "39099" : { "entity_name" : "360i, LLC", "entity_id" : 39099, "articles" : [ { "entity_name" : "360i, LLC", "entity_type" : "agency", "article_date" : "2022-03-23T11:19:17.000-04:00", "article_id" : 35510, "article_title" : "Male Gen-Z, Millennial Opps: Heineken launches new campaign", "entity_id" : 39099, "url" : "https://edge.winmo.com/hubnews/articles/35510" } ] }, "15221" : { "entity_name" : "OMD", "articles" : [ { "entity_id" : 15221, "article_title" : "Campaign Imminent: Scholl hires new creative AOR post-acquisition (Score 47)", "url" : "https://edge.winmo.com/hubnews/articles/35501", "article_id" : 35501, "entity_name" : "OMD", "entity_type" : "agency", "article_date" : "2022-03-23T10:45:01.000-04:00" } ], "entity_id" : 15221 } } }, "company_contacts" : { "8469" : { "created" : [], "entity_id" : 8469, "updated" : [ { "update_in_salesforce" : false, "change_details" : [ "Email changed to rsensharma@salesforce.com", "Title changed from 'Product Management, Mobile Platforms - San Francisco' to 'Director, Product Management '", "Job Rank assigned as Director" ], "entity_id" : 435275, "phone" : "", "title" : "Director, Product Management ", "name" : "Mr. Raj SenSharma" } ], "entity_name" : "SalesForce.com, Inc." }, "9695" : { "entity_name" : "Citi", "created" : [], "entity_id" : 9695, "updated" : [ { "email" : "", "update_in_salesforce" : false, "change_details" : [ "Title changed from 'Vice President, Securities Finance Market Risk' to 'Collateral & Market Risk'", "Job Rank assigned as Associate" ], "entity_id" : 520986, "phone" : "", "title" : "Collateral & Market Risk", "name" : "Mr. David Phelan" } ] } } } } }, "user_id" : 190992, "created_at" : "2022-03-24T03:30:40.000-04:00", "id" : 3560760, "updated_at" : "2022-03-24T03:30:40.000-04:00" } }
Business Search Endpoints
Search Businesses
Searches and returns businesses that match or are similar by business name.
Route GET /business_search
Parameters
Parameter | Type | Description |
---|---|---|
name | String | (Required) Business Name |
Sample Request
curl -H "Authorization: Bearer TOKEN_HERE" -k https://api.winmo.com/web_api/business_search?name="Taco Bell"
Sample Response
{ "result" : [ { "name" : "Taco Bell Corporation", "type" : "company", "id" : 6675 }, { "name" : "Taco Bell", "type" : "brand", "id" : 26070 }, { "name" : "Taco Bell Home Originals", "type" : "brand", "id" : 11537 } ] }
Contact Search Endpoints
Search Contacts
Searches and returns contacts that match or are similar by first and last name.
Route GET /contact_search
Parameters
Parameter | Type | Description |
---|---|---|
fname | String | (Required) First Name |
lname | String | (Required) Last Name |
Sample Request
curl -H "Authorization: Bearer TOKEN_HERE" -k https://api.winmo.com/web_api/contact_search?fname=Kevin&lname=Lee"
Sample Response
{ "result" : [ { "id" : 456011, "business_name" : "AKQA", "full_name" : "Kevin Lee" }, { "id" : 74993, "business_name" : "Didit.com", "full_name" : "Kevin Lee" }, { "id" : 137, "business_name" : "AdAsia", "full_name" : "Kevin Lee" }, { "id" : 223479, "business_name" : "Monster Store", "full_name" : "Kevin Lee" } ] }