This event is triggered when a company is closed

This event is triggered when a company is detail update

This event is triggered when a company is presented

This event is triggered when a contact is created

This event is triggered when a document is deleted

This event is triggered when a metric is disabled

This event is triggered when a metric is enabled

This event is triggered when a scorecard is submitted

This event is triggered when a task is completed

Edits the current list of alternative email addresses by adding new ones and removing deleted entries.

Creates a new comment thread on the specified company.

Partially update a company.

Modifies the properties of an existing metric type for the specified company.

Creates a new note attached to the specified company with optional file attachments.

Creates a new task and associates it with the specified company.

Updates the relationship score between the current user and the contact.

Creates a new contact record in the current workspace.

For every combination of type and format there can be only one dump schedule. When updating the hour, keep in mind that the minimum period between 2 dumps is 24h. This means that if a dump was just generated and the schedule is updated to be 1hr in the future - the next dump will be generated in 25hrs.

Modifies document properties such as name, folder, audiences, keywords, or document type.

Adds a new output field definition to the document analysis with a unique slug.

Sets up a new document analysis configuration in the workspace.

Modifies step properties such as name, prompt, intermediate flag, or processing order.

Creates a new email record in the workspace and links it to the current user.

Modifies folder properties such as name or parent folder.

Modifies the value or properties of an existing metric entry.

Modifies the content, title, or attached files of an existing note.

Creates a company and places it in the pipeline's NEW stage. Version 1: Creating an autofilled company (for example use an existing Crunchbase company to seed initial data), Version 2: Creating a repeat submission (use an existing company to seed initial data), Version 3: Creating a blank company.

Creates a new review template configuration in the workspace.

Modifies the properties of an existing review template.

Creates a company and places it directly into the specified stage.

Modifies the properties of an existing task such as status, schedule date, or assigned users.

Modifies various settings for the authenticated user. "User workspace" acts as a data store for all kinds of user-level settings throughout the app. Example: clicking "don't show this again" will update this store in order to remember your choice.

Retrieves all alternative email addresses configured for the current user in the workspace.

Retrieves a specific cap table with its items, stage of investment, and creator details.

Retrieves a single comment with its author, replies, attachments, and reactions.

Retrieves all cap table records with their creators for the specified company.

Retrieves all contacts linked to the specified company.

Retrieves a paginated list of the latest documents uploaded to the company.

Retrieves paginated emails linked to the company with their attachments and reactions.

Aggregates fields, notes, comments, metrics, owners, contacts, news, tasks, cap tables, events, and sources into a single export.

Retrieves all investor detail records sorted by latest update.

Retrieves all metric types and their values tracked for the specified company.

Retrieves all notes with their documents, reactions, and authors sorted by newest first.

Retrieves scoring data computed for the specified company.

Retrieves all versions (or "submissions") of the company sorted by their submission date. Since Dealflow supports "company versioning" there can be multiple companies entered into Dealflow which map to the same real-world company and only the latest one to enter is displayed in the UI and taken into account in stats (it's referred to as the "active submission").

Retrieves a paginated activity timeline with optional filtering by action type.

Returns data about all companies in a workspace.

Retrieves all comments with their authors sorted by newest first.

Retrieves detailed contact information including language, country, and relationship strength data.

Retrieves all contacts in the workspace (potentially filtering by email).

Retrieves a single contact comment with its author and associated contact.

Retrieves a specific data dump schedule with its download URL.

Retrieves the analysis output including extracted data and result document.

Retrieves detailed document information including preview and download URLs.

Retrieves all output fields defined for the specified document analysis.

Retrieves the analysis configuration with its steps and fields.

Retrieves the field definition including its name, type, style, and display settings.

Retrieves all document keywords configured in the workspace.

Retrieves a specific email with its linked companies, contacts, and attachments.

Retrieves a specific event with its company, creator, emails, and participants.

Retrieves the definition of a specific default or custom field.

Searches and retrieves available options for the specified filter field or table.

Retrieves detailed fund information including users and company status counts.

Retrieves all available fund type categories sorted by identifier.

Retrieves all metric types defined in the workspace sorted alphabetically.

Retrieves a paginated list of all notes across accessible pipelines and funds.

Retrieves all comments with their authors, reactions, and documents.

Retrieves a paginated list of notifications for the current user, optionally filtered by app.

Retrieves all pipelines accessible to the current user with company counts.

Returns users with administrator, moderator, or investor roles in the pipeline.

Retrieves all review templates configured for the pipeline sorted by identifier.

Retrieves detailed pipeline information with company count.

Retrieves a specific review with its template, companies, and currency information.

Retrieves the review template with hydrated filter configuration.

Retrieves a paginated list of companies, optionally filtered by date range using timeline history.

Retrieves detailed stage information including company count.

Retrieves a paginated list of tasks across accessible pipelines and funds, optionally filtered by date range.

Retrieves a specific task with its assigned users.

Retrieves all applications available to the current user. Example: Dealflow might not be available to you if you're not a member of any pipelines.

Retrieves the authenticated user's profile with permissions, search preferences, and workspace configuration.

This event is triggered when a company is created

This event is triggered when a company is moved

This event is triggered when a company is shared

This event is triggered when a document is attached

This event is triggered when a email is added

This event is triggered when a metric is edited

This event is triggered when a metric is update

This event is triggered when a scorecard is template selected

This event is triggered when a task is created

Modifies the content of an existing comment on a company.

Creates a new event linked to the specified company and its pipeline.

Creates a new metric value entry for the specified metric type and company.

Creates a new metric type definition and associates it with the company.

Records a new deal source entry for the specified company.

Posts a new comment on the specified contact.

Modifies the details of an existing contact record.

Modifies the content of an existing comment on a contact.

Initiates an AI-powered analysis of the document using the specified analysis configuration.

Modifies the name of an existing document analysis configuration.

Adds a new processing step with prompt and ordering to the document analysis.

Modifies field properties such as name, description, style, type, or display order.

Modifies the properties of an existing email record.

Adds a new option value to the specified filter table.

Creates a new folder with an optional parent path and shared visibility setting.

Creates a new comment on the specified note and notifies the note author.

Modifies the content and attached files of an existing note comment.

Modifies various settings for the pipeline. "Pipeline workspace" acts as a data store for all kinds of pipeline-level settings throughout the app. Example: column order for pipeline's table view.

Creates a new review session or returns an existing in-progress one.

Transfers a company to the specified stage and triggers movement notifications.

Associates a tag with the specified stage.

Modifies the profile details of the specified user.

Retrieves all activities available in the current workspace sorted alphabetically.

Retrieves all user groups configured as audiences in the workspace.

Retrieves a paginated list of all cap tables across companies in the workspace.