[GET] - Watchlist Details{Deprecated} – InsideView

Use the Watchlist Details endpoint to retrieve the details of a user watchlist.

Note: In order to be able to use this API, you will need:

a special API key, linked to your InsideView for Sales account
InsideView for Sales admin privileges to generate an "admin" consent to access user data through the API.

See Authentication and Authorization Overview for more details.

Endpoint

GET https://api.insideview.com/api/v1/insighs/watchlist/{watchlistId}

Request

HTTP Headers

Header Name	Type	Required	Description
accessToken	String	Yes	Valid access token with code grant. See Authentication and Authorization Overview for more details.
Accept	String	No	Selects the response's content type. Valid values are application/json and application/xml (default).

URI Parameters

Parameter Name	Type	Required	Description
watchlistId	String	Yes	Id of the watchlist to retrieve the definition of.

Responses

HTTP 200

Returns either a JSON or XML data structure depending on the request Accept header.

Name	type	Description
watchlistId	String	Watchlist id
name	String	Watchist name
companyIds	Array	Array of InsideView company ids
contactIds	Array	Array of InsideView contact ids.

application/json example

{  
    "watchListId":"2670676",
    "name":"My Watchlist",
    "companyIds":[  
        "736233"
    ],
    "contactIds":[  
        "3"
    ],
    "operation":"WATCHLIST_DETAIL"
}

application/xml example

<?xml version="1.0" encoding="UTF-8"?>

HTTP 400

Invalid query parameter(s).

HTTP 401

Unauthorized Error - Cannot use API's without setting a valid accessToken in header.

HTTP 405

Method Not Allowed - Your are not allowed to access this API.

HTTP 404

Invalid ID, record not found.

HTTP 429

Request is throttled.

Articles in this section

[GET] - Watchlist Details{Deprecated}