[GET] - User Watchlists {Deprecated}

Follow

Use the User Watchlists endpoint to retrieve the list of watchlist for an InsideView Sales user.

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/watchlists

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).  

Query Parameters

Parameter Name Type Required Description
userEmail String Yes Email address of the InsideView Sales user you want to retrieve the list of watchlists for.
The email address should match the one registered in InsideView Sales application for the user.

Responses

HTTP 200

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

Name type Description
watchlists Array Array of watchlists
watchlists>name String Watchlist name
watchlists>id Integer Watchlist Id

application/json example

{
  "watchlists": [
    {
      "name": "Watchlist",
      "id": "2354613"
    },
    {
      "name": "Frequently Viewed",
      "id": "2354614"
    },
    {
      "name": "Interesting Companies",
      "id": "2370613"
    }
  ]
}

application/xml example

<?xml version="1.0" encoding="UTF-8"?>
<watchlists>
  <watchlist>
<id>2354613</id>
<name>Watchlist</name>
</watchlist>
<watchlist>
<id>2354614</id>
<name>Frequently Viewed</name>
</watchlist>
<watchlist>
<id>2370613</id>
<name>Interesting Companies</name>
</watchlist>
</watchlists>

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.

 

Was this article helpful?
0 out of 0 found this helpful
Powered by Zendesk