Mashery API Explorer
Navigate, test, debug dozens of APIs
Discover new APIs from our open data commons of RESTful APIs or contributed from our open source I/O Docs GitHub Project
Klout API
Explore:
Can't find your favorite API in the list? Contact us or head straight to I/O Docs GitHub Project to create your own. We are adding more APIs every week!
Mashery API Network:
Sign In and your API Keys appear automatically
Community Showcase:
Explore APIs contributed from our open source I/O Docs GitHub project
API Credentials
Product Methods
- GETGetProduct/product/:productid/:locale/:currency
Returns detailed product information associated with the requested productId. Could be used on the website to view product details of the product page. - GETGetVariants/variants/:productid/:locale/:currency
Returns child information (ie. possible size and colour combinations) associated with the requested productId. Could be used on the website to edit basket items to change to a different size and colour. - GETGetProductListingBySearchTerm/productlisting/search/:searchTerm/:pageNumber/:sortBy/:locale/:currency
Returns a list of products associated with the requested search term. Basic infomration for each product is returned, along with facets (refinement options), count of items and sort method used. Could be used on the website on the Search page. - GETGetProductListingByCategory/productlisting/category/:category/:pageNumber/:sortBy/:locale/:currency
Returns a list of products associated with the requested cateogry. Basic information for each product is returned, along with facets (refinement options), count of items and sort method used. Could be used on the website on the Category page.
Category Methods
- GETGet SubCategories by CategoryId/subcategorylisting/:category/:sortBy/:locale
Returns a list of categories belonging to the requested category in the sort order specified. Category name, Id, group name (corresponds to grouping on the website), any refining information, value to indicate if it’s available offline and product count for each category is returned. Could be used on the website for the Navigation menu displaying available categories to browse.
Basket Methods
- GETGetBasketForCustomer/basket/:customerGuid/:currency/:locale
Returns the basket for a customer. - POSTAddProductToBasket/basket/:customerGuid/:currency/:locale
Adds a product to a customer's basket. - PUTEditBasketItem/basket/:customerGuid/:currency/:locale
Updates the supplied BasketItem in the customers basket. That item is updated in the ASOS database. It returns a list of products that are in the customers basket. Could be used on the website on the basket page when the customer updates an item in the basket. - DELETEDeleteBasketItem/basket/:customerGuid/:productId/:itemType/:currency/:locale
Deletes the supplied BasketItem from the customers basket. That item is deleted from the ASOS database. It returns a list of products that are in the customers basket. Could be used on the website on the basket page when the customer removes an item from the basket. - POSTMoveBasketToSaveForLater/saveforlater/frombasket/:customerGuid/:currency/:locale
Move the specified basket items to the customers save for later.
SaveForLater Methods
- GETGetSaveForLaterCustomer/saveforlater/:customerGuid/:currency/:locale
Returns a list of products that have been saved for later by the customer represented by the supplied CustomerGuid. - POSTAddProductToSaveForLater/saveforlater/:customerGuid/:currency/:locale
Adds the supplied SaveForLaterItem to the customers SaveForLater. That item is saved to the ASOS database. It returns a list of products that the customer has saved for later. - PUTUpdateProductInSaveForLater/saveforlater/:customerGuid/:currency/:locale
Updates the supplied SaveForLaterItem in the customers saveforlater list. That item is updated in the ASOS database. It returns a list of products that are in the customers saveforlater list. - DELETEDeleteProductFromSaveForLater/saveforlater/:customerGuid/:productId/:itemType/:currency/:locale
Deletes the supplied SaveForLaterItem from the customers SaveForLater list. That item is deleted from the ASOS database. It returns a list of products that are in the customers SaveForLater list. - DELETEDeleteVariantFromSaveForLater/saveforlater/:customerGuid/:productId/:variantId/:currency/:locale
Deletes the supplied SaveForLaterItem variantfrom the customers SaveForLater list. That item variant is deleted from the ASOS database. It returns a list of products that are in the customers SaveForLater list. - POSTMoveSaveForLaterToBasket/basket/fromsaveforlater/:customerGuid/:currency/:locale
Moves the supplied SaveForLaterItem to the customers basket The item is updated in the ASOS database. Returns a list of products that are in the customers basket, and items that are in their ‘Save for Later’ list.
OPEN Forum API Methods
- GETMost Recent/summaries/most-recent
The Most Recent method will return summaries of the most recent pieces of content on OPEN Forum. - GETMost Viewed/summaries/most-viewed
The Most Viewed method will return summaries of the most viewed pieces of content on OPEN Forum. - GET/summaries/most-commented
The Most Commented method will return summaries of the most commented pieces of content on OPEN Forum. - GET/summaries/most-shared
The Most Shared method will return summaries of the most shared pieces of content on OPEN Forum. - GET/articles/detail
The Article Details method will return full details of a specific article on OPEN Forum. - GET/videos/detail
The Video Details method will return full details of a specific video on OPEN Forum.
Book Requests
- GETISBN Lookup/book/isbn/:isbn/format/:format
Look up a specific book by ISBN. Wildcard searches are not permitted. Either 13 or 10 digit ISBNs are accepted. Dashes are optional. - GETBook Id Lookup/book/id/:id/format/:format
Look up a specific book by Bookshare Id. - GETFull Text Search/book/searchFTS/:text/page/:page/limit/:limit/format/:format
Search for books based on the supplied text matching author, title or content in the book. Note that our search engine defaults to phonetic matching, so you may get results that differ in spelling from your search terms. To prevent the use of phonetic matching or word stemming (e.g. cars matches car), enclose your search term in URL encoded quotes (%22). - GETTitle Search/book/search/title/:text/page/:page/limit/:limit/format/:format
Search for books based on the supplied text matching the title. Note that our search engine defaults to phonetic matching, so you may get results that differ in spelling from your search terms. To prevent the use of phonetic matching or word stemming (e.g. cars matches car), enclose your search term in URL encoded quotes (%22). - GETAuthor Search/book/search/author/:text/page/:page/limit/:limit/format/:format
Search for books based on the supplied text matching the author. Note that our search engine defaults to phonetic matching, so you may get results that differ in spelling from your search terms. To prevent the use of phonetic matching or word stemming (e.g. cars matches car), enclose your search term in URL encoded quotes (%22). - GETTitle/Author Search/book/search/:text/page/:page/limit/:limit/format/:format
Search for books based on the supplied text matching the title or author. Note that our search engine defaults to phonetic matching, so you may get results that differ in spelling from your search terms. To prevent the use of phonetic matching or word stemming (e.g. cars matches car), enclose your search term in URL encoded quotes (%22). - GETDate Published Search/book/search/since/:date/page/:page/limit/:limit/format/:format
Search for books that have been published live on Bookshare on or since the given date. - GETBrowse Latest/book/latest/page/:page/limit/:limit/format/:format
List books that have been published live on Bookshare within the last week. This is essentially a convenience method for the Date Published Search listed above that defaults to the latest week. - GETBrowse Popular/book/popular/page/:page/limit/:limit/format/:format
Search for books that have been downloaded the most times on Bookshare. - GETCategory List/reference/category/list
Get a list of available book categories - GETCategory Search/book/search/category/:category/page/:page/limit/:limit/format/:format
Search for books based on the category (see Category List to get valid category values) - GETGrade List/reference/grade/list/page/:page/limit/:limit/format/:format
Get a list of available grade categories - GETGrade Search/book/search/grade/:grade/page/:page/limit/:limit/format/:format
Search for books based on target grade level (see Grade List to get valid grade values) - GETCombining Multiple Search Criteria/book/search/grade/:grade/category/:category/page/:page/limit/:limit/format/:format
You can combine multiple search criteria, such as category, grade, title, author and full text search The results set is the intersection of the criteria (i.e. AND operator). Note title and author cannot be combined together.
Newspaper / Magazine Requests
- GETPeriodical List Search/periodical/list/page/:page/limit/:limit/format/:format
Get the list of periodicals available - GETPeriodical Edition Search/periodical/id/:id/page/:page/limit/:limit/format/:format
Look up the available editions, including revision numbers, of a given periodical that are in the Bookshare repository - GETPeriodical Edition Lookup/periodical/id/:id/edition/:date/revision/:revision
Look up metadata about a given revision of a given edition of a specific periodical in the Bookshare repository. Revision is optional; if not specified, the default (latest) revision will be provided.
Model Year Repository
- GETfindbyid/vehicle//modelyearrepository/findbyid
Get details on a specifc vehicle by its model year ID. - GETfinddistinctyearwithnew/vehicle/modelyearrepository/finddistinctyearwithnew
Get a list of years under which there are new vehicle listings. - GETfinddistinctyearwithneworused/vehicle/modelyearrepository/finddistinctyearwithneworused
Get a list of years under which there are new or used vehicle listings. - GETfinddistinctyearwithused/vehicle/modelyearrepository/finddistinctyearwithused
Get a list of years under which there are used vehicle listings. - GETfindfuturemodelyearsbymodelid/vehicle/modelyearrepository/findfuturemodelyearsbymodelId
Get a list of future model years by the model ID. - GETfindmodelyearsbymakeandyear/vehicle/modelyearrepository/findmodelyearsbymakeandyear
Get a list of model years for a specific make and year. - GETfindmodelyearsbymakemodel/vehicle/modelyearrepository/findmodelyearsbymakemodel
Get a list of model years for a specific make and model - GETfindnewandusedmodelyearsbymakeidandyear/vehicle/modelyearrepository/findnewandusedmodelyearsbymakeidandyear
Get a list of new and used model years for a specific make ID and year - GETfindnewmodelyearsbymodelid/vehicle/modelyearrepository/findusedmodelyearsbymodelid
Get a list of new model years by the model ID. - GETfindusedmodelyearsbymodelid/vehicle/modelyearrepository/findusedmodelyearsbymodelid
Get a list of used model years by the model ID - GETfindyearsbycategoryandpublicationstate/vehicle/modelyearrepository/findyearsbycategoryandpublicationstate
Get a list of model years for a specific category and publication state - GETformodelid/vehicle/reference/category/list
Get a list of model years by the model ID - GETformakemodelyear/vehicle/modelyearrepository/formakemodelyear
Get a list of model years for a specific make, model and year
Make Repository
- GETfindall/vehicle/makerepository/findall
Get the list of all makes and their all their models - GETfindbyid/vehicle/makerepository/findbyid
Find a make and its models by providing a make ID - GETfindfuturemakes/vehicle/makerepository/findfuturemakes
Find all future makes and their models - GETfindmakebyname/vehicle/makerepository/findmakebyname
Find a make details by its name - GETfindmakesbymodelyear/vehicle/makerepository/findmakesbymodelyear
Find a make by a year - GETfindmakesbypublicationstate/vehicle/makerepository/findmakesbypublicationstate
Find makes by their state (new or used) - GETfindnewandused/vehicle/makerepository/findnewandused
Find all new and used makes - GETfindnewandusedmakesbymodelyear/vehicle/makerepository/findnewandusedmakesbymodelyear
Find all new and used makes for a particular year - GETfindnewandusedmakesbymodelyear/vehicle/makerepository/findnewandusedmakesbymodelyear
Find all new and used makes for a particular year - GETfindnewmakes/vehicle/makerepository/findnewmakes
Find only new makes - GETfindusedmakes/vehicle/makerepository/findusedmakes
Find only used makes
Style Repository
- GETfindbyid/vehicle/stylerepository/findbyid
Get style details by the style ID - GETfindstylesbymakemodelyear/vehicle/stylerepository/findstylesbymakemodelyear
Get the list of all makes and their all their models - GETfindstylesbymodelyearid/vehicle/stylerepository/findstylesbymodelyearid
Get a list of styles by model year ID
True Cost to Own
- GETnewtruecosttoownbystyleidandzip/tco/newtruecosttoownbystyleidandzip/:styleid/:zip
Get the True Cost to Own value for a new vehicle by Style ID and ZIP code - GETusedtruecosttoownbystyleidandzip/tco/usedtruecosttoownbystyleidandzip/:styleid/:zip
Get the True Cost to Own value for a used vehicle by Style ID and ZIP code - GETnewtotalcashpricebystyleidandzip/tco/newtotalcashpricebystyleidandzip/:styleid/:zip
The Total Cash Price displayed is the vehicle's True Market Value® (TMV®) price plus typically equipped options, destination charge, base tax and fees assessed by your state, and, if applicable, gas guzzler tax; less any widely available manufacturer-to-customer cash rebates. (However, we do not account for other types of cash rebates or incentives because of the variability of those offers and their eligibility requirements. - GETusedtotalcashpricebystyleidandzip/tco/usedtotalcashpricebystyleidandzip/:styleid/:zip
The Total Cash Price displayed is the vehicle's True Market Value® (TMV®) price plus typically equipped options, destination charge, base tax and fees assessed by your state, and, if applicable, gas guzzler tax; less any widely available manufacturer-to-customer cash rebates. (However, we do not account for other types of cash rebates or incentives because of the variability of those offers and their eligibility requirements. - GETgetmakeswithtcodata/tco/getmakeswithtcodata
Get a list of all makes that have a True Cost to Own data. - GETgetmodelswithtcodata/tco/getmodelswithtcodata
Get a list of all models that have a True Cost to Own data. - GETgetstyleswithtcodatabysubmodel/tco/getstyleswithtcodatabysubmodel
Get a list of all styles that have a True Cost to Own data.
True Market Value
- GETcalculatenewtmv/tmv/tmvservice/calculatenewtmv
Get the True Market Value ® for a particular new vehicle - GETcalculateusedtmv/tmv/tmvservice/calculateusedtmv
Get the True Market Value ® for a particular used vehicle - GETcalculatetypicallyequippedusedtmv/tmv/tmvservice/calculateusedtmv
Get the True Market Value ® for a typically equipped used vehicle - GETfindcertifiedpriceforstyle/tmv/tmvservice/findcertifiedpriceforstyle
Get the Certified Price for a particular vehicle by style ID - GETfindcpoyearsbymake/tmv/tmvservice/findcpoyearsbymake
Get the Certified Pre-Owned years for a specific vehicle Make ID
Incentive Repository
- GETfindbyid/incentive/incentiverepository/findbyid
Find an incentive by incentive ID - GETfindincentivesbycategoryandzipcode/incentive/incentiverepository/findincentivesbycategoryandzipcode
Find all incentives for a particular vehicle category and ZIP code - GETfindincentivesbymakeid/incentive/incentiverepository/findincentivesbymakeid
Find all incentives for a particular vehicle make ID - GETfindincentivesbymakeidandzipcode/incentive/incentiverepository/findincentivesbymakeidandzipcode
Find all incentives for a particular make ID and ZIP code - GETfindincentivesbymodelyearidandzipcode/incentive/incentiverepository/findincentivesbymodelyearidandzipcode
Find all incentives for particular model year ID and ZIP code - GETfindincentivesbystyleid/incentive/incentiverepository/findincentivesbystyleid
Find all incentives for a particular style ID - GETfindincentivesbystyleidandzipcode/incentive/incentiverepository/findincentivesbystyleidandzipcode
Find all incentives for a particular style ID and ZIP code
Photo Repository
- GETfindphotosbystyleid/vehiclephoto/service/findphotosbystyleid
Get an array of photo detail objects for a particular vehicle style
Leagues
- GETleagues/basic/api/leagues
This collection method returns a list of league ids and names. No parameters are required (other than auth key) - GETleagues/:id/basic/api/leagues/:id
Returns detailed information about a single league member, specified by the id parameter below.
Conferences
- GETconferences/basic/api/:parent_resource/:resource_id/conferences
This collection method returns a list of league ids and names.. - GETconferences/:id/basic/api/:parent_resource/:resource_id/conferences/:id
Returns detailed information about a single conference member, specified by the parameters below.
Divisions
- GETdivisions/basic/api/:parent_resource/:resource_id/divisions
This collection method returns a list of division ids and names, specified by the parent_resource and resource_id parameters belows. - GETdivisions/:id/basic/api/:parent_resource/:resource_id/divisions/:id
Returns detailed information about a single division member, specified by the parameters below..
Teams
- GETteams/basic/api/:parent_resource/:resource_id/teams
This collection method returns a list of team ids and names, specified by the parent_resource and resource_id parameters below. - GETteams/:id/basic/api/:parent_resource/:resource_id/teams/:id
Returns detailed information about a single team member, specified by the parameters below. - GETteams/:id/roster/basic/api/:parent_resource/:resource_id/teams/:id/roster
Returns a player roster for a single team member, specified by the parameters below. - GETteams/:id/standings/basic/api/:parent_resource/:resource_id/teams/:id/standings
Returns standings for a single team member, specified by the parameters below.
Persons
- GETpersons/basic/api/:parent_resource/:resource_id/persons
This collection method returns a list of person ids and names, specified by the parent_resource and resource_id parameters belows. - GETpersons/:id/basic/api/:parent_resource/:resource_id/persons/:id
Returns detailed information about a single team member, specified by the parameters below.
Geo
- GETgeo/basic/api/geo
This collection method returns a list of locations and ids, specified by a lat and long or query. - GETgeo/:id/basic/api/geo/:id
Returns detailed information about a single location member, specified by the parameters below. - GETgeo/:id/teams/basic/api/geo/:id/teams
This collection action returns a list of teams and ids for a given location. - GETgeo/:id/content/basic/api/geo/:id/teams
This collection action returns a list of content items and ids for a given location.
Events
- GETevents/basic/api/:parent_resource/:resource_id/events
This collection method returns a list of event ids and names, specified by the parent_resource and resource_id parameters below. - GETevents/:id/basic/api/:parent_resource/:resource_id/events/:id
Returns detailed information about a single event member including scores, specified by the parameters below. - GETevents/:id/boxscore/basic/api/:parent_resource/:resource_id/events/:id/boxscore
Returns a complete boxscore for a single event member, specified by the parameters below. - GETevents/:id/recap/basic/api/:parent_resource/:resource_id/events/:id/recap
Returns a complete recap for a single event member, specified by the parameters below. - GETevents/today/basic/api/:parent_resource/:resource_id/events/today
This collection action returns a list of event ids and names for events currently in progress, about to start, or just ended, specified by the parent_resource and resource_id parameters below. - GETevents/next/basic/api/:parent_resource/:resource_id/events/next
This collection action returns a list of event ids and names for the next two weeks of scheduled events, specified by the parent_resource and resource_id parameters below. - GETevents/last/basic/api/:parent_resource/:resource_id/events/last
This collection action returns a list of event ids and names for the last two weeks of scheduled events, specified by the parent_resource and resource_id parameters below. - GETevents/:season_type/basic/api/:parent_resource/:resource_id/events/:season_type
This collection action returns a list of event ids and names for an entire season, preseason, or postseason, specified by the parent_resource and resource_id parameters below.
Content
- GETcontent/basic/api/:parent_resource/:resource_id/content
This collection method returns a list of all content ids and titles, specified by the parent_resource and resource_id parameters belows. - GETcontent/:id/basic/api/:parent_resource/:resource_id/content/:id
Returns detailed information about a single content item, specified by the parameters below. - GETcontent/:filter/basic/api/:parent_resource/:resource_id/content/:filter
This collection action returns a subset of all content ids and titles, specified by the filter parameter below. - GETcontent/:id/related/basic/api/:parent_resource/:resource_id/content/:id/related
This action returns a set of related information for a single content member, specified by the parameters below.
Sources
- GETsources/basic/api/:parent_resource/:resource_id/sources
This collection method returns a list of content source ids and names for all sources in the system, or a subset specified by a parent_resource. - GETsources/:id/basic/api/:parent_resource/:resource_id/sources/:id
Returns detailed information about a single content source member, specified by the id parameter below.
Trending
- GETteams/basic/api/:parent_resource/:resource_id/teams
This collection method returns a list of the 5 most trending team ids and names in the system, or for a specific parent_resource. - GETpersons/basic/api/:parent_resource/:resource_id/persons
This collection method returns a list of the 5 most trending person ids and names in the system, or for a specific parent_resource.
Hotel APIs
- GETHotel Deals/deal/hotel
The Hotel Deals API delivers data describing hotel 'Deals' discovered on Hotwire.com in the past 24 hours. - GETHotel Shopping/search/hotel
The Hotel Shopping API delivers data describing hotel shopping results similar to those that can be obtained when shopping for hotel rates on Hotwire.com.
Rental Car APIs
- GETRental Car Shopping/search/car
This method allows you to retrieve user objects
Trip Starter APIs
- GETTripStarter Historical Hotel Rates/tripstarter/hotel
This method allows you to retrieve user objects - GETTripStarter Historical Air Fares/tripstarter/air
This method allows you to retrieve user objects
Travel Ticker API
- GETTravel Ticker/deal/travel-ticker
The Travel Ticker Deals API delivers data describing hands-selected travel deals available from the Hotwire Group's Travel Ticker service
Score Methods
- GETKlout Score/klout.:format
Retrieve a user's Klout score
User Methods
- GETShow User/users/show.:format
Retrieve user objects - GETTopics/users/topics.:format
Retrieve the top 3 topic objects for a given user
Relationship Methods
- GETInfluenced By/soi/influenced_by.:format
Retrieve up to 5 score pairs for users that influence the given user - GETInfluencer Of/soi/influencer_of.:format
Retrieve up to 5 score pairs for users that are influenced by the given user
Find Stories by Location
- GETState/states/:state/stories
Retrieve stories for any U.S. state. - GETCity/states/:state/cities/:city/stories
Retrieve stories for a city within a U.S. state. - GETNeighborhood/states/:state/cities/:city/nabes/:neighborhood/stories
Retrieve stories for a neighborhood within a city.
IP Info (Hosted Service)
- GETipinfo/ipinfo/:ipAddress
Returns Quova IP network information and location data
Movie Lists
- GETBox Office/api/public/v1.0/lists/movies/box_office.json
Retrieves Box-Office Movies - GETIn Theaters/api/public/v1.0/lists/movies/in_theaters.json
Retrieves movies currently in theaters - GETOpening Movies/api/public/v1.0/lists/movies/opening.json
Retrieves current opening movies - GETUpcoming Movies/api/public/v1.0/lists/movies/upcoming.json
Retrieves upcoming movies. Results are paginated if they go past the specified page limit
DVD Lists
- GETTop Rentals/api/public/v1.0/lists/dvds/top_rentals.json
Retrieves the current top dvd rentals - GETCurrent Release DVDs/api/public/v1.0/lists/dvds/current_releases.json
Retrieves current release dvds. Results are paginated if they go past the specified page limit - GETNew Release DVDs/api/public/v1.0/lists/dvds/new_releases.json
Retrieves new release dvds. Results are paginated if they go past the specified page limit - GETUpcoming DVDs/api/public/v1.0/lists/dvds/upcoming.json
Retrieves new release dvds. Results are paginated if they go past the specified page limit
Detailed Info
- GETMovies Info/api/public/v1.0/movies/:id.json
Detailed information on a specific movie specified by Id. You can use the movies search endpoint or peruse the lists of movies/dvds to get the urls to movies. - GETCast Info/api/public/v1.0/movies/:id/cast.json
Pulls the complete movie cast for a movie - GETMovie Clips/api/public/v1.0/movies/:id/clips.json
Related movie clips and trailers for a movie - GETMovies Reviews/api/public/v1.0/movies/:id/reviews.json
Retrieves the reviews for a movie. Results are paginated if they go past the specified page limit - GETMovies Similar/api/public/v1.0/movies/:id/similar.json
Shows similar movies for a movie. - GETMovies Alias/api/public/v1.0/movie_alias.json
Provides a movie lookup by an id from a different vendor. Only supports imdb lookup at this time
Search
- GETMovies Search/api/public/v1.0/movies.json
The movies search endpoint for plain text queries. Let's you search for movies!
Top Level Lists
- GETLists Directory/api/public/v1.0/lists.json
Displays the top level lists available in the API. We currently have movie lists and dvd lists available - GETMovie Lists Directory/api/public/v1.0/lists/movies.json
Shows the movie lists we have available - GETDVD Lists Directory/api/public/v1.0/lists/dvds.json
Shows the movie lists we have available
Sierra Trading Post API
- GETBrand List/api/1.0/brands/
Listing of all brands. - GETBrand Details/api/1.0/brand/:brandID/
Individual brand details where [brandID] is the brand's unique identifier - GETBrand Reviews/api/1.0/reviewsbybrand/:brandID/
Brand reviews where [brandID] is the brand's unique identifier. - GETProduct List/api/1.0/products/
Listing of all products; default to 24 items per page. - GETProduct Details/api/1.0/product/:productID/
Individual product details where [productID] is the product's unique identifier. - GETProduct Reviews/api/1.0/reviewsbyproduct/:productID/
Individual product reviews where [productID] is the product's unique identifier. - GETDepartment List/api/1.0/departments/
Listing of all departments starting at the root level then decends to its children. - GETDepartment Details/api/1.0/department/:departmentID/
Individual department detail where [departmentID] is the department's unique identifier. - GETReview Details/api/1.0/review/:reviewID/
Individual review details where [reviewID] is the review's unique identifier. - GETSearch/api/1.0/products/search~:searchTerm/
A basic product search.
What/Where API
- GETFindBusiness/FindBusiness/
This request returns local Canadian businesses that are most relevant to the search criteria. - GETGetBusinessDetails/GetBusinessDetails/
Gets Business Details. - GETFindDealer/FindDealer/
When applicable, this request returns a list of all dealers/franchises/branches for that business. A business with several locations may have a "parent" listing (primary) and one or more "children" listings. - GETGetTypeAhead/GetTypeAhead/
The type ahead call returns search suggestions based on the characters a user has entered. The user can select the suggested term, saving them from having to enter all the characters for their search term. The suggestions for the "what" and the "where" terms are similar but distinct.
Search Methods
- GETData Search (XML)/search/v2/data/xml/
Search data about a person - GETData Search (JSON)/search/v2/data/json/
Search data about a person - GETIdentity Search (XML)/search/v2/identity/xml/
Search all different persons matching a criteria. - GETIdentity Search (JSON)/search/v2/identity/json/
Search all different persons matching a criteria.
Breaking News API
- GETGet Breaking News Categories/categories.svc/
Returns a list of available categories, including category IDs. - GETGet Breaking News Content by Category/categories.svc/:CategoryID
Returns the latest content for a specific category.
Search News API
- GETSearch/search.svc/:role/
The Search News API allows you to perform basic free-text searches of content from the last three days.
Profile Lookups
- GETTwitter Username/twitter/:username
Look up complete profile by Twitter username - GETFacebook ID/facebook/:id
Look up complete profile by Facebook numeric ID - GETFacebook Username/facebook/username/:username
Look up complete profile by Facebook username - GETE-mail Address/email/:email
Look up complete profile by e-mail address
Service Lookups
- GETTwitter Username/twitter/:username/services
Look up service list by Twitter username - GETFacebook ID/facebook/:id/services
Look up service list by Facebook numeric ID - GETFacebook Username/facebook/username/:username/services
Look up service list by Facebook username - GETE-mail Address/email/:email/services
Look up service list by e-mail address
Movie
- GETdata/v1/movie/info
Returns basic information about a movie or TV series. Please set a value for movie, or cosmoid, or movieid. - GETdata/v1/movie/cast
Returns information about cast members with links to images. Please set a value for movie, or cosmoid, or movieid. - GETdata/v1/movie/crew
Returns information about crew members with links to images. Please set a value for movie, or cosmoid, or movieid. - GETdata/v1/movie/images
Returns URLs to images of a movie along with associated image information. Note: Access to images is governed by your subscription level and geographical location. Please set a value for movie, or cosmoid, or movieid. - GETdata/v1/movie/keywords
Returns keywords that apply to a movie and weightings that reflect the relative importance of each keyword. Please set a value for movie, or cosmoid, or movieid. - GETdata/v1/movie/moods
Returns keywords that apply to a movie and weightings that reflect the relative importance of each keyword. Please set a value for movie, or cosmoid, or movieid. - GETdata/v1/movie/related
Returns titles of movies that are related to a movie specified in the request. Please set a value for movie, or cosmoid, or movieid. - GETdata/v1/movie/releases
Returns information about DVDs, Blu-rays, and other movie releases. Please set a value for movie, or cosmoid, or movieid. - GETdata/v1/movie/review
Returns a review of a movie. Please set a value for movie, or cosmoid, or movieid. - GETdata/v1/movie/synopsis
Returns a synopsis of the plot and the name of the author. Please set a value for movie, or cosmoid, or movieid. - GETdata/v1/movie/themes
Returns a list of topics and circumstances that motivate or fit with a movie, along with weightings that reflect the relative importance of each. Please set a value for movie, or cosmoid, or movieid. - GETdata/v1/movie/tones
Returns a list of feelings that motivate or fit with the movie or TV series, along with weightings that reflect the relative importance of each. Please set a value for movie, or cosmoid, or movieid. - GETdata/v1/movie/types
Returns movie subgenres that apply to the movie, along with weightings that reflect the relative importance of each. Please set a value for movie, or cosmoid, or movieid. - GETdata/v1/movie/videos
Returns data for constructing links to movie trailers. Please set a value for movie, or cosmoid, or movieid.
Movie Release
- GETdata/v1/movierelease/info
Returns basic information about a movie release. Please set a value for upcid or moviereleaseid. - GETdata/v1/movierelease/description
Returns the description of a movie release. Please set a value for upcid or moviereleaseid. - GETdata/v1/movierelease/features
Returns the description of a movie release. Please set a value for upcid or moviereleaseid. - GETdata/v1/movierelease/images
Returns URLs to images of a movie release along with associated image information. Note: Access to images is governed by your subscription level and geographical location. Please set a value for upcid or moviereleaseid. - GETdata/v1/movierelease/videos
Returns data for constructing links to trailers of a movie release. Please set a value for upcid or moviereleaseid.
Album
- GETdata/v1/album/info
Returns basic information about an album. Please set a value for album, albumid, amgpopid, or amgclassicalid. - GETdata/v1/album/classicalreview
Returns an editorial review of a classical music album. Please set a value for album, albumid, amgpopid, or amgclassicalid. - GETdata/v1/album/credits
Returns the production credits for an album, a list of the names and roles of the people and groups that produced the album. Please set a value for album, albumid, amgpopid, or amgclassicalid. - GETdata/v1/album/images
Returns URLs to pictures of an album along with associated image information. Note: Access to images is governed by your subscription level and geographical location. Photography credits must be displayed with images. Please set a value for album, albumid, amgpopid, or amgclassicalid. - GETdata/v1/album/moods
Returns a list of terms that describe expressive characteristics of the music, along with weightings that reflect the relative strength of each term. Please set a value for album, albumid, amgpopid, or amgclassicalid. - GETdata/v1/album/primaryreview
Returns the most recent major review of an album. Please set a value for album, albumid, amgpopid, or amgclassicalid. - GETdata/v1/album/releases
Returns information about the releases of an album, including media type and whether it can be purchased. Please set a value for album, albumid, amgpopid, or amgclassicalid. - GETdata/v1/album/styles
Returns a list of musical styles that apply to the music on an album along with weightings that reflect the importance of each style in the music. Please set a value for album, albumid, amgpopid, or amgclassicalid. - GETdata/v1/album/themes
Returns a list of topics, feelings, and circumstances that motivate or fit with the music on an album. Please set a value for album, albumid, amgpopid, or amgclassicalid. - GETdata/v1/album/tracks
Returns information about the songs on a popular music album and the performances on a classical music album. Popular music songs are identified by track IDs; classical music performances are identified by performance IDs. Please set a value for album, albumid, amgpopid, or amgclassicalid.
Composition
- GETdata/v1/composition/info
Returns basic information about a classical music composition. Please set a value for compositionid or amgclassicalid. - GETdata/v1/composition/description
Returns a description of a classical music composition. Please set a value for compositionid or amgclassicalid. - GETdata/v1/composition/parts
Returns the names of the parts or movements of a classical music composition, each of which is recorded as a single track. Please set a value for compositionid or amgclassicalid. - GETdata/v1/composition/releases
Returns a list of album releases that feature a performance of a composition. Please set a value for compositionid or amgclassicalid.
Performance
- GETdata/v1/performance/info
Returns basic information about a classical music performance. Please set a value for performanceid or amgclassicalid. - GETdata/v1/performance/composition
Returns information about a composition played in a classical music performance. Please set a value for performanceid or amgclassicalid. - GETdata/v1/performance/credits
Returns the names and roles of the people, groups, and organizations that contributed to a classical music performance and the album release. Please set a value for performanceid or amgclassicalid. - GETdata/v1/performance/images
Returns URLs to images of an album that contains the recording a classical music performance, along with associated image information. Note: Access to images is governed by your subscription level and geographical location. Photography credits must be displayed with images. Please set a value for performanceid or amgclassicalid. - GETdata/v1/performance/release
Returns information about an album release that contains the recording of a classical music performance. Please set a value for performanceid or amgclassicalid.
Release
- GETdata/v1/release/info
Returns basic information about an LP, CD, DVD, cassette, download, or other release of an album. Please set a value for eanid, upcid, releaseid, amgpopid, or amgclassicalid. - GETdata/v1/release/classicalreview
Returns an editorial review of a classical music album. Please set a value for eanid, upcid, releaseid, amgpopid, or amgclassicalid. - GETdata/v1/release/credits
Returns the names and roles of the people, groups, and organizations that contributed to a release. Please set a value for eanid, upcid, releaseid, amgpopid, or amgclassicalid. - GETdata/v1/release/images
Returns URLs to pictures of the album release along with associated image information. Note: Access to images is governed by your subscription level and geographical location. Photography credits must be displayed with images. Please set a value for eanid, upcid, releaseid, amgpopid, or amgclassicalid. - GETdata/v1/release/moods
Returns a list of terms that describe expressive characteristics of the music, along with weightings that reflect the relative strength of each term. Please set a value for eanid, upcid, releaseid, amgpopid, or amgclassicalid. - GETdata/v1/release/performances
Returns information about the performances on a release of a classical music album. Please set a value for eanid, upcid, releaseid, amgpopid, or amgclassicalid. - GETdata/v1/release/primaryreview
Returns the most recent major review of a release of an album. Please set a value for eanid, upcid, releaseid, amgpopid, or amgclassicalid. - GETdata/v1/release/styles
Returns a list of musical styles relevant to the music on an album release along with weightings that reflect the importance of each style in the music. Please set a value for eanid, upcid, releaseid, amgpopid, or amgclassicalid. - GETdata/v1/release/themes
Returns a list of topics, feelings, and circumstances that motivate or fit with the music on an album release, along with weightings that reflect the relative importance of each. Please set a value for eanid, upcid, releaseid, amgpopid, or amgclassicalid. - GETdata/v1/release/tracks
Returns information about the tracks on a release of an album. Please set a value for eanid, upcid, releaseid, amgpopid, or amgclassicalid.
Song
- GETdata/v1/song/info
Returns basic information about a song. Please set a value for track, trackid, isrcid, muzeid, amgpoptrackid, or amgclassicaltrackid. - GETdata/v1/song/appearances
Returns a list of albums and videos a song track appears on. Please set a value for track, trackid, isrcid, muzeid, amgpoptrackid, or amgclassicaltrackid. - GETdata/v1/song/review
Returns the most recent major review of a song. Please set a value for track, trackid, isrcid, muzeid, amgpoptrackid, or amgclassicaltrackid.
Descriptor
- GETdata/v1/descriptor/moviegenres
Returns the movie genres and subgenres recognized by Rovi DVDs. - GETdata/v1/descriptor/musicgenres
Returns the music genres, subgenres, and styles recognized by Rovi Music. - GETdata/v1/descriptor/styles
Returns descriptions of music styles recognized by Rovi Cloud Services. - GETdata/v1/descriptor/genres
Returns descriptions of genres used in Rovi Cloud Services, plus optional lists of subgenres and musical styles. - GETdata/v1/descriptor/subgenres
Returns descriptions of the subgenres recognized by Rovi Music and Rovi DVDs, plus lists of music styles of music subgenres. - GETdata/v1/descriptor/significantmovies
Returns the top movies and TV shows in a movie genre or subgenre. - GETdata/v1/descriptor/significantsongs
Returns the top songs in a musical genre or subgenre. - GETdata/v1/descriptor/significantartists
Returns the top artists in a musical genre or subgenre. - GETdata/v1/descriptor/significantalbums
Returns the top albums in a musical genre or subgenre - GETdata/v1/descriptor/significantcomposers
Returns the top composers in a classical music subgenre - GETdata/v1/descriptor/significantcompositions
Returns the top compositions in the classical music genre and subgenres
Name
- GETdata/v1/name/info
Returns basic information about a person, group, or organization. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/aliases
Returns other names a person or group has been known by. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/associatedwith
Returns names of people and groups who participated in the work of a person or group. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/classicalbio
Returns names of people and groups who participated in the work of a person or group. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/collaboratorwith
Returns names of people and groups who collaborated with a person or group. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/compositions
Returns a list of classical compositions by a person or group. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/contemporaries
Returns names of people doing comparable work and living during the same time as a person or group. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/discography
Returns a list of albums that a person, group, or organization contributed to. The response can by filtered by type of album. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/filmography
Returns information about the films a person or group contributed to. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/followers
Returns a list of people who followed a person or group and were influenced by them. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/groupmembers
Returns the names of members of a group. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/images
Returns URLs to images of a person or group. Note: Access to images is governed by your subscription level and geographical location. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/influencers
Returns a list of those who influenced a person or group. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/memberof
Returns names of groups that a person has been a member of. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/moods
Returns a list of terms that describe expressive characteristics of the work of a person or group, along with weightings that reflect the relative strength of each term. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/moviebio
Returns a biography of a person or group involved in movies. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/moviestyles
Returns a list of styles relevant to the work of a person or group in movies, along with weightings that reflect the importance of each style. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/musicbio
Returns a biography of a person or group involved in music. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/musiccredits
Returns a list of the music production credits of a person or group. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/musicstyles
Returns a list of the musical styles of a person or group, along with weightings that reflect the importance of each style. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/similars
Returns names of similar people or groups. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/songs
Returns information about the songs a person or group contributed to. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/themes
Returns a list of topics, feelings, and circumstances that motivate or fit with a person, group, or organization, along with weightings that reflect the relative importance of each. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/videos
Returns data for constructing links to music videos and movie trailers that are associated with a person or group. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid. - GETdata/v1/name/web
Returns internet information resources about a person or group. Please specify name, nameid, cosmoid, amgpopid, amgmovieid, or amgclassicalid.
Search
- GETsearch/v2/:endpoint/search
Searches titles or names in Rovi Cloud Services and returns results in order of popularity and similarity to the search query. - GETsearch/v2/:endpoint/filterbrowse
Locates content in Rovi Cloud Services based on field-level criteria and returns results listed in order of relevance.
Recommendations
- GETrecs/v2/:endpoint/similar
Returns similar items in order of similarity and popularity. Please specify a value for albumid, amgvideoid, cosmoprogramid, or nameid.
Movies API
- GETMovie - Main/movie/:section
Returns information based on movie, movie id, cosmoid - GETMovie Info/movie/info
Returns basic information about a movie or TV series plus customized requests for all of the other content that is available through the Movie API. - GETMovie Related/movie/info
Returns basic information about a movie or TV series plus customized requests for all of the other content that is available through the Movie API. - GETMovie Review/movie/info
Returns basic information about a movie or TV series plus customized requests for all of the other content that is available through the Movie API. - GETMovie Synopsis/movie/info
Returns basic information about a movie or TV series plus customized requests for all of the other content that is available through the Movie API.
Movie Releases API
- GETMovie Release Info/movierelease/info
Returns basic information about a movie release plus customized requests for all of the other Movie Release content that is available - GETMovie Release Description/movierelease/description
Returns the description of a movie release. - GETMovie Release Features/movierelease/features
Returns a list of the special features included on a movie release, such as trailers, interviews, and documentaries. - GETMovie Release Images/movierelease/images
Returns URLs to images of a movie release along with associated image information. Note: Access to images is governed by your subscription level and geographical location. - GETMovie Release Videos/movierelease/videos
Returns data for constructing links to trailers of a movie release.
Articles Methods
- GET/articles/topnews/section
Use this to request Top News by section. Default is home - GET/articles/community
Community feeds return content from any one of USA TODAY's blogs in reverse chronological order.
Census Resources
- GET/census/locations
Returns all available ethnicity, housing, population and race information for specified area. - GET/census/ethnicity
Returns an area's ethnic data. Information includes how much of the population identifies as Hispanic or non-Hispanic white, and the USA TODAY Diversity Index. - GET/census/housing
Returns an area's housing data. Information includes the number of housing units, and the percentage of those that are vacant. - GET/census/population
Returns an area's population data. Information includes the total population of an area, average population per square mile, and the percent by which that population has changed since the last census. - GET/census/race
Returns an area's racial data. Information includes the percentage of an area's population that identifies as White, Black, American Indian, Asian, native Hawaiian/Pacific Islander, or mixed race.
Sports Salaries Methods
- GET/salaries/:league
Returns salary data for the MLB, NFL, NBA and NHL leagues.
Hourly Forecast Methods
- GETHourly Forecast by ZIP Code/GetForecastHourly.ashx
Returns forecast information for all available hours for a given US ZIP Code - GETHourly Forecast by Latitude/Longitude/GetForecastHourly.ashx
Returns forecast information for all available hours for a given Latitude/Longitude
Daily Forecast Methods
- GETDaily Forecast by Zip Code/GetForecast.ashx
Returns forecast information for a given US Zip Code - GETDaily Forecast by Latitude/Longitude/GetForecast.ashx
Returns forecast information for a given Latitude/Longitude of a location. - GETDaily Forecast by City code/GetForecast.ashx
Returns forecast information for a given City Code
Location Information Methods
- GETLocation Information by Zip Code/GetLocation.ashx
Returns Location information for a given US Zip Code. - GETLocation Information by City Code/GetLocation.ashx
Returns Location information for a given City Code. - GETLocation Information by Latitude Longitude/GetLocation.ashx
Returns Location information for a given Latitude/Longitude.
Location Search Methods
- GETSearch by String/GetLocationSearch.ashx
Returns a list of all possible location matches for a given search string - GETSearch by City, State and Country/GetLocationSearch.ashx
Returns a list of all possible location matches for any combination of city name, state name and/or country name
Observation Methods
- GETFind by Zip Code/GetObs.ashx
Returns observation information from the closest weather station for a given US Zip Code - GETFind by City Code/GetObs.ashx
Returns observation information from the closest weather station for a given International City Code. - GETFind by Latitude/Longitude/GetObs.ashx
Returns observation information from the closest weather station for a given Latitude/Longitude.
Station List Methods
- GETFind by Zip Code/GetStation.ashx
Returns a list of the closest weather stations for a given US Zip Code - GETFind by City Code/GetStation.ashx
Returns a list of the closest weather stations for a given International City Code - GETFind by Latitude/Longitude/GetStation.ashx
Returns a list of the closest weather stations for a given Latitude/Longitude - GETFind by Bounding Box coordinates/GetStationByBoundingBox.ashx
Returns a list of the closest weather stations for given Bounding Box coordinates
Alert Methods
- GETFind Alerts by Zip Code/GetAlert.ashx
Returns alert information for a given US Zip Code - GETFind Alerts by City Code/GetAlert.ashx
Returns alert information for a given City Code - GETFind Alerts by Latitude/Longitude/GetAlert.ashx
Returns alert information for a given Latitude/Longitude
UV Index Methods
- GETFind UV Index by Zip Code/GetUv.ashx
Returns UV Index information for a given US Zip Code. Currently, this is only available for US locations.
Content Search
- GETArticles/rest/feed/getFeed?url=
Search for articles across the Univision network. The parameters below are combined into a single URL encoded parameter named 'url'.
User
- POSTImportToken/user/importToken
Import a facebook uid and oauth_token combination to allow Whit.li to populate profile, post and interest information automatically at a predetermined schedule. - GETPopulate/user/populate
Request Whit.li to refresh data associated with a given uid and oauth_token pair. - PUTImportGeneric/user/importGeneric
Import a generic profile from a JSON object.
Key
- GETGet/key/get
Get a Whit.li key. A Whit.li key contains information that describes the various traits of a person. Each Whit.li key contains multiple vectors that have detailed information about an individual based on the individuals psycho-social profile. - GETCompare/key/compare
Compare two users based on a given context associated with key vectors and components.
OpenBookAPI
- GETapi/v2/hcapim
Information about changes - GETapi/v2/hcapim
Harper product catalog (eBook, audio book or print) by ISBN, product-ID or partial title or author and the on sale date - GETapi/v2/hcapim
Obtain the first 1000 words of text for a given ISBN - GETapi/v2/hcapim
Obtain product (eBook, audio book or print) detail by ISBN, product-ID or partial title - GETapi/v2/hcapim
Get the author tour information. - GETapi/v2/hcapim
Find related products. - GETapi/v2/hcapim
Get the authors website and RSS url's if available. - GETapi/v2/hcapim
Author Information. Param1 or Param2 are required. Param3 is optional. - GETapi/v2/hcapim
Get the authors global id and locale from full or partial name. - GETapi/v2/hcapim
Get the authors for a given imprint. - GETapi/v2/hcapim
Get the author name and locale from global id. - GETapi/v2/hcapim
Get the author name and locale from local id.
Book Reviews Methods
- GET/reviews/books/recent
Returns the most 25 most recent reviews. The number of reviews returned may be altered using the count parameter. - GET/reviews/books/book/:search
Returns a list of all available book reviews for a given book. - GET/reviews/books/author/:search
Returns detailed review information for all the albums written by a specific artist.
User APIs
- POST/v1/auth
Login the user - POST/v1/user
Create new user - GET/v2/user
Get user info - GET/v1/policy
Get policy info for the user
Send, Receive, Track APIs
- POST/v1/item/send
Get upload URLs of the new items - POST/v1/item/commit/:itemID
Finish upload - GET/v1/item/status
Get upload status (progress) - GET/v1/item/list
Get upload status (progress) - GET/v1/item/count
Get number of sent or received items - GET/v1/item/:itemID
Get item info - POST/v1/item/expiration/:itemID
Change item expiration - DELETE/v1/item/:itemID
Delete item
Storage APIs
- POST/v1/folder
Create a new folder - GET/v1/folder/:folderId
Get folder info - GET/v1/folder/file/:fileId
Get file info for a file in a folder - POST/v1/folder/file/initUpload
Initialize file upload to a folder - POST/v1/folder/file/commitUpload
Commit file upload to a folder
Share APIs
- POST/v1/folder/:folderId/share
Share a folder - GET/v1/folder/:folderId/share
Get folder share info - PUT/v1/folder/:folderId/unshare
Unshare the folder with a user - POST/v1/folder/file/:fileId/send
Send a file from the folder to a user
Companies
- GETDefault/companies/1337
Get the default representation for companies - GETExpanded Simple/companies/1337:(id,name,universal-name,logo-url,square-logo-url,website-url,blog-rss-url,email-domains,twitter-id,size,type,industry,specialties,description,ticker,founded-year,end-year,num-followers,site-company-profile-url,site-company-jobs-url,site-company-products-url)
Make a call with some expanded field selectors for companies - GETExpanded Full/companies/1337:(id,name,universal-name,status,logo-url,square-logo-url,website-url,blog-rss-url,email-domains,twitter-id,employee-count-range,size,type,company-type,industry,industries,specialties,locations,description,ticker,stock-exchange,founded-year,end-year,num-followers,site-company-profile-url,site-company-jobs-url,site-company-products-url,products,updates)
Make a call with all expanded field selectors for companies
Companies Locations
- GETDefault/companies/1337/locations
Make a call for the default resource for companies and Locations - GETExpanded Full/companies/1337:(locations:(description,employee-count-range,address,contact-info))
Make a call with all expanded field selectors for companies and Locations
Companies Products
- GETDefault/companies/1337/products
Make a call for the default resource for companies and Products - GETExpanded Simple/companies/1337:(products:(id,name,creation-timestamp,logo-url,description,features,num-recommendations,website-url,disclaimer,site-company-products-url))
Make a call with some expanded field selectors for companies and Products - GETExpanded Full/companies/1337:(products:(id,name,type,creation-timestamp,logo-url,description,features,video,product-deal,sales-persons,num-recommendations,recommendations,product-category,website-url,disclaimer,site-company-products-url))
Make a call with all expanded field selectors for companies and Products
Companies Updates
- GETDefault/companies/1337/updates
Make a call for the default resource for companies and Updates - GETExpanded Simple/companies/1337:(updates:(timestamp,update-id,update-key,update-type,num-likes))
Make a call with some expanded field selectors for companies and Updates - GETExpanded Full/companies/1337:(updates:(timestamp,update-id,update-key,update-type,update-content,update-comments,updated-fields,num-likes,likes))
Make a call with all expanded field selectors for companies and Updates
Company-Search
- GETDefault/company-search
Get the default representation for company-search - GETExpanded Full/company-search:(suggestions,companies,num-results,facets)
Make a call with all expanded field selectors for company-search
Groups
- GETDefault/groups/4058745
Get the default representation for groups - GETExpanded Simple/groups/4058745:(id,name,short-description,description,num-members,other-category,website-url,site-group-url,locale,small-logo-url,large-logo-url)
Make a call with some expanded field selectors for groups - GETExpanded Full/groups/4058745:(id,name,short-description,description,num-members,relation-to-viewer,category,other-category,website-url,site-group-url,locale,visibility,directory-presence,group-memberships,posts,small-logo-url,large-logo-url)
Make a call with all expanded field selectors for groups
Groups Group-Memberships
- GETDefault/groups/4058745/group-memberships
Make a call for the default resource for groups and Group-Memberships - GETExpanded Full/groups/4058745:(group-memberships:(person,group,membership-state,contact-email,email-digest-frequency,posts))
Make a call with all expanded field selectors for groups and Group-Memberships
Groups Posts
- GETDefault/groups/4058745/posts
Make a call for the default resource for groups and Posts - GETExpanded Simple/groups/4058745:(posts:(id,title,summary,creation-timestamp,site-group-post-url))
Make a call with some expanded field selectors for groups and Posts - GETExpanded Full/groups/4058745:(posts:(id,parent-group,type,attachment,content,attachments,category,creator,title,summary,creation-timestamp,site-group-post-url,relation-to-viewer,likes,comments))
Make a call with all expanded field selectors for groups and Posts
Job-Search
- GETDefault/job-search
Get the default representation for job-search - GETExpanded Full/job-search:()
Make a call with all expanded field selectors for job-search
Jobs
- GETDefault/jobs/1827673
Get the default representation for jobs - GETExpanded Simple/jobs/1827673:(id,partner-id,partner-job-id,contract-id,customer-job-code,expiration-timestamp,salary,referral-bonus,tracking-pixel-url,site-job-url,description,description-snippet,location-description,posting-timestamp,skills-and-experience)
Make a call with some expanded field selectors for jobs - GETExpanded Full/jobs/1827673:(id,partner-id,partner-job-id,contract-id,customer-job-code,expiration-timestamp,expiration-date,company,position,salary,poster,job-poster,referral-fees,referral-bonus,how-to-apply,tracking-pixel-url,site-job-request,site-job-url,description,description-snippet,location-description,location,posting-timestamp,posting-date,skills-and-experience)
Make a call with all expanded field selectors for jobs
Jobs Company
- GETDefault/jobs/1827673/company
Make a call for the default resource for jobs and Company - GETExpanded Simple/jobs/1827673:(company:(id,name,universal-name,logo-url,square-logo-url,website-url,blog-rss-url,email-domains,twitter-id,size,type,industry,specialties,description,ticker,founded-year,end-year,num-followers,site-company-profile-url,site-company-jobs-url,site-company-products-url))
Make a call with some expanded field selectors for jobs and Company - GETExpanded Full/jobs/1827673:(company:(id,name,universal-name,status,logo-url,square-logo-url,website-url,blog-rss-url,email-domains,twitter-id,employee-count-range,size,type,company-type,industry,industries,specialties,locations,description,ticker,stock-exchange,founded-year,end-year,num-followers,followers,following,relation-to-viewer,site-company-profile-url,site-company-jobs-url,site-company-products-url,products,updates,shares))
Make a call with all expanded field selectors for jobs and Company
Jobs Job-Poster
- GETDefault/jobs/1827673/job-poster
Make a call for the default resource for jobs and Job-Poster - GETExpanded Simple/jobs/1827673:(job-poster:(id,auth-token,first-name,last-name,maiden-name,formatted-name,phonetic-first-name,phonetic-last-name,formatted-phonetic-name,headline,email-address,current-status,picture-url,watermarked-picture-url,unwatermarked-picture-url,picture-urls,main-address,industry,industry-id,distance,num-recommenders,current-status-timestamp,last-modified-timestamp,num-connections,summary,specialties,proposal-comments,interests,associations,honors,public-profile-url,email-address-hashes,mfeed-rss-url))
Make a call with some expanded field selectors for jobs and Job-Poster - GETExpanded Full/jobs/1827673:(job-poster:(id,auth-token,first-name,last-name,maiden-name,formatted-name,phonetic-first-name,phonetic-last-name,formatted-phonetic-name,headline,email-address,current-status,current-share,shares,relation-to-viewer,connections,picture-url,watermarked-picture-url,unwatermarked-picture-url,picture-urls,positions,educations,member-url-resources,api-standard-profile-request,site-standard-profile-request,person-activities,member-groups,recommendations-given,recommendations-received,network,account,twitter-accounts,im-accounts,phone-numbers,date-of-birth,main-address,location,industry,industry-id,distance,num-recommenders,current-status-timestamp,last-modified-timestamp,num-connections,summary,specialties,proposal-comments,interests,associations,honors,publications,patents,languages,skills,certifications,honors-awards,test-scores,volunteer,organizations-memberships,courses,projects,applications,api-public-profile-request,site-public-profile-request,public-profile-url,three-current-positions,three-past-positions,email-address-hashes,bound-account-types,suggestions,primary-twitter-account,mfeed-rss-url,mailbox-summary,mailbox,following,articles,group-memberships,topics,role,job-bookmarks,profile-statistics,related-profile-views))
Make a call with all expanded field selectors for jobs and Job-Poster
Jobs Position
- GETDefault/jobs/1827673/position
Make a call for the default resource for jobs and Position - GETExpanded Simple/jobs/1827673:(position:(id,title,summary,description))
Make a call with some expanded field selectors for jobs and Position - GETExpanded Full/jobs/1827673:(position:(id,title,summary,start-date,end-date,company,description,job-functions,industries,skills,job-type,experience-level,location))
Make a call with all expanded field selectors for jobs and Position
People
- GETDefault/people/~
Get the default representation for people - GETExpanded Simple/people/~:(id,first-name,last-name,maiden-name,formatted-name,phonetic-first-name,phonetic-last-name,formatted-phonetic-name,headline,current-status,picture-url,picture-urls,main-address,industry,industry-id,distance,num-recommenders,current-status-timestamp,last-modified-timestamp,num-connections,summary,specialties,proposal-comments,interests,associations,honors,public-profile-url,email-address-hashes,mfeed-rss-url)
Make a call with some expanded field selectors for people - GETExpanded Full/people/~:(id,first-name,last-name,maiden-name,formatted-name,phonetic-first-name,phonetic-last-name,formatted-phonetic-name,headline,current-status,current-share,shares,relation-to-viewer,connections,picture-url,picture-urls,positions,educations,member-url-resources,api-standard-profile-request,site-standard-profile-request,person-activities,recommendations-given,recommendations-received,network,twitter-accounts,im-accounts,phone-numbers,date-of-birth,main-address,location,industry,industry-id,distance,num-recommenders,current-status-timestamp,last-modified-timestamp,num-connections,summary,specialties,proposal-comments,interests,associations,honors,publications,patents,languages,skills,certifications,honors-awards,test-scores,volunteer,organizations-memberships,courses,projects,api-public-profile-request,site-public-profile-request,public-profile-url,three-current-positions,three-past-positions,email-address-hashes,bound-account-types,suggestions,primary-twitter-account,mfeed-rss-url,following,group-memberships,job-bookmarks,related-profile-views)
Make a call with all expanded field selectors for people
People Certifications
- GETDefault/people/~/certifications
Make a call for the default resource for people and Certifications - GETExpanded Full/people/~:(certifications:(id,name,authority,number,start-date,end-date))
Make a call with all expanded field selectors for people and Certifications
People Connections
- GETDefault/people/~/connections
Make a call for the default resource for people and Connections - GETExpanded Simple/people/~:(connections:(id,auth-token,first-name,last-name,maiden-name,formatted-name,phonetic-first-name,phonetic-last-name,formatted-phonetic-name,headline,email-address,current-status,picture-url,watermarked-picture-url,unwatermarked-picture-url,picture-urls,main-address,industry,industry-id,distance,num-recommenders,current-status-timestamp,last-modified-timestamp,num-connections,summary,specialties,proposal-comments,interests,associations,honors,public-profile-url,email-address-hashes,mfeed-rss-url))
Make a call with some expanded field selectors for people and Connections - GETExpanded Full/people/~:(connections:(id,auth-token,first-name,last-name,maiden-name,formatted-name,phonetic-first-name,phonetic-last-name,formatted-phonetic-name,headline,email-address,current-status,current-share,shares,relation-to-viewer,connections,picture-url,watermarked-picture-url,unwatermarked-picture-url,picture-urls,positions,educations,member-url-resources,api-standard-profile-request,site-standard-profile-request,person-activities,member-groups,recommendations-given,recommendations-received,network,account,twitter-accounts,im-accounts,phone-numbers,date-of-birth,main-address,location,industry,industry-id,distance,num-recommenders,current-status-timestamp,last-modified-timestamp,num-connections,summary,specialties,proposal-comments,interests,associations,honors,publications,patents,languages,skills,certifications,honors-awards,test-scores,volunteer,organizations-memberships,courses,projects,applications,api-public-profile-request,site-public-profile-request,public-profile-url,three-current-positions,three-past-positions,email-address-hashes,bound-account-types,suggestions,primary-twitter-account,mfeed-rss-url,mailbox-summary,mailbox,following,articles,group-memberships,topics,role,job-bookmarks,profile-statistics,related-profile-views))
Make a call with all expanded field selectors for people and Connections
People Courses
- GETDefault/people/~/courses
Make a call for the default resource for people and Courses - GETExpanded Full/people/~:(courses:(id,name,number,occupation))
Make a call with all expanded field selectors for people and Courses
People Current-Share
- GETDefault/people/~/current-share
Make a call for the default resource for people and Current-Share - GETExpanded Simple/people/~:(current-share:(id,timestamp,comment,title))
Make a call with some expanded field selectors for people and Current-Share - GETExpanded Full/people/~:(current-share:(id,timestamp,visibility,comment,content,source,title,author,attribution,private-message))
Make a call with all expanded field selectors for people and Current-Share
People Educations
- GETDefault/people/~/educations
Make a call for the default resource for people and Educations - GETExpanded Simple/people/~:(educations:(id,school-name,notes,activities,degree,field-of-study))
Make a call with some expanded field selectors for people and Educations - GETExpanded Full/people/~:(educations:(id,school-name,notes,activities,degree,field-of-study,grade,start-date,end-date))
Make a call with all expanded field selectors for people and Educations
People Following
- GETDefault/people/~/following
Make a call for the default resource for people and Following - GETExpanded Full/people/~:(following:(people,companies,industries,news-sources))
Make a call with all expanded field selectors for people and Following
People Group-Memberships
- GETDefault/people/~/group-memberships
Make a call for the default resource for people and Group-Memberships - GETExpanded Full/people/~:(group-memberships:(person,group,membership-state,contact-email,email-digest-frequency,posts))
Make a call with all expanded field selectors for people and Group-Memberships
People Honors-Awards
- GETDefault/people/~/honors-awards
Make a call for the default resource for people and Honors-Awards - GETExpanded Simple/people/~:(honors-awards:(id,name,issuer,description))
Make a call with some expanded field selectors for people and Honors-Awards - GETExpanded Full/people/~:(honors-awards:(id,name,issuer,description,date,occupation))
Make a call with all expanded field selectors for people and Honors-Awards
People Job-Bookmarks
- GETDefault/people/~/job-bookmarks
Make a call for the default resource for people and Job-Bookmarks - GETExpanded Full/people/~:(job-bookmarks:(bookmark-type,apply-timestamp,saved-timestamp,job))
Make a call with all expanded field selectors for people and Job-Bookmarks
People Organizations-Memberships
- GETDefault/people/~/organizations-memberships
Make a call for the default resource for people and Organizations-Memberships - GETExpanded Simple/people/~:(organizations-memberships:(id,name,position-held,description))
Make a call with some expanded field selectors for people and Organizations-Memberships - GETExpanded Full/people/~:(organizations-memberships:(id,name,position-held,description,start-date,end-date,occupation))
Make a call with all expanded field selectors for people and Organizations-Memberships
People Patents
- GETDefault/people/~/patents
Make a call for the default resource for people and Patents - GETExpanded Simple/people/~:(patents:(id,number,title,url,summary))
Make a call with some expanded field selectors for people and Patents - GETExpanded Full/people/~:(patents:(id,status,office,number,title,inventors,date,url,summary))
Make a call with all expanded field selectors for people and Patents
People Person-Activities
- GETDefault/people/~/person-activities
Make a call for the default resource for people and Person-Activities - GETExpanded Simple/people/~:(person-activities:(timestamp,title,body,activity-url,app-id,app-data,content-type))
Make a call with some expanded field selectors for people and Person-Activities - GETExpanded Full/people/~:(person-activities:(recipients,timestamp,title,body,activity-url,app-id,app-data,content-type))
Make a call with all expanded field selectors for people and Person-Activities
People Positions
- GETDefault/people/~/positions
Make a call for the default resource for people and Positions - GETExpanded Simple/people/~:(positions:(id,title,summary,description))
Make a call with some expanded field selectors for people and Positions - GETExpanded Full/people/~:(positions:(id,title,summary,start-date,end-date,company,description,job-functions,industries,skills,job-type,experience-level,location))
Make a call with all expanded field selectors for people and Positions
People Primary-Twitter-Account
- GETDefault/people/~/primary-twitter-account
Make a call for the default resource for people and Primary-Twitter-Account - GETExpanded Full/people/~:(primary-twitter-account:(id,account-type,binding-status,provider-account-id,provider-account-name))
Make a call with all expanded field selectors for people and Primary-Twitter-Account
People Projects
- GETDefault/people/~/projects
Make a call for the default resource for people and Projects - GETExpanded Simple/people/~:(projects:(id,name,description,url))
Make a call with some expanded field selectors for people and Projects - GETExpanded Full/people/~:(projects:(id,name,description,url,members,start-date,end-date,occupation))
Make a call with all expanded field selectors for people and Projects
People Publications
- GETDefault/people/~/publications
Make a call for the default resource for people and Publications - GETExpanded Simple/people/~:(publications:(id,title,url,summary))
Make a call with some expanded field selectors for people and Publications - GETExpanded Full/people/~:(publications:(id,title,publisher,authors,date,url,summary))
Make a call with all expanded field selectors for people and Publications
People Recommendations-Given
- GETDefault/people/~/recommendations-given
Make a call for the default resource for people and Recommendations-Given - GETExpanded Simple/people/~:(recommendations-given:(id,service-category,recommendation-snippet,recommendation-text,recommender-title,web-url))
Make a call with some expanded field selectors for people and Recommendations-Given - GETExpanded Full/people/~:(recommendations-given:(id,recommendation-type,service-category,recommendation-snippet,recommendation-text,recommender,recommender-title,recommendee,recommendee-position,web-url))
Make a call with all expanded field selectors for people and Recommendations-Given
People Recommendations-Received
- GETDefault/people/~/recommendations-received
Make a call for the default resource for people and Recommendations-Received - GETExpanded Simple/people/~:(recommendations-received:(id,service-category,recommendation-snippet,recommendation-text,recommender-title,web-url))
Make a call with some expanded field selectors for people and Recommendations-Received - GETExpanded Full/people/~:(recommendations-received:(id,recommendation-type,service-category,recommendation-snippet,recommendation-text,recommender,recommender-title,recommendee,recommendee-position,web-url))
Make a call with all expanded field selectors for people and Recommendations-Received
People Related-Profile-Views
- GETDefault/people/~/related-profile-views
Make a call for the default resource for people and Related-Profile-Views - GETExpanded Simple/people/~:(related-profile-views:(id,auth-token,first-name,last-name,maiden-name,formatted-name,phonetic-first-name,phonetic-last-name,formatted-phonetic-name,headline,email-address,current-status,picture-url,watermarked-picture-url,unwatermarked-picture-url,picture-urls,main-address,industry,industry-id,distance,num-recommenders,current-status-timestamp,last-modified-timestamp,num-connections,summary,specialties,proposal-comments,interests,associations,honors,public-profile-url,email-address-hashes,mfeed-rss-url))
Make a call with some expanded field selectors for people and Related-Profile-Views - GETExpanded Full/people/~:(related-profile-views:(id,auth-token,first-name,last-name,maiden-name,formatted-name,phonetic-first-name,phonetic-last-name,formatted-phonetic-name,headline,email-address,current-status,current-share,shares,relation-to-viewer,connections,picture-url,watermarked-picture-url,unwatermarked-picture-url,picture-urls,positions,educations,member-url-resources,api-standard-profile-request,site-standard-profile-request,person-activities,member-groups,recommendations-given,recommendations-received,network,account,twitter-accounts,im-accounts,phone-numbers,date-of-birth,main-address,location,industry,industry-id,distance,num-recommenders,current-status-timestamp,last-modified-timestamp,num-connections,summary,specialties,proposal-comments,interests,associations,honors,publications,patents,languages,skills,certifications,honors-awards,test-scores,volunteer,organizations-memberships,courses,projects,applications,api-public-profile-request,site-public-profile-request,public-profile-url,three-current-positions,three-past-positions,email-address-hashes,bound-account-types,suggestions,primary-twitter-account,mfeed-rss-url,mailbox-summary,mailbox,following,articles,group-memberships,topics,role,job-bookmarks,profile-statistics,related-profile-views))
Make a call with all expanded field selectors for people and Related-Profile-Views
People Relation-To-Viewer
- GETDefault/people/~/relation-to-viewer
Make a call for the default resource for people and Relation-To-Viewer - GETExpanded Simple/people/~:(relation-to-viewer:(distance,num-related-connections,suggested-to-follow-score,trending-in-count,trending-in-rank))
Make a call with some expanded field selectors for people and Relation-To-Viewer - GETExpanded Full/people/~:(relation-to-viewer:(distance,connections,num-related-connections,related-connections,suggested-to-follow-score,suggested-to-follow-reason,trending-in-count,trending-in-rank))
Make a call with all expanded field selectors for people and Relation-To-Viewer
People Shares
- GETDefault/people/~/shares
Make a call for the default resource for people and Shares - GETExpanded Simple/people/~:(shares:(id,timestamp,comment,title))
Make a call with some expanded field selectors for people and Shares - GETExpanded Full/people/~:(shares:(id,timestamp,visibility,comment,content,source,title,author,attribution,private-message))
Make a call with all expanded field selectors for people and Shares
People Skills
- GETDefault/people/~/skills
Make a call for the default resource for people and Skills - GETExpanded Full/people/~:(skills:(id,skill,proficiency,years))
Make a call with all expanded field selectors for people and Skills
People Suggestions
- GETDefault/people/~/suggestions
Make a call for the default resource for people and Suggestions - GETExpanded Full/people/~:(suggestions:(pymk,to-follow,test-res,job-suggestions,groups,events))
Make a call with all expanded field selectors for people and Suggestions
People Test-Scores
- GETDefault/people/~/test-scores
Make a call for the default resource for people and Test-Scores - GETExpanded Simple/people/~:(test-scores:(id,name,score,description))
Make a call with some expanded field selectors for people and Test-Scores - GETExpanded Full/people/~:(test-scores:(id,name,score,description,date,occupation))
Make a call with all expanded field selectors for people and Test-Scores
People Three-Current-Positions
- GETDefault/people/~/three-current-positions
Make a call for the default resource for people and Three-Current-Positions - GETExpanded Simple/people/~:(three-current-positions:(id,title,summary,description))
Make a call with some expanded field selectors for people and Three-Current-Positions - GETExpanded Full/people/~:(three-current-positions:(id,title,summary,start-date,end-date,company,description,job-functions,industries,skills,job-type,experience-level,location))
Make a call with all expanded field selectors for people and Three-Current-Positions
People Three-Past-Positions
- GETDefault/people/~/three-past-positions
Make a call for the default resource for people and Three-Past-Positions - GETExpanded Simple/people/~:(three-past-positions:(id,title,summary,description))
Make a call with some expanded field selectors for people and Three-Past-Positions - GETExpanded Full/people/~:(three-past-positions:(id,title,summary,start-date,end-date,company,description,job-functions,industries,skills,job-type,experience-level,location))
Make a call with all expanded field selectors for people and Three-Past-Positions
People Twitter-Accounts
- GETDefault/people/~/twitter-accounts
Make a call for the default resource for people and Twitter-Accounts - GETExpanded Full/people/~:(twitter-accounts:(id,account-type,binding-status,provider-account-id,provider-account-name))
Make a call with all expanded field selectors for people and Twitter-Accounts
People-Search
- GETDefault/people-search
Get the default representation for people-search - GETExpanded Full/people-search:()
Make a call with all expanded field selectors for people-search
Lookup Methods
- GETLookup by Spotify URI/lookup/1/.:format
This method allows you to look up by Spotify URI
Search Methods
- GETSearch by Album/search/1/album.:format
This method allows you to search by Album Name - GETSearch by Artist/search/1/artist.:format
This method allows you to search by Artist Name - GETSearch by Track/search/1/track.:format
This method allows you to search by Track Name
Blocks
- GETGet/blocks.get.:format
Retrieve a list of Blocks with addresses and response codes - GETDelete/blocks.delete.:format
Delete an address from the Block list
Bounces
- GETGet/bounces.get.:format
Retrieve a list of bounces with addresses and response codes, optionally with dates - GETDelete/bounces.delete.:format
Delete an address from the bounce list
Event Notification URL
- GETGet/eventposturl.get.:format
Retrieves the URL that Event Notifications will be POSTed to - GETSet/eventposturl.set.:format
Sets the URL that Event Notifications will be POSTed to - GETDelete/eventposturl.delete.:format
Removes the Event Notifications URL
Filters (Apps)
- GETGet Available Apps/filter.getavailable.:format
List all available apps - GETActivate App/filter.activate.:format
Enables an app - GETDeactivate App/filter.deactivate.:format
Disables an app
Invalid Emails
- GETGet/invalidemails.get.:format
Retrieve a list of invalid emails with addresses and response codes, optionally with dates - GETDelete/invalidemails.delete.:format
Delete an address from the invalid email list
Mail
- GETMail/mail.send.json
Sends a message to one recipient
Parse
- GETGet Current Settings/parse.get.:format
Retrieve the settings already configured for parsing incoming email - GETSet New Entry/parse.set.:format
Specify the hostname and url for parsing incoming emails - GETDelete Entry/parse.delete.:format
Delete the existing settings for parsing incoming emails
Profile
- GETGet/profile.get.:format
Retrieve user profile information - GETUpdate/profile.set.:format
Update user profile information - GETReset Password/password.set.:format
Reset password - GETUpdate Username/profile.setUsername.:format
Updates username used to login to SMTP server and the website. Changes will take effect immediately - GETUpdate Email Address/profile.setEmail.:format
Updates contact email. We send a confirmation to the new email address in order to be validated. Your email address changes when you click on the confirmation link
Spam Reports
- GETGet/spamreports.get.:format
Retrieve a list of spam reports with addresses and response codes, optionally with dates - GETDelete/spamreports.delete.:format
Delete an address from the Spam Reports list
Statistics
- GETGet/stats.get.:format
Retrieve a list of statistics - GETList Categories/stats.get.:format
Retrieve a list of all categories for your account
Unsubscribes
- GETGet/unsubscribes.get.:format
Retrieve a list of unsubscribes, optionally with dates - GETDelete/unsubscribes.delete.:format
Delete an address from the unsubscribe list - GETAdd/unsubscribes.add.:format
Add an address to the unsubscribe list
Blog
- GETList blogs for a specific API key/blog/v1/list.:format
This method will return the list of blogs in JSON or AtomPub format. Please note that the & in the URL isn't necessary. - GETGet information about a specific blog/blog/v1/:guid.:format?
This method will list metadata for a specific blog in a portal. In the future, we may add things like total number of posts, number of pending draft posts, etc here. Please note that the & in the URL isn't necessary. - GETList posts for a specific blog/blog/v1/:guid/posts.:format?
This method will list posts for a specific blog, identified by its GUID. The default listing is for the ten most recent posts, in order from the most recently published backwards. Please note that the & in the URL isn't necessary. - GETList comments for a specific blog/blog/v1/:guid/comments.:format?
This method will list a blog's comments, identified by its GUID. For each comment, return key data, such as the comment GUID, and publication date / time. More data might be added in the future. Please note that the & in the URL isn't necessary. - GETGet information for a specific blog post/blog/v1/posts/:post_guid.:format?
This method will list information for a specific blog post, identified by its GUID. We might return more metadata here in the future. Please note that the & in the URL isn't necessary. - GETList comments for a specific blog post/blog/v1/posts/:post_guid/comments.:format?
This method will list the comments for a specific blog post, identified by its GUID. For each comment, return key data, such as the comment GUID, and publication date / time. More data might be added in the future. Please note that the & in the URL isn't necessary. - GETGet information about a specific comment/blog/v1/comments/:comment_guid.:format?
This method will list metadata and other information about the comment, identified by its GUID. We'll likely add more metadata here in the future. Please note that the & in the URL isn't necessary.
Keywords
- GETGet Keywords from a Portal/keywords/v1/keywords
For a given portal, return the list of keywords in JSON format. - GETGet one Keyword from a Portal/keywords/v1/keywords/:guid
For a given keyword, return information about a single keyword in JSON format. - DELETEDelete a Keyword/keywords/v1/keywords/:guid
Delete a keyword in a given HubSpot Portal.
Leads
- GETSearch Leads/leads/v1/list
This method allows you to retrieve leads by searching for them using various criteria.
Lead Nurturing
- GETGet Campaign Details/nurture/v1/campaigns
This method will return lead nurturing campaign details. You will need to call this method to obtain the GUIDs of your existing Lead Nurturing Campaigns, for use in other methods. If you want to get back inactive campaigns from the API, you should include the optional parameter 'excludeInactive.' Either a 1 or 0 will give you back inactive campaigns. - GETGet Leads in a Campaign/nurture/v1/campaign/:campaignGUID/list
This method will return a list of leads who are associated with the nurturing campaign with specified GUID. - GETGet Campaign History for a Lead/nurture/v1/lead/:leadGUID
This action will give you the Lead Nurturing history of the specified lead, specified by its GUID
Marketing Events
- GETList Marketing Events/events/v1/events
The purpose of this method is to enable developers to access marketing events for a particular HubSpot account or portal - POSTCreate a Marketing Event/events/v1/events
This method creates a marketing event in a HubSpot portal, identified by its GUID.
Prospects
- GETListing Prospects/prospects/v1/timeline
This method allows you to retrieve leads by searching for them - GETGet Prospects by Organization/prospects/v1/timeline/:organization
This method allows you to retrieve organizations or companies that your prospects are coming from. The organization you specify must be an organization matching one on the timeline for this customer. See above timeline method response for an example. - GETSearch for Prospects/prospects/v1/search/:Search
This method allows you to search for prospects via various criteria. There are two main parameters here: Search and query. The Search parameter defines the type of data you're searching for. This can include: 'city', 'region' or 'country'. The query (q) parameter should be the actual search you want to perform.
Settings
- GETList Settings/settings/v1/settings
List settings for a given HubSpot portal, identified by its API key. - PUTUpdate a Setting/settings/v1/settings
Update a setting for a given HubSpot portal, identified by its API key. - DELETEDelete a Setting/settings/v1/settings
Delete a setting for a given HubSpot portal, identified by its API key.
Core API
- GETCompile a CSDLcompile
Compile a filter definition (CSDL). - GETValidate a CSDLvalidate
Validate a CSDL. Identical to the compile action, except it will not store the compiled version in the DataSift database. - GETGet stream DPU costdpu
Retrieve DPU cost information for a stream - GETGet stream interactionsstream
Retrieve up to 200 interactions from a stream (buffered).
Usage stats API
- GETGet usageusage
Get usage information (volume of licensed messages, connections duration) for the last hour/day.
