---
title: "Get deals"
method: GET
path: "/api/v2/deals"
tags: ["Deals"]
---

# Get deals

`GET /api/v2/deals`

List deals with optional filters. Returns paginated deal records the caller has access to.

## Query parameters

- `sort` string[]
- `filter` union — Filter schema for `deal` list endpoints — pass a single condition or a logical group.
  - object — A logical filter group — combine multiple conditions with the `$op` operator.
    - `$op` 'or' | 'and', required — Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match.
  - FilterDeal — Filter parameters for querying deals (sales pipeline opportunities).
    - `estimated_remaining_time` union — Filter by estimated remaining time amount range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` EstimatedRemainingTime — unresolved $ref
        - `contains` EstimatedRemainingTime — unresolved $ref
        - `not_contain` EstimatedRemainingTime — unresolved $ref
        - `eq` EstimatedRemainingTime — unresolved $ref
      - EstimatedRemainingTime — unresolved $ref
    - `last_activity_at` union — Filter by last activity date range (`last_activity_at`).
      - LastActivityAt — unresolved $ref
      - object — Operator object — supports eq, not_eq, contains, not_contain.
        - `not_contain` LastActivityAt — unresolved $ref
        - `not_eq` LastActivityAt — unresolved $ref
        - `contains` LastActivityAt — unresolved $ref
        - `eq` LastActivityAt — unresolved $ref
    - `budget_used` union — Filter by amount of budget used.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` BudgetUsed — unresolved $ref
        - `not_eq` BudgetUsed — unresolved $ref
        - `contains` BudgetUsed — unresolved $ref
        - `not_contain` BudgetUsed — unresolved $ref
      - BudgetUsed — unresolved $ref
    - `delivered_on` union — Filter by delivery date range (`delivered_on`).
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` DeliveredOn — unresolved $ref
        - `eq` DeliveredOn — unresolved $ref
        - `not_eq` DeliveredOn — unresolved $ref
        - `not_contain` DeliveredOn — unresolved $ref
      - DeliveredOn — unresolved $ref
    - `purchase_order_number` union — Filter by purchase order number (text search).
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` PurchaseOrderNumber — unresolved $ref
        - `contains` PurchaseOrderNumber — unresolved $ref
        - `not_contain` PurchaseOrderNumber — unresolved $ref
        - `eq` PurchaseOrderNumber — unresolved $ref
      - PurchaseOrderNumber — unresolved $ref
    - `accessible_by_person` union — Filter deals accessible by a specific person.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` AccessibleByPerson — unresolved $ref
        - `eq` AccessibleByPerson — unresolved $ref
        - `contains` AccessibleByPerson — unresolved $ref
        - `not_contain` AccessibleByPerson — unresolved $ref
      - AccessibleByPerson — unresolved $ref
    - `creator_id` union — Filter by the person who created the deal.
      - CreatorId — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` CreatorId — unresolved $ref
        - `not_contain` CreatorId — unresolved $ref
        - `eq` CreatorId — unresolved $ref
        - `contains` CreatorId — unresolved $ref
    - `project_id` union — Filter by associated project.
      - ProjectId — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` ProjectId — unresolved $ref
        - `contains` ProjectId — unresolved $ref
        - `not_eq` ProjectId — unresolved $ref
        - `eq` ProjectId — unresolved $ref
    - `recurring_starts_on` union — Filter by recurring contract start date range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` RecurringStartsOn — unresolved $ref
        - `contains` RecurringStartsOn — unresolved $ref
        - `not_contain` RecurringStartsOn — unresolved $ref
        - `not_eq` RecurringStartsOn — unresolved $ref
      - RecurringStartsOn — unresolved $ref
    - `days_in_current_stage` union — Filter by the number of days the deal has been in its current pipeline stage.
      - object — Object form with operator key (eq, not_eq, contains, not_contain).
        - `not_eq` DaysInCurrentStage — unresolved $ref
        - `not_contain` DaysInCurrentStage — unresolved $ref
        - `contains` DaysInCurrentStage — unresolved $ref
        - `eq` DaysInCurrentStage — unresolved $ref
      - DaysInCurrentStage — unresolved $ref
    - `lost_reason_id` union — Filter by associated lost reason.
      - LostReasonId — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` LostReasonId — unresolved $ref
        - `eq` LostReasonId — unresolved $ref
        - `contains` LostReasonId — unresolved $ref
        - `not_contain` LostReasonId — unresolved $ref
    - `query` union — Filter by deal name or reference (full-text search across name and number).
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` Query — unresolved $ref
        - `not_eq` Query — unresolved $ref
        - `contains` Query — unresolved $ref
        - `not_contain` Query — unresolved $ref
      - Query — unresolved $ref
    - `origin_deal_id` union — Filter by the originating deal this budget was created from.
      - OriginDealId — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` OriginDealId — unresolved $ref
        - `eq` OriginDealId — unresolved $ref
        - `contains` OriginDealId — unresolved $ref
        - `not_contain` OriginDealId — unresolved $ref
    - `invoiced` union — Filter by invoiced amount range.
      - Invoiced — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` Invoiced — unresolved $ref
        - `not_contain` Invoiced — unresolved $ref
        - `contains` Invoiced — unresolved $ref
        - `eq` Invoiced — unresolved $ref
    - `forecasted_cost` union — Filter by forecasted total cost amount range.
      - ForecastedCost — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` ForecastedCost — unresolved $ref
        - `eq` ForecastedCost — unresolved $ref
        - `not_eq` ForecastedCost — unresolved $ref
        - `not_contain` ForecastedCost — unresolved $ref
    - `time_approval` union — Filter by whether time approval is required.
      - TimeApproval — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` TimeApproval — unresolved $ref
        - `not_eq` TimeApproval — unresolved $ref
        - `contains` TimeApproval — unresolved $ref
        - `not_contain` TimeApproval — unresolved $ref
    - `profit` union — Filter by profit amount range.
      - Profit — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` Profit — unresolved $ref
        - `contains` Profit — unresolved $ref
        - `not_contain` Profit — unresolved $ref
        - `eq` Profit — unresolved $ref
    - `currency` union — Filter by deal currency.
      - Currency — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` Currency — unresolved $ref
        - `not_contain` Currency — unresolved $ref
        - `contains` Currency — unresolved $ref
        - `not_eq` Currency — unresolved $ref
    - `responsible_id` union — Filter by responsible person.
      - ResponsibleId — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` ResponsibleId — unresolved $ref
        - `not_eq` ResponsibleId — unresolved $ref
        - `eq` ResponsibleId — unresolved $ref
        - `not_contain` ResponsibleId — unresolved $ref
    - `expenses_billable` union — Filter by billable expenses amount range.
      - ExpensesBillable — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` ExpensesBillable — unresolved $ref
        - `eq` ExpensesBillable — unresolved $ref
        - `contains` ExpensesBillable — unresolved $ref
        - `not_eq` ExpensesBillable — unresolved $ref
    - `forecasted_profit` union — Filter by forecasted profit amount range.
      - ForecastedProfit — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` ForecastedProfit — unresolved $ref
        - `not_contain` ForecastedProfit — unresolved $ref
        - `eq` ForecastedProfit — unresolved $ref
        - `not_eq` ForecastedProfit — unresolved $ref
    - `status` union — Filter by deal lifecycle status (open/won/lost/delivered).
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` Status — unresolved $ref
        - `eq` Status — unresolved $ref
        - `contains` Status — unresolved $ref
        - `not_contain` Status — unresolved $ref
      - Status — unresolved $ref
    - `id` union — Filter by deal ID.
      - Id — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` Id — unresolved $ref
        - `not_contain` Id — unresolved $ref
        - `eq` Id — unresolved $ref
        - `contains` Id — unresolved $ref
    - `forecasted_billable_time` union — Filter by forecasted remaining billable time range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` ForecastedBillableTime — unresolved $ref
        - `not_contain` ForecastedBillableTime — unresolved $ref
        - `not_eq` ForecastedBillableTime — unresolved $ref
        - `eq` ForecastedBillableTime — unresolved $ref
      - ForecastedBillableTime — unresolved $ref
    - `next_occurrence_on` union — Filter by next contract occurrence date range.
      - NextOccurrenceOn — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` NextOccurrenceOn — unresolved $ref
        - `eq` NextOccurrenceOn — unresolved $ref
        - `not_contain` NextOccurrenceOn — unresolved $ref
        - `contains` NextOccurrenceOn — unresolved $ref
    - `forecasted_budget_usage` union — Filter by forecasted budget usage percentage range.
      - ForecastedBudgetUsage — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` ForecastedBudgetUsage — unresolved $ref
        - `contains` ForecastedBudgetUsage — unresolved $ref
        - `eq` ForecastedBudgetUsage — unresolved $ref
        - `not_contain` ForecastedBudgetUsage — unresolved $ref
    - `name` union — Filter by deal name (text search).
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` Name — unresolved $ref
        - `contains` Name — unresolved $ref
        - `eq` Name — unresolved $ref
        - `not_eq` Name — unresolved $ref
      - Name — unresolved $ref
    - `retainer_interval` union — Filter by the deal retainer billing interval (week, two_weeks, month, quarter, half_year, or year).
      - object — Object form with operator key (eq, not_eq, contains, not_contain).
        - `not_eq` RetainerInterval — unresolved $ref
        - `contains` RetainerInterval — unresolved $ref
        - `not_contain` RetainerInterval — unresolved $ref
        - `eq` RetainerInterval — unresolved $ref
      - RetainerInterval — unresolved $ref
    - `fuzzy_dates` union — Filter by fuzzy date range (matches across multiple date fields).
      - FuzzyDates — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` FuzzyDates — unresolved $ref
        - `eq` FuzzyDates — unresolved $ref
        - `contains` FuzzyDates — unresolved $ref
        - `not_contain` FuzzyDates — unresolved $ref
    - `approval_policy_id` union — Filter by assigned approval policy.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` ApprovalPolicyId — unresolved $ref
        - `eq` ApprovalPolicyId — unresolved $ref
        - `not_contain` ApprovalPolicyId — unresolved $ref
        - `not_eq` ApprovalPolicyId — unresolved $ref
      - ApprovalPolicyId — unresolved $ref
    - `services_revenue` union — Filter by services revenue amount range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` ServicesRevenue — unresolved $ref
        - `contains` ServicesRevenue — unresolved $ref
        - `eq` ServicesRevenue — unresolved $ref
        - `not_eq` ServicesRevenue — unresolved $ref
      - ServicesRevenue — unresolved $ref
    - `future_cost` union — Filter by future cost amount range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` FutureCost — unresolved $ref
        - `not_contain` FutureCost — unresolved $ref
        - `contains` FutureCost — unresolved $ref
        - `not_eq` FutureCost — unresolved $ref
      - FutureCost — unresolved $ref
    - `contact_id` union — Filter by associated contact person.
      - ContactId — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` ContactId — unresolved $ref
        - `not_contain` ContactId — unresolved $ref
        - `contains` ContactId — unresolved $ref
        - `not_eq` ContactId — unresolved $ref
    - `end_date` union — Filter by end date range (`end_date`).
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` EndDate — unresolved $ref
        - `contains` EndDate — unresolved $ref
        - `not_contain` EndDate — unresolved $ref
        - `not_eq` EndDate — unresolved $ref
      - EndDate — unresolved $ref
    - `profit_margin` union — Filter by profit margin percentage range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` ProfitMargin — unresolved $ref
        - `contains` ProfitMargin — unresolved $ref
        - `not_eq` ProfitMargin — unresolved $ref
        - `eq` ProfitMargin — unresolved $ref
      - ProfitMargin — unresolved $ref
    - `worked_time` union — Filter by total worked time amount range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` WorkedTime — unresolved $ref
        - `not_contain` WorkedTime — unresolved $ref
        - `not_eq` WorkedTime — unresolved $ref
        - `eq` WorkedTime — unresolved $ref
      - WorkedTime — unresolved $ref
    - `status_id` union — Filter by pipeline stage.
      - StatusId — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` StatusId — unresolved $ref
        - `not_contain` StatusId — unresolved $ref
        - `not_eq` StatusId — unresolved $ref
        - `contains` StatusId — unresolved $ref
    - `date` union — Filter by deal start date range (`date`).
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` Date — unresolved $ref
        - `not_contain` Date — unresolved $ref
        - `contains` Date — unresolved $ref
        - `not_eq` Date — unresolved $ref
      - Date — unresolved $ref
    - `work_cost` union — Filter by work cost amount range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` WorkCost — unresolved $ref
        - `eq` WorkCost — unresolved $ref
        - `contains` WorkCost — unresolved $ref
        - `not_eq` WorkCost — unresolved $ref
      - WorkCost — unresolved $ref
    - `revenue_distribution_type` union — Filter by revenue distribution type.
      - RevenueDistributionType — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` RevenueDistributionType — unresolved $ref
        - `not_eq` RevenueDistributionType — unresolved $ref
        - `eq` RevenueDistributionType — unresolved $ref
        - `contains` RevenueDistributionType — unresolved $ref
    - `days_since_created` union — Filter by the number of days elapsed since the deal was created (`created_at`).
      - object — Object form with operator key (eq, not_eq, contains, not_contain).
        - `not_eq` DaysSinceCreated — unresolved $ref
        - `eq` DaysSinceCreated — unresolved $ref
        - `not_contain` DaysSinceCreated — unresolved $ref
        - `contains` DaysSinceCreated — unresolved $ref
      - DaysSinceCreated — unresolved $ref
    - `color_id` union — Filter by color label.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` ColorId — unresolved $ref
        - `contains` ColorId — unresolved $ref
        - `not_eq` ColorId — unresolved $ref
        - `not_contain` ColorId — unresolved $ref
      - ColorId — unresolved $ref
    - `invoiced_rate` union — Filter by invoiced rate (invoiced amount per hour) range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` InvoicedRate — unresolved $ref
        - `contains` InvoicedRate — unresolved $ref
        - `not_contain` InvoicedRate — unresolved $ref
        - `not_eq` InvoicedRate — unresolved $ref
      - InvoicedRate — unresolved $ref
    - `subscriber_id` union — Filter by subscriber (person following the deal).
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` SubscriberId — unresolved $ref
        - `not_contain` SubscriberId — unresolved $ref
        - `eq` SubscriberId — unresolved $ref
        - `not_eq` SubscriberId — unresolved $ref
      - SubscriberId — unresolved $ref
    - `budget_usage` union — Filter by budget usage percentage range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` BudgetUsage — unresolved $ref
        - `not_contain` BudgetUsage — unresolved $ref
        - `contains` BudgetUsage — unresolved $ref
        - `not_eq` BudgetUsage — unresolved $ref
      - BudgetUsage — unresolved $ref
    - `pipeline_id` union — Filter by associated pipeline.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` PipelineId — unresolved $ref
        - `eq` PipelineId — unresolved $ref
        - `not_eq` PipelineId — unresolved $ref
        - `not_contain` PipelineId — unresolved $ref
      - PipelineId — unresolved $ref
    - `parent_company_id` union — Filter by parent company ID, returning deals linked to companies that are children of the specified parent.
      - object — Object form with operator key (eq, not_eq, contains, not_contain).
        - `not_eq` ParentCompanyId — unresolved $ref
        - `contains` ParentCompanyId — unresolved $ref
        - `eq` ParentCompanyId — unresolved $ref
        - `not_contain` ParentCompanyId — unresolved $ref
      - ParentCompanyId — unresolved $ref
    - `contract_id` union — Filter by associated contract.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` ContractId — unresolved $ref
        - `not_contain` ContractId — unresolved $ref
        - `contains` ContractId — unresolved $ref
        - `not_eq` ContractId — unresolved $ref
      - ContractId — unresolved $ref
    - `projected_revenue` union — Filter by projected revenue amount range.
      - ProjectedRevenue — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` ProjectedRevenue — unresolved $ref
        - `contains` ProjectedRevenue — unresolved $ref
        - `eq` ProjectedRevenue — unresolved $ref
        - `not_eq` ProjectedRevenue — unresolved $ref
    - `future_budget_used` union — Filter by future budget used amount range.
      - FutureBudgetUsed — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` FutureBudgetUsed — unresolved $ref
        - `not_contain` FutureBudgetUsed — unresolved $ref
        - `contains` FutureBudgetUsed — unresolved $ref
        - `not_eq` FutureBudgetUsed — unresolved $ref
    - `number` union — Filter by deal/quote number (text search).
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` Number — unresolved $ref
        - `eq` Number — unresolved $ref
        - `contains` Number — unresolved $ref
        - `not_eq` Number — unresolved $ref
      - Number — unresolved $ref
    - `stage_updated_at` union — Filter by date the deal stage was last updated (`sales_status_updated_at`).
      - StageUpdatedAt — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` StageUpdatedAt — unresolved $ref
        - `not_eq` StageUpdatedAt — unresolved $ref
        - `not_contain` StageUpdatedAt — unresolved $ref
        - `contains` StageUpdatedAt — unresolved $ref
    - `company_id` union — Filter by client company.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` CompanyId — unresolved $ref
        - `not_contain` CompanyId — unresolved $ref
        - `contains` CompanyId — unresolved $ref
        - `not_eq` CompanyId — unresolved $ref
      - CompanyId — unresolved $ref
    - `days_since_last_activity` union — Filter by the number of days since the last activity was recorded on the deal (`last_activity_at`).
      - DaysSinceLastActivity — unresolved $ref
      - object — Object form with operator key (eq, not_eq, contains, not_contain).
        - `eq` DaysSinceLastActivity — unresolved $ref
        - `not_eq` DaysSinceLastActivity — unresolved $ref
        - `contains` DaysSinceLastActivity — unresolved $ref
        - `not_contain` DaysSinceLastActivity — unresolved $ref
    - `type` union — Filter by deal type (sales deal or production budget).
      - Type — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` Type — unresolved $ref
        - `contains` Type — unresolved $ref
        - `not_contain` Type — unresolved $ref
        - `not_eq` Type — unresolved $ref
    - `forecasted_margin` union — Filter by forecasted profit margin percentage range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` ForecastedMargin — unresolved $ref
        - `not_eq` ForecastedMargin — unresolved $ref
        - `contains` ForecastedMargin — unresolved $ref
        - `not_contain` ForecastedMargin — unresolved $ref
      - ForecastedMargin — unresolved $ref
    - `project_type` union — Filter by project type.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` ProjectType — unresolved $ref
        - `not_contain` ProjectType — unresolved $ref
        - `not_eq` ProjectType — unresolved $ref
        - `eq` ProjectType — unresolved $ref
      - ProjectType — unresolved $ref
    - `sales_closed_on` union — Filter by win/loss date.
      - SalesClosedOn — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` SalesClosedOn — unresolved $ref
        - `eq` SalesClosedOn — unresolved $ref
        - `not_contain` SalesClosedOn — unresolved $ref
        - `not_eq` SalesClosedOn — unresolved $ref
    - `lost_date` union — Filter deals lost on a specific date range (`sales_closed_on` where stage is lost).
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` LostDate — unresolved $ref
        - `not_contain` LostDate — unresolved $ref
        - `not_eq` LostDate — unresolved $ref
        - `eq` LostDate — unresolved $ref
      - LostDate — unresolved $ref
    - `created_at` union — Filter by creation date range (`created_at`).
      - CreatedAt — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` CreatedAt — unresolved $ref
        - `eq` CreatedAt — unresolved $ref
        - `contains` CreatedAt — unresolved $ref
        - `not_eq` CreatedAt — unresolved $ref
    - `deal_status_id` union — Filter by pipeline stage (deal status).
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` DealStatusId — unresolved $ref
        - `contains` DealStatusId — unresolved $ref
        - `eq` DealStatusId — unresolved $ref
        - `not_eq` DealStatusId — unresolved $ref
      - DealStatusId — unresolved $ref
    - `budget_warning` union — Filter by budget warning percentage threshold.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` BudgetWarning — unresolved $ref
        - `not_contain` BudgetWarning — unresolved $ref
        - `eq` BudgetWarning — unresolved $ref
        - `contains` BudgetWarning — unresolved $ref
      - BudgetWarning — unresolved $ref
    - `tags` union — Filter by tag.
      - Tags — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` Tags — unresolved $ref
        - `not_eq` Tags — unresolved $ref
        - `not_contain` Tags — unresolved $ref
        - `contains` Tags — unresolved $ref
    - `manual_invoicing_status` union — Filter by manual invoicing status (manually invoiced or not).
      - ManualInvoicingStatus — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` ManualInvoicingStatus — unresolved $ref
        - `eq` ManualInvoicingStatus — unresolved $ref
        - `not_eq` ManualInvoicingStatus — unresolved $ref
        - `not_contain` ManualInvoicingStatus — unresolved $ref
    - `previous_probability` union — Filter by the previous win probability percentage range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` PreviousProbability — unresolved $ref
        - `contains` PreviousProbability — unresolved $ref
        - `eq` PreviousProbability — unresolved $ref
        - `not_eq` PreviousProbability — unresolved $ref
      - PreviousProbability — unresolved $ref
    - `full_query` union — Filter by full-text search query.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` FullQuery — unresolved $ref
        - `eq` FullQuery — unresolved $ref
        - `not_eq` FullQuery — unresolved $ref
        - `contains` FullQuery — unresolved $ref
      - FullQuery — unresolved $ref
    - `probability` union — Filter by win probability percentage range.
      - Probability — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` Probability — unresolved $ref
        - `not_eq` Probability — unresolved $ref
        - `contains` Probability — unresolved $ref
        - `eq` Probability — unresolved $ref
    - `won_at` union — Filter by won date range (`won_at`).
      - WonAt — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` WonAt — unresolved $ref
        - `eq` WonAt — unresolved $ref
        - `not_eq` WonAt — unresolved $ref
        - `not_contain` WonAt — unresolved $ref
    - `tracking_type_id` union — Filter by tracking type.
      - TrackingTypeId — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` TrackingTypeId — unresolved $ref
        - `not_contain` TrackingTypeId — unresolved $ref
        - `eq` TrackingTypeId — unresolved $ref
        - `contains` TrackingTypeId — unresolved $ref
    - `sales_closed_at` union — Filter by win/loss timestamp.
      - SalesClosedAt — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` SalesClosedAt — unresolved $ref
        - `contains` SalesClosedAt — unresolved $ref
        - `not_eq` SalesClosedAt — unresolved $ref
        - `not_contain` SalesClosedAt — unresolved $ref
    - `needs_closing` union — Filter to include deals that are past their end date and not yet closed.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` NeedsClosing — unresolved $ref
- … truncated; see the full OpenAPI document linked below

## Headers

- `X-Organization-Id` string, required

## Response `200`

Collection deal

## Changes

- **2026-08-18** `7e6cad75fd81` — 2 breaking
  - for the `query` request parameter `filter`, the type of property `oneOf[subschema #1: Filter deal]/time_entry_requirements/oneOf[#/components/schemas/time_entry_requirements -> subschema #1: Time Entry Requirements]/` was specialized from no type to `array`
  - the `data/items/attributes/time_entry_requirements` response's property type changed from no type to `array` for status `200`

[Change history](https://skmtc.dev/productive/apis/api-documentation/changes/api/v2/deals/get.md)

---

[API](https://skmtc.dev/productive/apis/api-documentation.md) · [All operations](https://skmtc.dev/productive/apis/api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/productive/api-documentation/revisions/061c271b2e3a/schema)