Another API description

Resources

Account analytic distribution reports

Resource Description
GET /api/v2/account-analytic-distribution-reports List Insight Providers detailed QVA Reports

Account uploads

Resource Description
POST /api/v2/account-uploads Create account upload

Accounts
Account

Resource Description
GET /api/v2/accounts List accounts
GET /api/v2/accounts/:id Show an account
PATCH /api/v2/accounts/:id Update an account
PATCH /api/v2/accounts/:id/follow Follow Insight Provider Account
PATCH /api/v2/accounts/:id/unfollow Unfollow Insight Provider Account
PATCH /api/v2/accounts/:id/follow_accounts Add followings to the account

Activities
Company's activities

Resource Description
GET /api/v2/activities List Company's activities
POST /api/v2/activities Create an activity

Activity alert names
List of Activity Alert Names

Resource Description
GET /apiv2/activity-alert-names List of activity alert names

Activity alerts
Compliance Offcier's Activity Alerts

Resource Description
GET /apiv2/activity-alerts List activity alerts
GET /apiv2/activity-alerts/:id Show an activity alert
POST /apiv2/activity-alerts Create an activity alert
PATCH /apiv2/activity-alerts/:id Update an activity alert
DELETE /apiv2/alerts/:id Delete an activity alert

Alerts
Account's alert

Resource Description
GET /api/v2/alerts List logged-in account's alert
GET /api/v2/alerts/:id Show a alert
POST /api/v2/alerts Create logged-in account's alert
PATCH /apiv2/alerts/:id Update a alert
DELETE /apiv2/alerts/:id Delete a alert

Alpha captures

Resource Description
GET /api/v2/alpha-captures/:id Show an AlphaCapture record
POST /api/v2/alpha-captures Create an AlphaCapture record
PATCH /api/v2/alpha-captures/:id Update an AlphaCapture record
DELETE /api/v2/alpha-captures/:id Delete an AlphaCapture record

Annotations
Annotations (Side Comments)

Resource Description
GET /api/v2/annotations/:id Show an annotation
POST /api/v2/annotations Post an annotation on an insight
PATCH /api/v2/annotations/:id Post an annotation on an insight
DELETE /api/v2/annotations/:id Delete own annotation on an insight

Asset classes

Resource Description
GET /api/v2/asset_classes List all asset_classes
GET /api/v2/asset_classes/:id Show an asset_class

Cancelled insights

Resource Description
GET /api/v2/cancelled-insights List of cancelled insights

Collections

Resource Description
GET /api/v2/collections List Collections
GET /api/v2/collections/:id Show a Collection
PATCH /api/v2/collections/:id/follow Follow a Collection
PATCH /api/v2/collections/:id/unfollow Unfollow a Collection

Comments
Comments

Resource Description
GET /api/v2/comments List all comments
GET /api/v2/comments/:id Show a comment
POST /api/v2/comments Post a comment on an insight
PATCH /api/v2/comments/:id Update comment body
PATCH /api/v2/comments/:id/remove Soft-Remove the comment
PATCH /api/v2/comments/:id/like Like a comment
PATCH /api/v2/comments/:id/unlike Remove like from comment

Companies

Resource Description
GET /api/v2/companies List Companies
GET /api/v2/companies/:id Show a Company
PATCH /api/v2/companies/:id Update a Company

Company analytic distribution reports

Resource Description
GET /api/v2/company-analytic-distribution-reports List Company Insight Providers detailed QVA Reports

Company mtd qva reports

Resource Description
GET /api/v2/company-mtd-qva-reports List Company Insight Providers month-to-date QVA Reports

Company payments
Company Net Payments

Resource Description
GET /api/v2/company-payments List of Company Net Payments

Company qva reports

Resource Description
GET /api/v2/qva-reports List Company Insight Providers QVA Reports

Company stages
Company Stages

Resource Description
GET /api/v2/company_stages List Company Stages
GET /api/v2/company_stages/:id Show a Company Stage

Contact lists
Corporation's contact list

Resource Description
GET /api/v2/contact-lists List all contact lists
GET /api/v2/contact-lists/:id Show a contact list
POST /api/v2/contact-lists Post a contact list
PATCH /api/v2/contact-lists/:id/remove Soft-Remove the contact list
PATCH /api/v2/contact-lists/:id Update contact list name
PATCH /api/v2/contact-lists/:id/add-contacts Add Account/Investor to contact list
PATCH /api/v2/contact-lists/:id/add-factset-contacts Add Factset Target Investors to contact list
PATCH /api/v2/contact-lists/:id/remove-contacts Remove Account/Investor from contact list
POST /api/v2/contact-lists/:id/import-contacts-from-csv import Account/Investor from contact list from csv

Contact requests
Contact Request (Contact Us)

Resource Description
POST /api/v2/contact_requests Create a contact request

Content verticals

Resource Description
GET /api/v2/content-verticals List Content Verticals
GET /api/v2/content-verticals/:id Show a Content Vertical

Corporate answers
Entity's corporate answers

Resource Description
GET /api/v2/corporate-answers/:id Show a corporate answer
POST /api/v2/corporate-answers Create a corporate answer
PATCH /api/v2/corporate-answers/:id Update the corporate answer
DELETE /apiv2/corporate-answers/:id Delete a corporate answer

Corporate attachments

Resource Description
POST /api/v2/corporate-attachments Create a Corporate Attachment
DELETE /apiv2/corporate-attachments/:id Delete a Corporate Attachment

Corporate email campaigns
Corporate Email Campaigns

Resource Description
GET /api/v2/corporate-email-campaigns List corporate email campaigns
GET /api/v2/corporate-email-campaigns/:id Show a corporate email campaign
POST /api/v2/corporate-email-campaigns Create a corporate email campaign
PATCH /api/v2/corporate-email-campaigns/:id Update a corporate email campaign
DELETE /api/v2/corporate-email-campaigns/:id Delete a corporate email campaign
GET /api/v2/corporate-email-campaigns/:id/send-test Send a test email preview

Corporate events
Entity's corporate events

Resource Description
GET /api/v2/corporate-events List the entity's corporate events
GET /api/v2/corporate-events/:id Show a corporate event
POST /api/v2/corporate-events Create a corporate event
PATCH /api/v2/corporate-events/:id Update the corporate event
PATCH /api/v2/corporate-events/:id/book-reservation Book reservation for the corporate event
PATCH /api/v2/corporate-events/:id/cancel-reservation Cancel reservation for the corporate event
DELETE /apiv2/corporate-events/:id Delete a corporate event

Corporate plans

Resource Description
GET /api/v2/corporate-plans List Corporate Plans

Corporate presentations
Corporate Presentations

Resource Description
GET /api/v2/corporate-presentations List corporate presentations
GET /api/v2/corporate-presentations/:id Show a corporate presentation
POST /api/v2/corporate-presentations Create a corporate presentation
PATCH /api/v2/corporate-presentations/:id Update a corporate presentation
DELETE /api/v2/corporate-presentations/:id Delete a corporate presentation

Corporate questions
Entity's corporate questions

Resource Description
GET /api/v2/corporate-questions/:id Show a corporate question
POST /api/v2/corporate-questions Create a corporate question
PATCH /api/v2/corporate-questions/:id Update the corporate question
DELETE /apiv2/corporate-questions/:id Delete a corporate question

Countries
Country Mandates

Resource Description
GET /api/v2/countries List Country Mandates
GET /api/v2/countries/:id Show a Country Mandate

Entities

Resource Description
GET /api/v2/entities List Entities
GET /api/v2/entities/:id Show a Entity
PATCH /api/v1/entities/:id Update an entity
PATCH /apiv2/entities/:id/add_peers Add peer entities to the entity
PATCH /apiv2/entities/:id/remove_peers Remove peer entities to the entity

Entity management profiles
Entity's management profiles

Resource Description
GET /api/v2/entity-management-profiles List the entity's management profiles
GET /api/v2/entity-management-profiles/:id Show an entity management profile
POST /api/v2/entity-management-profiles Create a management profile
PATCH /api/v2/entity-management-profiles/:id Update a management profile
DELETE /apiv2/entity-management-profiles/:id Delete a management profile

Entity news
Entity News

Resource Description
GET /api/v2/entity-news List entity news
GET /api/v2/entity-news/:id Show an entity news
POST /api/v2/entity-news Create an entity news
PATCH /api/v2/entity-news/:id Update an entity news
DELETE /api/v2/entity-news/:id Delete an entity news

Exchange announcements
Exchange Announcements

Resource Description
GET /api/v2/exchange-announcements List exchange announcements
GET /api/v2/exchange-announcements/:id Show an exchange announcement
POST /api/v2/exchange-announcements Create an exchange announcement
PATCH /api/v2/exchange-announcements/:id Update an exchange announcement
DELETE /api/v2/exchange-announcements/:id Delete an exchange announcement

External report attachments

Resource Description
GET /api/v2/external-report-attachments/:id Show an External Report Attachment
POST /api/v2/external-report-attachments Create External Report Attachment
PATCH /api/v2/external-report-attachments/:id Update External Report Attachment
DELETE /api/v2/external-report-attachments/:id Delete an External Report Attachment

External reports

Resource Description
GET /api/v2/external-reports List external reports
GET /api/v2/external-reports/:id Show an external report
POST /api/v2/external-reports Create an External Report
POST /api/v2/external-reports/:id/request-publication-access

Factset target investors

Resource Description
GET /api/v2/factset-target-investors/:id Show a factset target investor

Feature participants
Feature participant

Resource Description
POST /api/v2/feature-participants Create a feature participant requesting access

Feature usages
Feature usage

Resource Description
POST /api/v2/feature-usages Create a feature usage

Filter presets
Account's filter presets

Resource Description
GET /api/v2/filter-presets List logged-in account's filter presets
GET /api/v2/filter-presets/:id Show a filter preset
POST /api/v2/filter-presets Create logged-in account's filter preset
PATCH /apiv2/filter-presets/:id Update a filter preset
DELETE /apiv2/filter-presets/:id Delete a filter preset

Geographies

Resource Description
GET /api/v2/geographies List Geography Mandates and its countries
GET /api/v2/geographies/:id Show a Geography

Images

Resource Description
GET /api/v2/images/:id Show an Image
POST /api/v2/images Create Image
DELETE /api/v2/images/:id Delete an Insight Document

Industries
Industries

Resource Description
GET /api/v2/industries/:id Show a Industry

Industry groups
Industry Groups

Resource Description
GET /api/v1/industry_groups/:id Show a Industry Group

Insight analytics
Insight Analytics

Resource Description
GET /api/v2/insight-analyticss List of My Team & My Insight Analytics

Insight disclosures
Insight Provider's Disclosures

Resource Description
GET /api/v2/insight-disclosures/:id Show the Insight Provider's disclosure for an insight
PATCH /api/v2/insight-disclosures/:id Update an Insight Provider's disclosure

Insight documents

Resource Description
GET /api/v2/insight-documents/:id Show an Insight Document
POST /api/v2/insight-documents Create Insight Document
PATCH /api/v2/insight-documents/:id Update Insight Document
DELETE /api/v2/insight-documents/:id Delete an Insight Document

Insight provider payments
Insight Provider Payments

Resource Description
GET /api/v2/insight-provider-payments List of Insight Provider Payments

Insight provider profiles
Insight Providers & Companies publishing under their names

Resource Description
GET /api/v2/insight-provider-profiles Searching of Insight Providers & Companies publishing under their names for mentions

Insight providers
Insight Providers & Companies publishing under their names

Resource Description
GET /api/v2/insight-providers List of Insight Providers & Companies publishing under their names

Insights

Resource Description
GET /api/v2/insights List Insights
POST /api/v2/insights Create Insight
GET /api/v2/insights/:id Show an insight
PATCH /api/v2/insights/:id Update an Insight
PATCH /api/v2/insights/:id/like Like an Insight
PATCH /api/v2/insights/:id/dislike Dislike an Insight
PATCH /api/v2/insights/:id/unlike Undo like/dislike an insight
DELETE /api/v2/insights/:id Delete an unpublished insight
POST /api/v2/insights/:id/request-publication-access
PATCH /api/v2/insights/:id/republish

Investment firm types
investment firm type

Resource Description
GET /api/v2/investment_firm_types List investment firm types
GET /api/v2/investment_firm_types/:id Show an investment firm type

Investor companies
Investor Company

Resource Description
GET /api/v2/investor_companies List investor companies
GET /api/v2/investor_companies/:id Show an investor company

Like reasons
List of Like Reasons

Resource Description
GET /api/v2/like-reasons List of like reasons

Locker items

Resource Description
GET /api/v2/locker-items List of current account Locker Items
GET /api/v2/locker-items/:id Show an Locker Item
POST /api/v2/locker-items Create locker item
PATCH /apiv2/locker-items/:id Update a locker item
DELETE /apiv2/locker-items/:id Delete a locker item

Market cap distro
Insights by market cap

Resource Description
GET /api/v2/market-cap-distro Insight by market cap distribution report

Message groups
Message Groups (Private Messaging)

Resource Description
GET /api/v2/message-groups List the account's message groups
GET /api/v2/message-groups/:id Show a message group
POST /api/v2/message-groups Create a message group
PATCH /api/v2/message-groups/:id Update a message group
PATCH /api/v2/message-groups/:id/join Join group chat
PATCH /api/v2/message-groups/:id/leave Leave group chat

Messages
Messages (Private Messaging)

Resource Description
GET /api/v2/messages List the account's own messages
GET /api/v2/messages/:id Show a message
POST /api/v2/messages Create a message
PATCH /api/v2/messages/:id Update a message's is-read status

Mtd account analytic distribution reports

Resource Description
GET /api/v2/mtd-account-analytic-distribution-reports List Insight Providers detailed month-to-date analytic distribution report

Mtd company analytic distribution reports

Resource Description
GET /api/v2/mtd-company-analytic-distribution-reports List Company Insight Providers detailed month-to-date analytic distribution report

Mtd qva reports

Resource Description
GET /api/v2/mtd-qva-reports List Insight Providers month-to-date QVA Reports

Muted items
Account's muted_item

Resource Description
GET /api/v2/muted_items List logged-in account's Muted Item
GET /api/v2/muted_items/:id Show a Muted Item
POST /api/v2/muted_items Create logged-in account's Muted Item
PATCH /apiv2/muted_items/:id Update a Muted Item
DELETE /apiv2/muted_items/:id Delete a Muted Item

Notifications
Account's Notifications

Resource Description
GET /api/v2/notifications List account's notifications
GET /api/v2/notifications/:id Show a notification

Passwords
Reset Password

Resource Description
POST /api/v2/reset-password Request for a password reset link
PATCH /api/v2/reset-password Reset password

Personal email domains
List of Discouraged Personal Email Domains

Resource Description
GET /api/v2/personal-email-domains List of Personal Email Domains

Personalized insights
Personalized Insights

Resource Description
GET /api/v2/personalized-insights List of Personalized Insights

Phone numbers
Account Phone Number

Resource Description
GET /api/v2/phone-numbers/:id Show an Account Phone Number
POST /api/v2/phone-numbers Create a new Phone Number
PATCH /api/v2/phone-numbers/:id/verify Verify a Phone Number using a verification code
POST /api/v2/phone-numbers/:id/resend-otp Request to resend the verification code

Plans

Resource Description
GET /api/v2/plans List Plans

Premium service attachments

Resource Description
POST /api/v2/premium-service-attachments Create a Premium Service Request Attachment
DELETE /apiv2/premium-service-attachments/:id Delete a Premium Service Request Attachment

Premium service notes

Resource Description
GET /api/v2/premium-service-notes/:id Show a Premium Service Request Note
POST /api/v2/premium-service-notes Create a Premium Service Request Note
PATCH /api/v2/premium-service-notes/:id Create a Premium Service Request Note
DELETE /apiv2/premium-service-notes/:id Delete a Premium Service Request Note

Premium service packages

Resource Description
GET /api/v2/premium-service-packages Get all Premium Service Packages

Premium service requests

Resource Description
GET /api/v2/premium-service-requests List of current account Premium Service Requests
GET /api/v2/premium-service-requests/:id Show a Premium Service Request
POST /api/v2/premium-service-requests Create a Premium Service Request
PATCH /apiv2/premium-service-requests/:id Update a Premium Service Request
DELETE /apiv2/premium-service-requests/:id Delete a Premium Service Request

Premium service transactions

Resource Description
GET /api/v2/premium-service-transactions Get all Premium Service Transactions
GET /api/v2/premium-service-transactions/:id Show a Premium Service Transaction

Push notification tokens
Generate Push Messages

Resource Description
POST /api/v2/push-notification-tokens Create a push notification token
PATCH /api/v2/push-notification-tokens/:id Update a push notification token
DELETE /apiv2/push-notification-tokens/:id Delete a push notification token

Qva reports

Resource Description
GET /api/v2/qva-reports List Insight Providers QVA Reports

Registrations

Resource Description
POST /api/v2/sign-up Sign up

Search
Search

Resource Description
GET /api/v2/search Search for searchable insights, entities and insight providers

Search histories
Account's search history

Resource Description
GET /api/v2/alerts List logged-in account's search history

Sectors

Resource Description
GET /api/v2/sectors List Sector Mandates
GET /api/v2/sectors/:id Show a Sector Mandate

Sessions

Resource Description
POST /api/v2/accounts/sign_in Signs in an account
POST /api/v2/accounts/temporary-authentication One time authentication for an account
POST /api/v2/accounts/magic-authentication One time authentication for an account
POST /api/v2/accounts/verify-email Verify email for an account

Shared items

Resource Description
GET /api/v2/shared-items List of current account Shared Items
GET /api/v2/shared-items/:id Show a Shared Item
POST /api/v2/shared-items Create shared item
PATCH /api/v2/shared-items/:id Update a shared item
DELETE /api/v2/shared-items/:id Delete a shared item

Skills
Skills list

Resource Description
GET /api/v2/skills List Account's skills

Strategies

Resource Description
GET /api/v2/strategies List Strategy Mandates
GET /api/v2/strategies/:id Show a Strategy Mandate

Suggested entities
Suggested Entities

Resource Description
GET /api/v2/suggested-entities List of Suggested Entities

Suggested insight providers
Suggested Insight Providers

Resource Description
GET /api/v2/suggested-insight-providers List of Suggested Insight Providers

Target investors
Target Investor

Resource Description
GET /api/v2/target_investors List target investors
GET /api/v2/target_investors/:id Show a target investor

Teams

Resource Description
GET /api/v2/teams/:id Show a team

Trending insight providers
Trending Insight Providers

Resource Description
GET /api/v2/trending-insight-providers List of Trending Insight Providers

Trending insights
Trending Insights

Resource Description
GET /api/v2/trending-insights List of Trending Insights

Vertical subscriptions

Resource Description
GET /api/v2/vertical-subscriptions List Vertical Subscriptions
GET /api/v2/vertical-subscriptions/:id Show a Vertical Subscription

Watchlists
Account's watchlist

Resource Description
GET /api/v2/watchlists List logged-in account's watchlist
GET /api/v2/watchlists/:id Show a watchlist
POST /api/v2/watchlists Create logged-in account's watchlist
PATCH /apiv2/watchlists/:id Update a watchlist
PATCH /apiv2/watchlists/:id/add_entities Add entities to the watchlist
PATCH /apiv2/watchlists/:id/remove_entities Remove entities to the watchlist
DELETE /apiv2/watchlists/:id Delete a watchlist

Web properties

Resource Description
POST /api/v2/web-properties Create web property

Web socket

Resource Description
GET /api/v2/web-socket/authenticate Authenticate client subscription to web sockets