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

- `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).
    - `color_id` union — Filter by color label.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` ColorId — unresolved $ref
        - `not_eq` ColorId — unresolved $ref
        - `eq` ColorId — unresolved $ref
        - `not_contain` ColorId — unresolved $ref
      - ColorId — unresolved $ref
    - `end_date` union — Filter by end date range (`end_date`).
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` EndDate — unresolved $ref
        - `contains` EndDate — unresolved $ref
        - `eq` EndDate — unresolved $ref
        - `not_eq` EndDate — unresolved $ref
      - EndDate — unresolved $ref
    - `stage_status_id` union — Filter by pipeline stage outcome status.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` StageStatusId — unresolved $ref
        - `eq` StageStatusId — unresolved $ref
        - `not_contain` StageStatusId — unresolved $ref
        - `contains` StageStatusId — unresolved $ref
      - StageStatusId — unresolved $ref
    - `origin_deal_id` union — Filter by the originating deal this budget was created from.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` OriginDealId — unresolved $ref
        - `contains` OriginDealId — unresolved $ref
        - `not_contain` OriginDealId — unresolved $ref
        - `not_eq` OriginDealId — unresolved $ref
      - OriginDealId — unresolved $ref
    - `creator_id` union — Filter by the person who created the deal.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` CreatorId — unresolved $ref
        - `eq` CreatorId — unresolved $ref
        - `not_contain` CreatorId — unresolved $ref
        - `not_eq` CreatorId — unresolved $ref
      - CreatorId — 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_contain` NextOccurrenceOn — unresolved $ref
        - `eq` NextOccurrenceOn — unresolved $ref
        - `not_eq` NextOccurrenceOn — unresolved $ref
        - `contains` NextOccurrenceOn — 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`.
        - `contains` BillableTime — unresolved $ref
        - `eq` BillableTime — unresolved $ref
        - `not_contain` BillableTime — unresolved $ref
        - `not_eq` BillableTime — unresolved $ref
    - `invoiced_percentage` union — Filter by invoiced percentage range.
      - InvoicedPercentage — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` InvoicedPercentage — unresolved $ref
        - `contains` InvoicedPercentage — unresolved $ref
        - `eq` InvoicedPercentage — unresolved $ref
        - `not_eq` InvoicedPercentage — unresolved $ref
    - `status_id` union — Filter by pipeline stage.
      - StatusId — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` StatusId — unresolved $ref
        - `not_eq` StatusId — unresolved $ref
        - `eq` StatusId — unresolved $ref
        - `contains` StatusId — unresolved $ref
    - `created_at` union — Filter by creation date range (`created_at`).
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` CreatedAt — unresolved $ref
        - `contains` CreatedAt — unresolved $ref
        - `not_eq` CreatedAt — unresolved $ref
        - `eq` CreatedAt — unresolved $ref
      - CreatedAt — unresolved $ref
    - `draft_invoiced` union — Filter by draft invoiced amount range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` DraftInvoiced — unresolved $ref
        - `contains` DraftInvoiced — unresolved $ref
        - `not_contain` DraftInvoiced — unresolved $ref
        - `eq` DraftInvoiced — unresolved $ref
      - DraftInvoiced — unresolved $ref
    - `todo_due_date` union — Filter by next to-do due date.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` TodoDueDate — unresolved $ref
        - `contains` TodoDueDate — unresolved $ref
        - `not_eq` TodoDueDate — unresolved $ref
        - `eq` TodoDueDate — unresolved $ref
      - TodoDueDate — unresolved $ref
    - `fuzzy_dates` union — Filter by fuzzy date range (matches across multiple date fields).
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` FuzzyDates — unresolved $ref
        - `contains` FuzzyDates — unresolved $ref
        - `not_eq` FuzzyDates — unresolved $ref
        - `not_contain` FuzzyDates — unresolved $ref
      - FuzzyDates — unresolved $ref
    - `pipeline_id` union — Filter by associated pipeline.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` PipelineId — unresolved $ref
        - `not_contain` PipelineId — unresolved $ref
        - `eq` PipelineId — unresolved $ref
        - `not_eq` PipelineId — unresolved $ref
      - PipelineId — unresolved $ref
    - `lost_reason_id` union — Filter by associated lost reason.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` LostReasonId — unresolved $ref
        - `not_contain` LostReasonId — unresolved $ref
        - `eq` LostReasonId — unresolved $ref
        - `not_eq` LostReasonId — unresolved $ref
      - LostReasonId — unresolved $ref
    - `estimated_time` union — Filter by total estimated time amount range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` EstimatedTime — unresolved $ref
        - `not_eq` EstimatedTime — unresolved $ref
        - `not_contain` EstimatedTime — unresolved $ref
        - `eq` EstimatedTime — unresolved $ref
      - EstimatedTime — unresolved $ref
    - `id` union — Filter by deal ID.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` Id — unresolved $ref
        - `not_contain` Id — unresolved $ref
        - `not_eq` Id — unresolved $ref
        - `eq` Id — unresolved $ref
      - Id — 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
        - `not_contain` PreviousDealStatusId — unresolved $ref
        - `contains` PreviousDealStatusId — unresolved $ref
        - `eq` PreviousDealStatusId — unresolved $ref
      - PreviousDealStatusId — unresolved $ref
    - `forecasted_cost` union — Filter by forecasted total cost amount range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` ForecastedCost — unresolved $ref
        - `eq` ForecastedCost — unresolved $ref
        - `not_contain` ForecastedCost — unresolved $ref
        - `not_eq` ForecastedCost — unresolved $ref
      - ForecastedCost — unresolved $ref
    - `days_in_current_stage` union — Filter by the number of days the deal has been in its current pipeline stage.
      - DaysInCurrentStage — unresolved $ref
      - object — Object form with operator key (eq, not_eq, contains, not_contain).
        - `eq` DaysInCurrentStage — unresolved $ref
        - `contains` DaysInCurrentStage — unresolved $ref
        - `not_contain` DaysInCurrentStage — unresolved $ref
        - `not_eq` DaysInCurrentStage — unresolved $ref
    - `forecasted_revenue` union — Filter by forecasted total revenue amount range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` ForecastedRevenue — unresolved $ref
        - `not_eq` ForecastedRevenue — unresolved $ref
        - `eq` ForecastedRevenue — unresolved $ref
        - `not_contain` ForecastedRevenue — unresolved $ref
      - ForecastedRevenue — unresolved $ref
    - `expense` union — Filter by total expenses amount range.
      - Expense — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` Expense — unresolved $ref
        - `not_eq` Expense — unresolved $ref
        - `contains` Expense — unresolved $ref
        - `eq` Expense — unresolved $ref
    - `forecasted_budget_used` union — Filter by forecasted total budget used amount range.
      - ForecastedBudgetUsed — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` ForecastedBudgetUsed — unresolved $ref
        - `eq` ForecastedBudgetUsed — unresolved $ref
        - `contains` ForecastedBudgetUsed — unresolved $ref
        - `not_eq` ForecastedBudgetUsed — 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_contain` ClosedAt — unresolved $ref
        - `not_eq` ClosedAt — unresolved $ref
        - `contains` ClosedAt — unresolved $ref
    - `budget_usage` union — Filter by budget usage percentage range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` BudgetUsage — unresolved $ref
        - `not_contain` BudgetUsage — unresolved $ref
        - `eq` BudgetUsage — unresolved $ref
        - `contains` BudgetUsage — unresolved $ref
      - BudgetUsage — 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.
        - `any_of` 'note' | 'task' — Match deals that require at least one of these time entry fields.
        - `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.
      - TimeEntryRequirements — unresolved $ref
    - `invoiced` union — Filter by invoiced amount range.
      - Invoiced — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` Invoiced — unresolved $ref
        - `not_contain` Invoiced — unresolved $ref
        - `contains` Invoiced — unresolved $ref
        - `not_eq` Invoiced — unresolved $ref
    - `forecasted_billable_time` union — Filter by forecasted remaining billable time range.
      - ForecastedBillableTime — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` ForecastedBillableTime — unresolved $ref
        - `eq` ForecastedBillableTime — unresolved $ref
        - `contains` ForecastedBillableTime — unresolved $ref
        - `not_contain` ForecastedBillableTime — unresolved $ref
    - `budget_remaining` union — Filter by remaining budget amount range.
      - BudgetRemaining — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` BudgetRemaining — unresolved $ref
        - `eq` BudgetRemaining — unresolved $ref
        - `not_contain` BudgetRemaining — unresolved $ref
        - `contains` BudgetRemaining — 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
        - `eq` PurchaseOrderNumber — unresolved $ref
        - `contains` PurchaseOrderNumber — unresolved $ref
        - `not_contain` PurchaseOrderNumber — unresolved $ref
      - PurchaseOrderNumber — unresolved $ref
    - `approval_policy_id` union — Filter by assigned approval policy.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` ApprovalPolicyId — unresolved $ref
        - `contains` ApprovalPolicyId — unresolved $ref
        - `eq` ApprovalPolicyId — unresolved $ref
        - `not_eq` ApprovalPolicyId — unresolved $ref
      - ApprovalPolicyId — 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).
        - `contains` ParentCompanyId — unresolved $ref
        - `not_eq` ParentCompanyId — unresolved $ref
        - `not_contain` ParentCompanyId — unresolved $ref
        - `eq` ParentCompanyId — unresolved $ref
      - ParentCompanyId — unresolved $ref
    - `status` union — Filter by deal lifecycle status (open/won/lost/delivered).
      - Status — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` Status — unresolved $ref
        - `not_eq` Status — unresolved $ref
        - `eq` Status — unresolved $ref
        - `not_contain` Status — unresolved $ref
    - `fuzzy_people` union — Filter by associated people using fuzzy matching.
      - FuzzyPeople — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` FuzzyPeople — unresolved $ref
        - `not_contain` FuzzyPeople — unresolved $ref
        - `not_eq` FuzzyPeople — unresolved $ref
        - `eq` FuzzyPeople — unresolved $ref
    - `previous_or_current_deal_status_id` union — Filter by pipeline stage matching either the current or previous deal status.
      - PreviousOrCurrentDealStatusId — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` PreviousOrCurrentDealStatusId — unresolved $ref
        - `not_eq` PreviousOrCurrentDealStatusId — unresolved $ref
        - `contains` PreviousOrCurrentDealStatusId — unresolved $ref
        - `not_contain` PreviousOrCurrentDealStatusId — unresolved $ref
    - `won_date` union — Filter deals won on a specific date range (`sales_closed_on` where stage is won).
      - WonDate — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` WonDate — unresolved $ref
        - `eq` WonDate — unresolved $ref
        - `not_contain` WonDate — unresolved $ref
        - `not_eq` WonDate — 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
        - `contains` PreviousProbability — unresolved $ref
        - `not_eq` PreviousProbability — unresolved $ref
      - PreviousProbability — unresolved $ref
    - `contact_id` union — Filter by associated contact person.
      - ContactId — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` ContactId — unresolved $ref
        - `not_eq` ContactId — unresolved $ref
        - `eq` ContactId — unresolved $ref
        - `not_contain` ContactId — unresolved $ref
    - `custom_fields` union — Filter by custom field values.
      - CustomFields — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` CustomFields — unresolved $ref
        - `contains` CustomFields — unresolved $ref
        - `not_contain` CustomFields — unresolved $ref
        - `eq` CustomFields — unresolved $ref
    - `estimated_remaining_time` union — Filter by estimated remaining time amount range.
      - EstimatedRemainingTime — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` EstimatedRemainingTime — unresolved $ref
        - `contains` EstimatedRemainingTime — unresolved $ref
        - `not_contain` EstimatedRemainingTime — unresolved $ref
        - `not_eq` EstimatedRemainingTime — 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
    - `responsible_id` union — Filter by responsible person.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` ResponsibleId — unresolved $ref
        - `contains` ResponsibleId — unresolved $ref
        - `not_eq` ResponsibleId — unresolved $ref
        - `not_contain` ResponsibleId — unresolved $ref
      - ResponsibleId — 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`.
        - `not_eq` ManualInvoicingStatus — unresolved $ref
        - `contains` ManualInvoicingStatus — unresolved $ref
        - `not_contain` ManualInvoicingStatus — unresolved $ref
        - `eq` ManualInvoicingStatus — unresolved $ref
      - ManualInvoicingStatus — unresolved $ref
    - `estimated_cost` union — Filter by estimated cost amount range.
      - EstimatedCost — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` EstimatedCost — unresolved $ref
        - `contains` EstimatedCost — unresolved $ref
        - `eq` EstimatedCost — unresolved $ref
        - `not_contain` EstimatedCost — unresolved $ref
    - `accessible_by_person` union — Filter deals accessible by a specific person.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` AccessibleByPerson — unresolved $ref
        - `not_contain` AccessibleByPerson — unresolved $ref
        - `not_eq` AccessibleByPerson — unresolved $ref
        - `eq` AccessibleByPerson — unresolved $ref
      - AccessibleByPerson — unresolved $ref
    - `days_since_created` union — Filter by the number of days elapsed since the deal was created (`created_at`).
      - DaysSinceCreated — unresolved $ref
      - object — Object form with operator key (eq, not_eq, contains, not_contain).
        - `contains` DaysSinceCreated — unresolved $ref
        - `not_eq` DaysSinceCreated — unresolved $ref
        - `eq` DaysSinceCreated — unresolved $ref
        - `not_contain` DaysSinceCreated — 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
        - `eq` Date — unresolved $ref
        - `not_contain` Date — unresolved $ref
        - `contains` Date — unresolved $ref
      - Date — unresolved $ref
    - `projected_revenue` union — Filter by projected revenue amount range.
      - 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
      - ProjectedRevenue — unresolved $ref
    - `currency` union — Filter by deal currency.
      - Currency — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` Currency — unresolved $ref
        - `contains` Currency — unresolved $ref
        - `not_contain` Currency — unresolved $ref
        - `eq` Currency — 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_eq` SubsidiaryId — unresolved $ref
        - `not_contain` SubsidiaryId — unresolved $ref
    - `unapproved_time` union — Filter by unapproved time amount range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` UnapprovedTime — unresolved $ref
        - `not_contain` UnapprovedTime — unresolved $ref
        - `not_eq` UnapprovedTime — unresolved $ref
        - `contains` UnapprovedTime — unresolved $ref
      - UnapprovedTime — unresolved $ref
    - `lost_at` union — Filter by lost date range (`lost_at`).
      - LostAt — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` LostAt — unresolved $ref
        - `eq` LostAt — unresolved $ref
        - `not_eq` LostAt — unresolved $ref
        - `contains` LostAt — unresolved $ref
    - `work_cost` union — Filter by work cost amount range.
      - WorkCost — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` WorkCost — unresolved $ref
        - `eq` WorkCost — unresolved $ref
        - `not_eq` WorkCost — unresolved $ref
        - `not_contain` WorkCost — 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_eq` LastActivityAt — unresolved $ref
        - `not_contain` LastActivityAt — unresolved $ref
        - `contains` LastActivityAt — unresolved $ref
        - `eq` LastActivityAt — unresolved $ref
    - `forecasted_margin` union — Filter by forecasted profit margin percentage range.
      - ForecastedMargin — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` ForecastedMargin — unresolved $ref
        - `contains` ForecastedMargin — unresolved $ref
        - `eq` ForecastedMargin — unresolved $ref
        - `not_contain` ForecastedMargin — unresolved $ref
    - `template` union — Filter to show deal templates only.
      - Template — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` Template — unresolved $ref
        - `eq` Template — unresolved $ref
        - `contains` Template — unresolved $ref
        - `not_eq` Template — unresolved $ref
    - `future_cost` union — Filter by future cost amount range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` FutureCost — unresolved $ref
        - `not_eq` FutureCost — unresolved $ref
        - `eq` FutureCost — unresolved $ref
        - `contains` FutureCost — unresolved $ref
      - FutureCost — 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`.
        - `eq` BudgetedTime — unresolved $ref
        - `not_eq` BudgetedTime — unresolved $ref
        - `contains` BudgetedTime — unresolved $ref
        - `not_contain` BudgetedTime — unresolved $ref
    - `recurring_ends_on` union — Filter by recurring contract end date range.
      - RecurringEndsOn — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` RecurringEndsOn — unresolved $ref
        - `not_eq` RecurringEndsOn — unresolved $ref
        - `eq` RecurringEndsOn — unresolved $ref
        - `not_contain` RecurringEndsOn — unresolved $ref
    - `invoiced_rate` union — Filter by invoiced rate (invoiced amount per hour) range.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` InvoicedRate — unresolved $ref
        - `eq` InvoicedRate — unresolved $ref
        - `contains` InvoicedRate — unresolved $ref
        - `not_eq` InvoicedRate — unresolved $ref
      - InvoicedRate — unresolved $ref
    - `needs_invoicing` union — Filter to include deals that are closed but have uninvoiced revenue.
      - NeedsInvoicing — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` NeedsInvoicing — unresolved $ref
        - `eq` NeedsInvoicing — unresolved $ref
        - `contains` NeedsInvoicing — unresolved $ref
        - `not_contain` NeedsInvoicing — unresolved $ref
    - `probability` union — Filter by win probability percentage range.
      - Probability — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_eq` Probability — unresolved $ref
        - `contains` Probability — unresolved $ref
        - `not_contain` Probability — unresolved $ref
        - `eq` Probability — unresolved $ref
    - `project_type` union — Filter by project type.
      - ProjectType — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` ProjectType — unresolved $ref
        - `eq` ProjectType — unresolved $ref
        - `not_eq` ProjectType — unresolved $ref
        - `contains` ProjectType — unresolved $ref
    - `retainer_interval` union — Filter by the deal retainer billing interval (week, two_weeks, month, quarter, half_year, or year).
      - RetainerInterval — unresolved $ref
      - object — Object form with operator key (eq, not_eq, contains, not_contain).
        - `not_contain` RetainerInterval — unresolved $ref
        - `contains` RetainerInterval — unresolved $ref
        - `not_eq` RetainerInterval — unresolved $ref
        - `eq` RetainerInterval — unresolved $ref
    - `recurring_starts_on` union — Filter by recurring contract start date range.
      - RecurringStartsOn — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` RecurringStartsOn — unresolved $ref
        - `not_contain` RecurringStartsOn — unresolved $ref
        - `not_eq` RecurringStartsOn — unresolved $ref
        - `eq` RecurringStartsOn — unresolved $ref
    - `tracking_type_id` union — Filter by tracking type.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `eq` TrackingTypeId — unresolved $ref
        - `contains` TrackingTypeId — unresolved $ref
        - `not_contain` TrackingTypeId — unresolved $ref
        - `not_eq` TrackingTypeId — unresolved $ref
      - TrackingTypeId — unresolved $ref
    - `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).
        - `eq` DesignatedApproverId — unresolved $ref
        - `contains` DesignatedApproverId — unresolved $ref
        - `not_eq` DesignatedApproverId — unresolved $ref
        - `not_contain` DesignatedApproverId — unresolved $ref
    - `actual_rate` union — Filter by actual hourly rate (revenue per hour worked).
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` ActualRate — unresolved $ref
        - `contains` ActualRate — unresolved $ref
        - `eq` ActualRate — unresolved $ref
        - `not_eq` ActualRate — unresolved $ref
      - ActualRate — unresolved $ref
    - `sales_closed_on` union — Filter by win/loss date.
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` SalesClosedOn — unresolved $ref
        - `eq` SalesClosedOn — unresolved $ref
        - `contains` SalesClosedOn — unresolved $ref
        - `not_eq` SalesClosedOn — unresolved $ref
      - SalesClosedOn — unresolved $ref
    - `services_revenue` union — Filter by services revenue amount range.
      - ServicesRevenue — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `contains` ServicesRevenue — unresolved $ref
        - `not_contain` ServicesRevenue — unresolved $ref
        - `eq` ServicesRevenue — unresolved $ref
        - `not_eq` ServicesRevenue — unresolved $ref
    - `forecasted_profit` union — Filter by forecasted profit amount range.
      - ForecastedProfit — unresolved $ref
      - object — Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`.
        - `not_contain` ForecastedProfit — unresolved $ref
- … truncated; see the full OpenAPI document linked below

## Headers

- `X-Organization-Id` string, required

## Response `200`

Collection deal

---

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