---
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.
  - FilterDeal — Filter parameters for querying deals (sales pipeline opportunities).
    - `designated_approver_id` union — Filter by the designated approver person ID set on the deal (`designated_approver_id`).
      - DesignatedApproverId — unresolved $ref
      - object — Object form with operator key (eq, not_eq, contains, not_contain).
        - `contains` DesignatedApproverId — unresolved $ref
        - `not_eq` DesignatedApproverId — unresolved $ref
        - `eq` DesignatedApproverId — unresolved $ref
        - `not_contain` DesignatedApproverId — 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`.
        - `not_contain` WonAt — unresolved $ref
        - `eq` WonAt — unresolved $ref
        - `not_eq` WonAt — unresolved $ref
        - `contains` WonAt — 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_contain` LostReasonId — unresolved $ref
        - `contains` LostReasonId — unresolved $ref
        - `not_eq` LostReasonId — unresolved $ref
        - `eq` LostReasonId — unresolved $ref
    - `recurring` union — Filter by recurring/retainer status.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` Recurring — unresolved $ref
        - `contains` Recurring — unresolved $ref
        - `eq` Recurring — unresolved $ref
        - `not_eq` Recurring — unresolved $ref
      - Recurring — unresolved $ref
    - `previous_deal_status_id` union — Filter by the previous pipeline stage the deal was in.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` PreviousDealStatusId — unresolved $ref
        - `eq` PreviousDealStatusId — unresolved $ref
        - `not_contain` PreviousDealStatusId — unresolved $ref
        - `contains` PreviousDealStatusId — unresolved $ref
      - PreviousDealStatusId — unresolved $ref
    - `invoiced` union — Filter by invoiced amount range.
      - Invoiced — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` Invoiced — unresolved $ref
        - `not_eq` Invoiced — unresolved $ref
        - `contains` Invoiced — unresolved $ref
        - `eq` Invoiced — unresolved $ref
    - `previous_probability` union — Filter by the previous win probability percentage range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` PreviousProbability — unresolved $ref
        - `not_contain` PreviousProbability — unresolved $ref
        - `not_eq` PreviousProbability — unresolved $ref
        - `contains` PreviousProbability — unresolved $ref
      - PreviousProbability — unresolved $ref
    - `template` union — Filter to show deal templates only.
      - Template — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` Template — unresolved $ref
        - `not_eq` Template — unresolved $ref
        - `eq` Template — unresolved $ref
        - `not_contain` Template — unresolved $ref
    - `needs_closing` union — Filter to include deals that are past their end date and not yet closed.
      - NeedsClosing — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` NeedsClosing — unresolved $ref
        - `not_contain` NeedsClosing — unresolved $ref
        - `contains` NeedsClosing — unresolved $ref
        - `eq` NeedsClosing — unresolved $ref
    - `credited` union — Filter by credited amount range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` Credited — unresolved $ref
        - `not_contain` Credited — unresolved $ref
        - `contains` Credited — unresolved $ref
        - `eq` Credited — unresolved $ref
      - Credited — 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
        - `not_eq` CreatedAt — unresolved $ref
        - `eq` CreatedAt — unresolved $ref
        - `contains` CreatedAt — unresolved $ref
    - `actual_rate` union — Filter by actual hourly rate (revenue per hour worked).
      - ActualRate — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` ActualRate — unresolved $ref
        - `contains` ActualRate — unresolved $ref
        - `eq` ActualRate — unresolved $ref
        - `not_contain` ActualRate — 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`.
        - `contains` Query — unresolved $ref
        - `not_eq` Query — unresolved $ref
        - `not_contain` Query — unresolved $ref
        - `eq` Query — unresolved $ref
      - Query — unresolved $ref
    - `budgeted_time` union — Filter by total budgeted time amount range.
      - BudgetedTime — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` BudgetedTime — unresolved $ref
        - `contains` BudgetedTime — unresolved $ref
        - `not_contain` BudgetedTime — unresolved $ref
        - `eq` BudgetedTime — unresolved $ref
    - `time_entry_requirements` union — Filter deals by the fields their time entries are required to include.
      - object
        - `eq` 'note' | 'task' — Match deals whose required time entry fields are exactly this set.
        - `contains` 'note' | 'task' — Match deals that require all of these time entry fields.
        - `not_eq` 'note' | 'task' — Exclude deals whose required time entry fields are exactly this set.
        - `none_of` 'note' | 'task' — Match deals that require none of these time entry fields.
        - `not_contain` 'note' | 'task' — Exclude deals that require all of these time entry fields.
        - `any_of` 'note' | 'task' — Match deals that require at least one of these time entry fields.
      - TimeEntryRequirements — unresolved $ref
    - `responsible_id` union — Filter by responsible person.
      - ResponsibleId — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` ResponsibleId — unresolved $ref
        - `eq` ResponsibleId — unresolved $ref
        - `contains` ResponsibleId — unresolved $ref
        - `not_contain` ResponsibleId — unresolved $ref
    - `name` union — Filter by deal name (text search).
      - Name — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` Name — unresolved $ref
        - `not_contain` Name — unresolved $ref
        - `not_eq` Name — unresolved $ref
        - `contains` Name — unresolved $ref
    - `worked_time` union — Filter by total worked time amount range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` WorkedTime — unresolved $ref
        - `not_eq` WorkedTime — unresolved $ref
        - `eq` WorkedTime — unresolved $ref
        - `contains` WorkedTime — unresolved $ref
      - WorkedTime — unresolved $ref
    - `budget_used` union — Filter by amount of budget used.
      - BudgetUsed — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` BudgetUsed — unresolved $ref
        - `not_contain` BudgetUsed — unresolved $ref
        - `eq` BudgetUsed — unresolved $ref
        - `contains` BudgetUsed — unresolved $ref
    - `expense` union — Filter by total expenses amount range.
      - Expense — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` Expense — unresolved $ref
        - `eq` Expense — unresolved $ref
        - `not_eq` Expense — unresolved $ref
        - `not_contain` Expense — unresolved $ref
    - `pending_invoicing` union — Filter by pending invoicing amount range.
      - PendingInvoicing — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` PendingInvoicing — unresolved $ref
        - `eq` PendingInvoicing — unresolved $ref
        - `not_contain` PendingInvoicing — unresolved $ref
        - `contains` PendingInvoicing — unresolved $ref
    - `revenue` union — Filter by total revenue amount range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` Revenue — unresolved $ref
        - `eq` Revenue — unresolved $ref
        - `not_contain` Revenue — unresolved $ref
        - `contains` Revenue — unresolved $ref
      - Revenue — unresolved $ref
    - `profit` union — Filter by profit amount range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` Profit — unresolved $ref
        - `not_contain` Profit — unresolved $ref
        - `eq` Profit — unresolved $ref
        - `not_eq` Profit — unresolved $ref
      - Profit — unresolved $ref
    - `draft_invoiced` union — Filter by draft invoiced amount range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` DraftInvoiced — unresolved $ref
        - `not_contain` DraftInvoiced — unresolved $ref
        - `not_eq` DraftInvoiced — unresolved $ref
        - `contains` DraftInvoiced — unresolved $ref
      - DraftInvoiced — unresolved $ref
    - `tags` union — Filter by tag.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` Tags — unresolved $ref
        - `not_contain` Tags — unresolved $ref
        - `not_eq` Tags — unresolved $ref
        - `contains` Tags — unresolved $ref
      - Tags — unresolved $ref
    - `forecasted_time_usage` union — Filter by forecasted time usage percentage range.
      - ForecastedTimeUsage — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` ForecastedTimeUsage — unresolved $ref
        - `eq` ForecastedTimeUsage — unresolved $ref
        - `not_eq` ForecastedTimeUsage — unresolved $ref
        - `not_contain` ForecastedTimeUsage — 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
        - `contains` ForecastedMargin — unresolved $ref
        - `not_contain` ForecastedMargin — unresolved $ref
        - `not_eq` ForecastedMargin — unresolved $ref
      - ForecastedMargin — unresolved $ref
    - `budget_warning` union — Filter by budget warning percentage threshold.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` BudgetWarning — unresolved $ref
        - `not_contain` BudgetWarning — unresolved $ref
        - `contains` BudgetWarning — unresolved $ref
        - `not_eq` BudgetWarning — unresolved $ref
      - BudgetWarning — unresolved $ref
    - `budget_status` union — Filter by budget open/closed status.
      - BudgetStatus — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` BudgetStatus — unresolved $ref
        - `not_contain` BudgetStatus — unresolved $ref
        - `not_eq` BudgetStatus — unresolved $ref
        - `eq` BudgetStatus — unresolved $ref
    - `deal_status_id` union — Filter by pipeline stage (deal status).
      - DealStatusId — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` DealStatusId — unresolved $ref
        - `eq` DealStatusId — unresolved $ref
        - `not_contain` DealStatusId — unresolved $ref
        - `not_eq` DealStatusId — 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_contain` FuzzyDates — unresolved $ref
        - `eq` FuzzyDates — unresolved $ref
        - `not_eq` FuzzyDates — unresolved $ref
        - `contains` FuzzyDates — unresolved $ref
    - `billable_time` union — Filter by total billable time amount range.
      - BillableTime — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` BillableTime — unresolved $ref
        - `contains` BillableTime — unresolved $ref
        - `eq` BillableTime — unresolved $ref
        - `not_contain` BillableTime — 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`.
        - `not_contain` StageUpdatedAt — unresolved $ref
        - `eq` StageUpdatedAt — unresolved $ref
        - `not_eq` StageUpdatedAt — unresolved $ref
        - `contains` StageUpdatedAt — 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
        - `contains` BudgetUsage — unresolved $ref
        - `not_contain` BudgetUsage — unresolved $ref
        - `not_eq` BudgetUsage — unresolved $ref
      - BudgetUsage — unresolved $ref
    - `budget_total` union — Filter by total budget amount range.
      - BudgetTotal — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` BudgetTotal — unresolved $ref
        - `contains` BudgetTotal — unresolved $ref
        - `not_eq` BudgetTotal — unresolved $ref
        - `eq` BudgetTotal — unresolved $ref
    - `tracking_type_id` union — Filter by tracking type.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` TrackingTypeId — unresolved $ref
        - `not_contain` TrackingTypeId — unresolved $ref
        - `contains` TrackingTypeId — unresolved $ref
        - `eq` TrackingTypeId — unresolved $ref
      - TrackingTypeId — 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).
        - `eq` DaysInCurrentStage — unresolved $ref
        - `not_eq` DaysInCurrentStage — unresolved $ref
        - `contains` DaysInCurrentStage — unresolved $ref
        - `not_contain` DaysInCurrentStage — unresolved $ref
      - DaysInCurrentStage — unresolved $ref
    - `status_id` union — Filter by pipeline stage.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` StatusId — unresolved $ref
        - `not_contain` StatusId — unresolved $ref
        - `eq` StatusId — unresolved $ref
        - `not_eq` StatusId — unresolved $ref
      - StatusId — 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`).
      - object — Object form with operator key (eq, not_eq, contains, not_contain).
        - `contains` DaysSinceLastActivity — unresolved $ref
        - `not_contain` DaysSinceLastActivity — unresolved $ref
        - `eq` DaysSinceLastActivity — unresolved $ref
        - `not_eq` DaysSinceLastActivity — unresolved $ref
      - DaysSinceLastActivity — unresolved $ref
    - `custom_fields` union — Filter by custom field values.
      - CustomFields — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` CustomFields — unresolved $ref
        - `contains` CustomFields — unresolved $ref
        - `not_eq` CustomFields — unresolved $ref
        - `eq` CustomFields — 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
        - `contains` Id — unresolved $ref
        - `eq` Id — unresolved $ref
        - `not_contain` Id — unresolved $ref
    - `project_type` union — Filter by project type.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` ProjectType — unresolved $ref
        - `contains` ProjectType — unresolved $ref
        - `eq` ProjectType — unresolved $ref
        - `not_contain` ProjectType — unresolved $ref
      - ProjectType — 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`.
        - `not_eq` ForecastedCost — unresolved $ref
        - `eq` ForecastedCost — unresolved $ref
        - `not_contain` ForecastedCost — unresolved $ref
        - `contains` ForecastedCost — unresolved $ref
    - `stage_status_id` union — Filter by pipeline stage outcome status.
      - StageStatusId — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` StageStatusId — unresolved $ref
        - `not_eq` StageStatusId — unresolved $ref
        - `contains` StageStatusId — unresolved $ref
        - `eq` StageStatusId — unresolved $ref
    - `approval_policy_id` union — Filter by assigned approval policy.
      - ApprovalPolicyId — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` ApprovalPolicyId — unresolved $ref
        - `not_contain` ApprovalPolicyId — unresolved $ref
        - `not_eq` ApprovalPolicyId — unresolved $ref
        - `contains` ApprovalPolicyId — unresolved $ref
    - `sales_status_id` union — Filter by sales outcome status (won, lost, open).
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` SalesStatusId — unresolved $ref
        - `contains` SalesStatusId — unresolved $ref
        - `not_contain` SalesStatusId — unresolved $ref
        - `eq` SalesStatusId — unresolved $ref
      - SalesStatusId — unresolved $ref
    - `date` union — Filter by deal start date range (`date`).
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` Date — unresolved $ref
        - `contains` Date — unresolved $ref
        - `eq` Date — unresolved $ref
        - `not_contain` Date — unresolved $ref
      - Date — 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`.
        - `not_eq` Type — unresolved $ref
        - `eq` Type — unresolved $ref
        - `contains` Type — unresolved $ref
        - `not_contain` Type — unresolved $ref
    - `subsidiary_id` union — Filter by subsidiary company.
      - SubsidiaryId — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` SubsidiaryId — unresolved $ref
        - `contains` SubsidiaryId — unresolved $ref
        - `not_contain` SubsidiaryId — unresolved $ref
        - `not_eq` SubsidiaryId — 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).
        - `eq` ParentCompanyId — unresolved $ref
        - `not_eq` ParentCompanyId — unresolved $ref
        - `contains` ParentCompanyId — unresolved $ref
        - `not_contain` ParentCompanyId — unresolved $ref
      - ParentCompanyId — unresolved $ref
    - `accessible_by_person` union — Filter deals accessible by a specific person.
      - AccessibleByPerson — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` AccessibleByPerson — unresolved $ref
        - `not_contain` AccessibleByPerson — unresolved $ref
        - `contains` AccessibleByPerson — unresolved $ref
        - `eq` AccessibleByPerson — unresolved $ref
    - `projected_revenue` union — Filter by projected revenue amount range.
      - ProjectedRevenue — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` ProjectedRevenue — unresolved $ref
        - `not_contain` ProjectedRevenue — unresolved $ref
        - `not_eq` ProjectedRevenue — unresolved $ref
        - `contains` ProjectedRevenue — unresolved $ref
    - `purchase_order_number` union — Filter by purchase order number (text search).
      - PurchaseOrderNumber — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` PurchaseOrderNumber — unresolved $ref
        - `not_eq` PurchaseOrderNumber — unresolved $ref
        - `eq` PurchaseOrderNumber — unresolved $ref
        - `not_contain` PurchaseOrderNumber — 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.
        - `contains` LastActivityAt — unresolved $ref
        - `not_contain` LastActivityAt — unresolved $ref
        - `not_eq` LastActivityAt — unresolved $ref
        - `eq` LastActivityAt — unresolved $ref
    - `lost_date` union — Filter deals lost on a specific date range (`sales_closed_on` where stage is lost).
      - LostDate — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` LostDate — unresolved $ref
        - `contains` LostDate — unresolved $ref
        - `not_contain` LostDate — unresolved $ref
        - `not_eq` LostDate — unresolved $ref
    - `currency` union — Filter by deal currency.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` Currency — unresolved $ref
        - `contains` Currency — unresolved $ref
        - `eq` Currency — unresolved $ref
        - `not_eq` Currency — unresolved $ref
      - Currency — unresolved $ref
    - `forecasted_revenue` union — Filter by forecasted total revenue amount range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` ForecastedRevenue — unresolved $ref
        - `not_contain` ForecastedRevenue — unresolved $ref
        - `eq` ForecastedRevenue — unresolved $ref
        - `contains` ForecastedRevenue — unresolved $ref
      - ForecastedRevenue — unresolved $ref
    - `closed_at` union — Filter by closure date range (`closed_at`).
      - ClosedAt — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` ClosedAt — unresolved $ref
        - `not_eq` ClosedAt — unresolved $ref
        - `not_contain` ClosedAt — unresolved $ref
        - `contains` ClosedAt — 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`.
        - `contains` CreatorId — unresolved $ref
        - `not_contain` CreatorId — unresolved $ref
        - `not_eq` CreatorId — unresolved $ref
        - `eq` CreatorId — unresolved $ref
    - `invoiced_percentage` union — Filter by invoiced percentage range.
      - InvoicedPercentage — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` InvoicedPercentage — unresolved $ref
        - `contains` InvoicedPercentage — unresolved $ref
        - `eq` InvoicedPercentage — unresolved $ref
        - `not_contain` InvoicedPercentage — unresolved $ref
    - `cost` union — Filter by total cost (work cost plus expenses) amount range.
      - Cost — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` Cost — unresolved $ref
        - `not_eq` Cost — unresolved $ref
        - `not_contain` Cost — unresolved $ref
        - `eq` Cost — unresolved $ref
    - `jump_query` union — Filter by deal name or number (quick jump search).
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` JumpQuery — unresolved $ref
        - `contains` JumpQuery — unresolved $ref
        - `eq` JumpQuery — unresolved $ref
        - `not_eq` JumpQuery — unresolved $ref
      - JumpQuery — unresolved $ref
    - `manual_invoicing_status` union — Filter by manual invoicing status (manually invoiced or not).
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` ManualInvoicingStatus — unresolved $ref
        - `not_eq` ManualInvoicingStatus — unresolved $ref
        - `not_contain` ManualInvoicingStatus — unresolved $ref
        - `eq` ManualInvoicingStatus — unresolved $ref
      - ManualInvoicingStatus — unresolved $ref
    - `sales_closed_on` union — Filter by win/loss date.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` SalesClosedOn — unresolved $ref
        - `not_eq` SalesClosedOn — unresolved $ref
        - `contains` SalesClosedOn — unresolved $ref
        - `not_contain` SalesClosedOn — unresolved $ref
      - SalesClosedOn — unresolved $ref
    - `todo_due_date` union — Filter by next to-do due date.
      - TodoDueDate — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` TodoDueDate — unresolved $ref
        - `eq` TodoDueDate — unresolved $ref
        - `contains` TodoDueDate — unresolved $ref
        - `not_eq` TodoDueDate — unresolved $ref
    - `pipeline_id` union — Filter by associated pipeline.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` PipelineId — unresolved $ref
        - `not_eq` PipelineId — unresolved $ref
        - `not_contain` PipelineId — unresolved $ref
        - `eq` PipelineId — unresolved $ref
      - PipelineId — unresolved $ref
    - `sales_closed_at` union — Filter by win/loss timestamp.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` SalesClosedAt — unresolved $ref
        - `eq` SalesClosedAt — unresolved $ref
        - `contains` SalesClosedAt — unresolved $ref
        - `not_contain` SalesClosedAt — unresolved $ref
      - SalesClosedAt — unresolved $ref
    - `delivered_on` union — Filter by delivery date range (`delivered_on`).
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` DeliveredOn — unresolved $ref
        - `not_eq` DeliveredOn — unresolved $ref
        - `eq` DeliveredOn — unresolved $ref
        - `contains` DeliveredOn — unresolved $ref
      - DeliveredOn — unresolved $ref
    - `future_booked_time` union — Filter by future booked time amount range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` FutureBookedTime — unresolved $ref
        - `not_eq` FutureBookedTime — unresolved $ref
        - `eq` FutureBookedTime — unresolved $ref
        - `contains` FutureBookedTime — unresolved $ref
      - FutureBookedTime — unresolved $ref
    - `subscriber_id` union — Filter by subscriber (person following the deal).
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` SubscriberId — unresolved $ref
        - `not_contain` SubscriberId — unresolved $ref
        - `eq` SubscriberId — unresolved $ref
        - `contains` SubscriberId — unresolved $ref
      - SubscriberId — unresolved $ref
    - `estimated_cost` union — Filter by estimated cost amount range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` EstimatedCost — 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/0e862879d77b/schema)