Sign in

v4

OpenAPI 3.1.02026-07-3186225252.7 KB
companies

Get Company Watchlists By Owner

get/watchlists/companies

Query parameters

company_urnsstring[]

Only show those watchlists that contains company urns

Only show those watchlists that contains company urns

watchlist_type'USER_MANAGED_WATCHLIST' | 'CUSTOMER_MANAGED_WATCHLIST' | 'USER_FAVORITED_ENTITIES' | 'USER_HIDDEN_ENTITIES' | 'CUSTOMER_PORTFOLIO_LIST' | 'CUSTOMER_AFFINITY_SYNCED_LIST' | 'GLOBAL_FIELD_LIST'

Fetch watchlists with specific type. If None is provided, it fetches all

return_company_urnsboolean

Whether the endpoint should return the company ids associated with the watchlist or not.

Whether the endpoint should return the company ids associated with the watchlist or not.

return_company_countboolean

Whether the endpoint should return the number of companies associated with the watchlist or not.

Whether the endpoint should return the number of companies associated with the watchlist or not.

get_team_shared_listboolean

Fetch public watchlists shared by other users in the team

Fetch public watchlists shared by other users in the team

Response

Successful Response

namestring required
shared_with_teamboolean required
user_watchlist_type'USER_MANAGED_WATCHLIST' | 'CUSTOMER_MANAGED_WATCHLIST' | 'USER_FAVORITED_ENTITIES' | 'USER_HIDDEN_ENTITIES' | 'CUSTOMER_PORTFOLIO_LIST' | 'CUSTOMER_AFFINITY_SYNCED_LIST' | 'GLOBAL_FIELD_LIST'
creatorstring nullable
companies_countinteger nullable
named_views_orderstring[]
idstring uuid required
updated_atstring date-time required
created_atstring date-time required
user_relevance_score_influence_typestring nullable