# Forestreet Documentation

- [Introduction](https://docs.forestreet.com/api-reference/introduction.md): Welcome to the home of the Forestreet API documentation.
- [Authentication](https://docs.forestreet.com/api-reference/authentication.md): How to authenticate your API requests
- [Discovery Workflow](https://docs.forestreet.com/api-reference/guides/platform-discovery.md): Complete guide to conducting market research using Forestreet's AI-powered discovery and analysis platform.
- [Export via API](https://docs.forestreet.com/api-reference/guides/export-api.md): Connect a market to your internal system using an API hook.
- [iFrame Integration](https://docs.forestreet.com/api-reference/guides/iframe-integration.md): Integrate Forestreet into your internal applications using an iFrame.
- [Sign in](https://docs.forestreet.com/api-reference/endpoints/auth/sign-in.md): Sign in a user with email and password; upon success, authentication cookies are set   in the browser.
- [Sign out](https://docs.forestreet.com/api-reference/endpoints/auth/sign-out.md): Revoke the current bearer or cookie session and clear authentication cookies.
- [Get session ID](https://docs.forestreet.com/api-reference/endpoints/auth/get-session-id.md): Create new session using a valid API key, which will return a JWT token in the response.
- [Set Session Cookies](https://docs.forestreet.com/api-reference/endpoints/auth/set-session-cookies.md): Using a JWT token and a checksum, this endpoint sets session cookies in the user's browser.
- [Get a team by ID](https://docs.forestreet.com/api-reference/endpoints/teams/get-a-team-by-id.md): Fetch the details of a specific team by its ID.
- [Create a team](https://docs.forestreet.com/api-reference/endpoints/teams/create-a-team.md): Creates a new team with the provided details.
- [Edit a team](https://docs.forestreet.com/api-reference/endpoints/teams/edit-a-team.md): Edits a team with the provided details.
- [Delete a team](https://docs.forestreet.com/api-reference/endpoints/teams/delete-a-team.md): Delete the specified team.
- [Get current user's teams](https://docs.forestreet.com/api-reference/endpoints/teams/get-current-users-teams.md): Fetch the teams associated with the current user
- [About me](https://docs.forestreet.com/api-reference/endpoints/users/about-me.md): Get the current user's information and their access to teams and collections.
- [Get team export endpoints](https://docs.forestreet.com/api-reference/endpoints/teams/get-team-export-endpoints.md): Fetch the Export Via API endpoints associated with a specific team
- [Get team export endpoints, advanced](https://docs.forestreet.com/api-reference/endpoints/teams/get-team-export-endpoints-advanced.md): Fetch the Export Via API endpoints associated with a specific team
- [Register export endpoint for a team](https://docs.forestreet.com/api-reference/endpoints/teams/register-export-endpoint-for-a-team.md): Register a new Export Via API endpoint for a team.
- [Update export endpoint for a team](https://docs.forestreet.com/api-reference/endpoints/teams/update-export-endpoint-for-a-team.md): Update an existing Export Via API endpoint for a team.
- [Delete export endpoint for a team](https://docs.forestreet.com/api-reference/endpoints/teams/delete-export-endpoint-for-a-team.md): Delete an existing Export Via API endpoint for a team.
- [Get team collections](https://docs.forestreet.com/api-reference/endpoints/teams/get-team-collections.md): Fetch the collections associated with a specific team
- [Create a collection](https://docs.forestreet.com/api-reference/endpoints/teams/create-a-collection.md): Create a collection within a specific team.
- [Get markets](https://docs.forestreet.com/api-reference/endpoints/markets/get-markets.md): Fetch list of markets in the collection with pagination and filtering
- [Get a market](https://docs.forestreet.com/api-reference/endpoints/markets/get-a-market.md): Fetch a specific market in the collection
- [Delete a market](https://docs.forestreet.com/api-reference/endpoints/markets/delete-a-market.md): Delete a specific market in the collection
- [Update a market](https://docs.forestreet.com/api-reference/endpoints/markets/update-a-market.md): Update a specific market in the collection
- [Move a market](https://docs.forestreet.com/api-reference/endpoints/markets/move-a-market.md): Move a specific market in the collection
- [List market explorer companies](https://docs.forestreet.com/api-reference/endpoints/markets/list-market-explorer-companies.md): List the companies in a published market, intended for Market Explorer use.      Differs from a draft study by having company metadata populated, and having completed a detailed scrape.
- [Get market explorer filters](https://docs.forestreet.com/api-reference/endpoints/markets/get-market-explorer-filters.md): Fetches available filters for a specific market.      [List Market Explorer Companies](./list-market-explorer-companies) supports in its   Query parameters a set of filters that can be applied to the list of companies. This   endpoint provides the available options for those filters, which can be us…
- [Generate search criteria](https://docs.forestreet.com/api-reference/endpoints/discovery/generate-search-criteria.md): Convert natural language queries into structured search criteria for AI-powered company discovery.
- [Generate keywords for search](https://docs.forestreet.com/api-reference/endpoints/discovery/generate-keywords-for-search.md): Generate AI-suggested keywords to improve your search criteria.
- [Start discovery for new market](https://docs.forestreet.com/api-reference/endpoints/discovery/start-discovery-for-new-market.md): Create a new market and initiate AI-powered company discovery process using structured search criteria.
- [Start discovery for existing market](https://docs.forestreet.com/api-reference/endpoints/discovery/start-discovery-for-existing-market.md): Add more companies to an existing market using AI-powered discovery process.
- [Get job status](https://docs.forestreet.com/api-reference/endpoints/discovery/get-job-status.md): Retrieve the status and progress of discovery jobs for a given market, optionally filtered by job IDs and/or status.
- [Get search criteria](https://docs.forestreet.com/api-reference/endpoints/discovery/get-search-criteria.md): Retrieve the search criteria used for a specific market discovery.
- [Get search criteria history](https://docs.forestreet.com/api-reference/endpoints/discovery/get-search-criteria-history.md): Retrieve the history of search criteria iterations for a specific market.
- [Update company review status](https://docs.forestreet.com/api-reference/endpoints/discovery/update-company-review-status.md): Update the review status of discovered companies for quality control.
- [Publish a market](https://docs.forestreet.com/api-reference/endpoints/discovery/publish-a-market.md): Publish discovered companies and trigger comprehensive market analysis and enrichment.
- [List market explorer companies](https://docs.forestreet.com/api-reference/endpoints/markets/list-market-explorer-companies.md): List the companies in a published market, intended for Market Explorer use.      Differs from a draft study by having company metadata populated, and having completed a detailed scrape.
- [Get market explorer filters](https://docs.forestreet.com/api-reference/endpoints/markets/get-market-explorer-filters.md): Fetches available filters for a specific market.      [List Market Explorer Companies](./list-market-explorer-companies) supports in its   Query parameters a set of filters that can be applied to the list of companies. This   endpoint provides the available options for those filters, which can be us…
- [Get esg data for a market](https://docs.forestreet.com/api-reference/endpoints/markets/get-esg-data-for-a-market.md)
- [Get esg filters for a market](https://docs.forestreet.com/api-reference/endpoints/markets/get-esg-filters-for-a-market.md)
- [Get esg data for a company in a market](https://docs.forestreet.com/api-reference/endpoints/markets/get-esg-data-for-a-company-in-a-market.md)
- [Search companies](https://docs.forestreet.com/api-reference/endpoints/impact/search-companies.md): Search for impact data
- [Get a company](https://docs.forestreet.com/api-reference/endpoints/impact/get-a-company.md): Get impact data for a specific company
- [Get news for a company](https://docs.forestreet.com/api-reference/endpoints/impact/get-news-for-a-company.md): Get news for a specific company
- [Create a dossier](https://docs.forestreet.com/api-reference/endpoints/dossier/create-a-dossier.md): Create a new dossier in the specified collection using AI to generate supplier information
- [Delete a dossier](https://docs.forestreet.com/api-reference/endpoints/dossier/delete-a-dossier.md): Remove a dossier from the specified collection
- [Get a dossier](https://docs.forestreet.com/api-reference/endpoints/dossier/get-a-dossier.md): Retrieve a specific dossier by agent ID and collection ID
- [Get dossiers in collection](https://docs.forestreet.com/api-reference/endpoints/dossier/get-dossiers-in-collection.md): Retrieve dossiers associated with a specific collection with optional filtering and pagination
- [Update a dossier](https://docs.forestreet.com/api-reference/endpoints/dossier/update-a-dossier.md): Update a dossier by adding it to another collection, moving it to another collection, or modifying its properties
- [List events](https://docs.forestreet.com/api-reference/endpoints/events-monitor/list-events.md): Retrieves a list of events based on the provided query parameters. Supports filtering   by date range, taxonomy matches, impacted entity likelihood and severity scores,   free-text search, and pagination. By default, only events with at least one impacted   entity with likelihood 2-3 and severity 2-…
- [Get an Observation](https://docs.forestreet.com/api-reference/endpoints/events-monitor/get-an-observation.md): Retrieves a single observation based on the provided observation ID.
- [Get an iconographic symbol by name](https://docs.forestreet.com/api-reference/endpoints/assets/get-an-iconographic-symbol-by-name.md): Attempts to retrieve an iconographic symbol by its name from the Noun Project API.          This endpoint supports both JSON and PNG responses.
- [Get a company logo by domain](https://docs.forestreet.com/api-reference/endpoints/assets/get-a-company-logo-by-domain.md): Attempts to retrieve a company logo by its domain. Cached logos are stored in MySQL for 90 days before they are refreshed via the logo.dev API.
- [Retrieve cached company logo by domain (public)](https://docs.forestreet.com/api-reference/endpoints/public/retrieve-cached-company-logo-by-domain-public.md): Serves company logos cached within the past 90 days. This endpoint is only used for companies discovered on the Forestreet platform; it does not actively search for as-yet-unknown company logos. If the requested logo is missing and a PNG response is requested, a magnifying-glass fallback icon is ret…
- [About UI Components](https://docs.forestreet.com/api-reference/ui-components/index.md): An assortment of ready-to-use UI components designed to enrich data visualisation and market analysis capabilities.
- [Feature Map](https://docs.forestreet.com/api-reference/ui-components/feature-map.md): An innovative data visualisation tool designed to provide a comprehensive overview of the features and services offered by companies within a market.
- [Topic Mosaic](https://docs.forestreet.com/api-reference/ui-components/topic-mosaic.md): Transform complex market data into clear, interactive visual insights for rapid understanding and informed decision-making
- [Momentum Score](https://docs.forestreet.com/api-reference/ui-components/momentum-score.md): The Momentum Score widget is a holistic measure of a company's market performance, encapsulating key growth indicators in a single, intuitive visualisation.
- [Supplier Dossier](https://docs.forestreet.com/api-reference/ui-components/supplier-dossier.md): A comprehensive overview of a supplier's information, including their capabilities, competitors and market landscape.
- [About API V1](https://docs.forestreet.com/api-reference/deprecated/v1/index.md): Deprecated API version, previously hosted at `https://api.forestreet.com/`.
- [Start Discovery](https://docs.forestreet.com/api-reference/deprecated/v1/discover/market/discover.md): This endpoint starts an on-demand discovery to find companies for a market.
- [Status](https://docs.forestreet.com/api-reference/deprecated/v1/discover/market/status.md): This endpoint gets the status of a market.
- [Quick Search](https://docs.forestreet.com/api-reference/deprecated/v1/discover/market/search.md): This endpoint starts a quicker, lighter search than the full discovery endpoint.
- [Quick Search Status](https://docs.forestreet.com/api-reference/deprecated/v1/discover/market/searchStatus.md): This endpoint returns the status and results of a search
- [Market Collections](https://docs.forestreet.com/api-reference/deprecated/v1/markets/collections.md): Get all the collections that the current user is allowed to access.
- [Search Existing Markets](https://docs.forestreet.com/api-reference/deprecated/v1/markets/search.md): Search the list of available markets.
- [Suggest Market Name](https://docs.forestreet.com/api-reference/deprecated/v1/markets/suggest.md): Suggest a market name based on the user-entered keyword.
- [ESG](https://docs.forestreet.com/api-reference/deprecated/v1/market/esg.md): This endpoint retrieves ESG data for a given market.
- [Export CSV](https://docs.forestreet.com/api-reference/deprecated/v1/market/export-csv.md): Get a download link for CSV file of a market.
- [News](https://docs.forestreet.com/api-reference/deprecated/v1/market/news.md): Retrieve a list of news articles and events specifically tailored for a given market, providing up-to-date insights and happenings related to that market.
- [Topics](https://docs.forestreet.com/api-reference/deprecated/v1/market/topics.md): This endpoint gets a hierarchy of topics talked about in a given market.
- [Features](https://docs.forestreet.com/api-reference/deprecated/v1/market/features.md): This endpoint gets a hierarchy of features and services provided by companies in a given market.
- [Attributes](https://docs.forestreet.com/api-reference/deprecated/v1/market/companies/attributes.md): This endpoint retrieves all the headquarter countries, NAICS codes and diversity certifications identified in the given market after the given filter was applied.<br /><br /> This is commonly used to build a Filter functionality on a UI, allowing the user to dynamically see the applicable filters as…
- [Companies](https://docs.forestreet.com/api-reference/deprecated/v1/market/companies/companies.md): This endpoint retrieves the companies for a given market.
- [Locations](https://docs.forestreet.com/api-reference/deprecated/v1/market/companies/locations.md): This endpoint retrieves all the locations for companies for a given market.
- [Countries](https://docs.forestreet.com/api-reference/deprecated/v1/market/companies/countries.md): This endpoint retrieves all the headquarter countries identified in the given market.<br /><br /> This is commonly used with the `/markets/{marketId}/companies` endpoint to ensure that the filter is acting on an available country.
- [Diversity Certifications](https://docs.forestreet.com/api-reference/deprecated/v1/market/companies/diversity.md): This endpoint retrieves all the diversity certifications identified in the given market.
- [NAICS Codes](https://docs.forestreet.com/api-reference/deprecated/v1/market/companies/naics.md): This endpoint retrieves a tree of all NAICS codes identified in the given market. This does not map the NAICS codes to specific domains; this is typically used to create the dropdown list for filtering by NAICS.<br /><br /> A NAICS (pronounced NAKES) Code is a classification within the North America…
- [Search](https://docs.forestreet.com/api-reference/deprecated/v1/companies/search.md): This endpoint search the companies for a given keyword.
- [Create Project](https://docs.forestreet.com/api-reference/deprecated/v1/projects/create.md): Create a new empty project
- [Management Accounts](https://docs.forestreet.com/api-reference/deprecated/v1/users/default.md): A group of endpoints for management and of other users
- [List all Managed Users](https://docs.forestreet.com/api-reference/deprecated/v1/users/managed.md): List all the users managed by the authenticated user
- [User Activities](https://docs.forestreet.com/api-reference/deprecated/v1/users/activities.md): Get the activities of a user during a specific time period, up to 180 days.
- [Pre-built UI Components](https://docs.forestreet.com/api-reference/ui-components.md): An assortment of ready-to-use UI components designed to enrich data visualisation and market analysis capabilities.

## OpenAPI Specs

- [openapi](/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.