HAharmonic
companies

Get Company Watchlists By Owner

Changed on
get/watchlists/companies

Request

Query parameters

company_urnsstring[]

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' | 'CUSTOMER_ATTIO_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.

return_company_countboolean

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

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' | 'CUSTOMER_ATTIO_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

Changes

  • 5bf2a097f65bRevision changes
    • warning

      added the new CUSTOMER_ATTIO_SYNCED_LIST enum value to the // response property for the response status

    • info

      added the enum value CUSTOMER_ATTIO_SYNCED_LIST to the property anyOf[subschema #1: UserWatchlistType]/ of the query request parameter watchlist_type

  • 8a806a9c22f2Revision changes
    • info

      added the optional property /// to the response with the status