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
GET /api/v2/account-uploads/:id Show an account upload
POST /api/v2/account-uploads Create account upload
DELETE /api/v2/account-uploads/:id Delete an 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/add_following_accounts Add followings to the account

Activities
Activity

Resource Description
GET /api/v1/activities List activities
POST /api/v2/activities Create an activity
GET /api/v1/activities/:id Show 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

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/v1/asset_classes List all asset_classes
GET /api/v1/asset_classes/:id Show an asset_class
POST /api/v1/asset_classes Create an asset_class
PATCH /api/v1/asset_classes/:id Update an asset_class
DELETE /api/v1/asset_classes/:id Delete an asset_class

Cancelled insights

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

Comments
Foundry Comments

Resource Description
GET /api/v1/comments List comments
GET /api/v1/comments/:id Show a comment
POST /api/v1/comments Post a comment on any commentable
DELETE /api/v1/comments/:id Delete own comment on a commentable
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
Managing Companies

Resource Description
GET /api/v1/companies List of companies
GET /api/v1/companies/:id Show a company
PATCH /api/v1/companies/:id Update a company
POST /api/v1/companies Create a company
DELETE /api/v1/companies/:id Delete a company

Company analytic distribution reports

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

Company qva reports

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

Contact requests
Contact Request (Contact Us)

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

Content verticals
Content Verticals

Resource Description
GET /api/v1/countries List Content Verticals
GET /api/v1/countries/:id Show a Content Vertical
POST /api/v2/countries Create a Content Vertical
PATCH /api/v2/countries/:id Update a Content Vertical
DELETE /api/v2/countries/:id Delete a Content Vertical

Corporate 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

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

Countries
Country Mandates

Resource Description
GET /api/v1/countries List Country Mandates
GET /api/v1/countries/:id Show a Country Mandate
POST /api/v2/countries Create a Country Mandate
PATCH /api/v2/countries/:id Update a Country Mandate
DELETE /api/v2/countries/:id Delete a Country Mandate

Entities

Resource Description
GET /api/v1/entities List all entities
GET /api/v1/entities/:id Show an 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
GET /api/v2/entities/:id/news Retrieve news from different sources
POST /api/v1/entities Create an entity
DELETE /api/v1/entities/:id Delete an 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 reports

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

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

Follows
Follows

Resource Description
Get /api/v2/follows/:id Show a follow
POST /api/v2/follows Following a followable
DELETE /api/v2/follows/:id Unfollow followable

Geographies
Geography Mandates

Resource Description
GET /api/v1/countries List Geography Mandates
GET /api/v1/countries/:id Show a Geography Mandate
POST /api/v2/countries Create a Geography Mandate
PATCH /api/v2/countries/:id Update a Geography Mandate
DELETE /api/v2/countries/:id Delete a Geography Mandate

Group email messages
Group Email Messages

Resource Description
GET /api/v1/group-email-messages List group email messages
GET /api/v1/group-email-messages/:id Show a group email message
POST /api/v1/group-email-messages Create a group email message
PATCH /api/v1/group-email-messages/:id Update a group email message
DELETE /api/v1/group-email-messages/:id Delete a group email message

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 collections

Resource Description
GET /api/v2/insight-collections List Insight Collections

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

Resource Description
GET /api/v2/insight-provider-payments Summarized list of IP Payments with normalized amount

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

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

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

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

Premium services
Managing Premium Services

Resource Description
GET /api/v1/premium_services List of premium_services
GET /api/v1/premium_services/:id Show a premium_service
POST /api/v1/premium_services Create a premium_service
PATCH /api/v1/premium_services/:id Update a premium_service
DELETE /api/v1/premium_services/:id Delete a premium_service

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
POST /api/v2/push-notification-tokens/get-message Send a push notification message

Pusher

Resource Description
POST /api/v2/pusher/authenticate_new Authenticate client subscription to pusher's API
GET /api/v2/pusher/user_online/:id

Qva reports

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

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
Sector Mandates

Resource Description
GET /api/v1/countries List Sector Mandates
GET /api/v1/countries/:id Show a Sector Mandate
POST /api/v2/countries Create a Sector Mandate
PATCH /api/v2/countries/:id Update a Sector Mandate
DELETE /api/v2/countries/:id Delete 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
Strategy Mandates

Resource Description
GET /api/v1/countries List Strategy Mandates
GET /api/v1/countries/:id Show a Strategy Mandate
POST /api/v2/countries Create a Strategy Mandate
PATCH /api/v2/countries/:id Update a Strategy Mandate
DELETE /api/v2/countries/:id Delete a Strategy Mandate

Tasks
Managing Tasks

Resource Description
GET /api/v1/tasks List of tasks
GET /api/v1/tasks/:id Show a task
POST /api/v1/tasks Create a task
PATCH /api/v1/tasks/:id Update a task
DELETE /api/v1/tasks/:id Delete a task

Teams
Managing Company Teams

Resource Description
GET /api/v1/teams/:id Show a team
GET /api/v1/teams List of teams
POST /api/v1/teams Create a team
PATCH /api/v1/teams/:id Update a team
DELETE /api/v1/teams/:id Delete a team

Time zones

Resource Description
GET /api/v2/time-zones List Available Time Zones

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

Visitors
Visitor (Request Access)

Resource Description
POST /api/v2/visitors Create a visitor requesting access

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