Search and filter deals with pagination and sorting using the deals_list_query RPC.
Filters: keywords (name + company search), deal_status_ids_included/excluded (current status), deal_status_reached (statuses the deal has entered, with optional start_date and end_date as inclusive UTC days), owner_ids_included/excluded, show_open_deals_only, show_archived, closed_date_filter, open_date_filter, and custom attribute filters (select_attribute_filters, numeric_attribute_filters, date_attribute_filters, team_member_attribute_filters, company_attribute_filters).
Sorting: name, amount, win_probability, company, status, closed_date, open_date, last_contacted_at, created_at, or custom_<attribute_id> for custom attribute sorting.
Include: Pass ["custom_fields"], ["client_contacts"], and/or ["deal_status_changes"] to embed those sections. client_contacts and deal_status_changes are omitted unless explicitly requested. deal_status_changes is the recorded status history, oldest first.
For API-key callers, compensation and compensation_currency_code require compensation:read; inaccessible fields are omitted. Deal amount and pricing_rate are available with deals:read. next_task, open_task_count and needs_attention also require tasks:read.
Authenticate with a Bearer token: API key, OAuth token, or session token.
Body
application/json
offset
integer
default:0
Records to skip for pagination. Defaults to 0.
Required range: x >= 0
limit
integer
default:100
Max records to return (1–100). Defaults to 100.
Required range: 1 <= x <= 100
sort_by
string
Column to sort by. Accepted values:
name — deal name (alphabetical)
amount — deal monetary amount
win_probability — win probability percentage
company — client company name (alphabetical)
status — deal status (by stage order)
closed_date — expected or actual close date
open_date — deal open date
last_contacted_at — most recent engagement with client contacts
created_at — creation timestamp (default)
custom_<attribute_id> — any custom attribute UUID prefixed with custom_ (e.g. custom_e5f6a7b8-...). Sorts by the attribute's decimal, date, string, or tag value.
sort_order
enum<string>
default:desc
Sort direction. Defaults to desc (newest first).
Available options:
asc,
desc
keywords
string[]
Full-text search across deal name, client company name, and domain. Multiple keywords use OR logic.
deal_ids
string<uuid>[]
Pre-filter to a specific set of deal UUIDs.
list_id
string<uuid>
Filter to deals belonging to this list.
deal_status_ids_included
string<uuid>[]
Include only deals with these status UUIDs.
deal_status_ids_excluded
string<uuid>[]
Exclude deals with these status UUIDs.
owner_ids_included
string<uuid>[]
Include only deals owned by these team members. Get IDs from GET /v1/team-members.
owner_ids_excluded
string<uuid>[]
Exclude deals owned by these team members.
show_open_deals_only
boolean
When true, only return deals with an "active" status type.
show_archived
boolean
When true, return archived (soft-deleted) deals instead of active ones.
closed_date_filter
object
Filter by closed_date range. Supports start_date, end_date, and include_empty.
Show child attributes
open_date_filter
object
Filter by open_date range. Supports start_date, end_date, and include_empty.
Show child attributes
deal_status_reached
object
Keep deals that entered a status in this window. A deal matches when one recorded status change satisfies every bound that is set. Dates are the UTC calendar day of entered_at. This is independent of deal_status_ids_included, which matches the current status only.
Show child attributes
select_attribute_filters
object[]
Filter by select/multi-select custom fields. Get attribute_id and tag IDs from GET /v1/custom-fields/deals.
Show child attributes
numeric_attribute_filters
object[]
Filter by numeric custom fields (min/max range). Get attribute_id from GET /v1/custom-fields/deals.
Show child attributes
date_attribute_filters
object[]
Filter by date custom fields (date range). Get attribute_id from GET /v1/custom-fields/deals.
Show child attributes
team_member_attribute_filters
object[]
Filter by team-member custom fields. Get attribute_id from GET /v1/custom-fields/deals.
Show child attributes
company_attribute_filters
object[]
Filter by multi-company custom fields. Get attribute_id from GET /v1/custom-fields/deals.
Show child attributes
include
enum<string>[]
Extra sections to embed. Values: custom_fields, client_contacts, deal_status_changes. Omit for base fields only. client_contacts and deal_status_changes are absent unless explicitly requested. deal_status_changes is the recorded status history, oldest first.
Available options:
custom_fields,
client_contacts,
deal_status_changes
Response
Successful search response
success
enum<boolean>
required
Available options:
true
data
object[]
required
Show child attributes
meta
object
required
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Stardex Help Docs","description":"AI native ATS \u0026 CRM for search firms","colors":{"primary":"#5853f7","light":"#5853f7","dark":"#EDF3F9"},"logo":{"light":"https://mintcdn.com/stardex/Unebva7RlCeyAgPy/logo/light.svg?fit=max\u0026auto=format\u0026n=Unebva7RlCeyAgPy\u0026q=85\u0026s=6a32bc87265a1562f0ee3793cb4c66e7","dark":"https://mintcdn.com/stardex/Unebva7RlCeyAgPy/logo/dark.svg?fit=max\u0026auto=format\u0026n=Unebva7RlCeyAgPy\u0026q=85\u0026s=000def45485b23628fc81f156a6306cd"},"favicon":"https://mintcdn.com/stardex/Unebva7RlCeyAgPy/favicon.svg?fit=max\u0026auto=format\u0026n=Unebva7RlCeyAgPy\u0026q=85\u0026s=dbebacabd3552482bc8b3f787e61888d","api":{"mdx":{"auth":{"method":"bearer","name":"Authorization"},"server":"https://api.stardex.ai"}},"navbar":{"links":[{"href":"mailto:support@stardex.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://stardex.com/jobs"}},"footer":{"socials":{"x":"https://x.com/stardexhq","linkedin":"https://linkedin.com/company/stardexhq"}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Home page","icon":"book-open-cover","href":"https://www.stardex.com"},{"anchor":"Blog","icon":"newspaper","href":"https://www.stardex.com/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"stardex","hasAudioNarration":false,"actualSubdomain":"stardex","customDomains":["docs.stardex.com"],"gitSource":{"type":"github","owner":"dotshq","repo":"ats-plus","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{},"buildId":"6b007fae1e592fb6624fa15a","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":191},{"language":"default","tag":"Help Center","count":84},{"language":"default","tag":"Core Features","count":33},{"language":"default","tag":"Settings \u0026 Customization","count":27},{"language":"default","tag":"Campaigns","count":24},{"language":"default","tag":"Persons","count":23},{"language":"default","tag":"Jobs","count":21},{"language":"default","tag":"Integrations","count":16},{"language":"default","tag":"Retainer Packs","count":12},{"language":"default","tag":"Email \u0026 other integrations","count":10}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/deals/search-deals","slug":"/api-reference/deals/search-deals","pageMetadata":{"title":"Search deals","description":"Search and filter deals with pagination and sorting using the deals_list_query RPC.\n\n**Filters**: `keywords` (name + company search), `deal_status_ids_included`/`excluded` (current status), `deal_status_reached` (statuses the deal has entered, with optional `start_date` and `end_date` as inclusive UTC days), `owner_ids_included`/`excluded`, `show_open_deals_only`, `show_archived`, `closed_date_filter`, `open_date_filter`, and custom attribute filters (`select_attribute_filters`, `numeric_attribute_filters`, `date_attribute_filters`, `team_member_attribute_filters`, `company_attribute_filters`).\n\n**Sorting**: `name`, `amount`, `win_probability`, `company`, `status`, `closed_date`, `open_date`, `last_contacted_at`, `created_at`, or `custom_\u003cattribute_id>` for custom attribute sorting.\n\n**Include**: Pass `[\"custom_fields\"]`, `[\"client_contacts\"]`, and/or `[\"deal_status_changes\"]` to embed those sections. `client_contacts` and `deal_status_changes` are omitted unless explicitly requested. `deal_status_changes` is the recorded status history, oldest first.\n\nFor API-key callers, `compensation` and `compensation_currency_code` require `compensation:read`; inaccessible fields are omitted. Deal `amount` and `pricing_rate` are available with `deals:read`. `next_task`, `open_task_count` and `needs_attention` also require `tasks:read`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/deals/search","href":"/api-reference/deals/search-deals","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Search and filter deals with pagination and sorting using the deals_list_query RPC.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Filters\"\n }), \": \", _jsx(_components.code, {\n children: \"keywords\"\n }), \" (name + company search), \", _jsx(_components.code, {\n children: \"deal_status_ids_included\"\n }), \"/\", _jsx(_components.code, {\n children: \"excluded\"\n }), \" (current status), \", _jsx(_components.code, {\n children: \"deal_status_reached\"\n }), \" (statuses the deal has entered, with optional \", _jsx(_components.code, {\n children: \"start_date\"\n }), \" and \", _jsx(_components.code, {\n children: \"end_date\"\n }), \" as inclusive UTC days), \", _jsx(_components.code, {\n children: \"owner_ids_included\"\n }), \"/\", _jsx(_components.code, {\n children: \"excluded\"\n }), \", \", _jsx(_components.code, {\n children: \"show_open_deals_only\"\n }), \", \", _jsx(_components.code, {\n children: \"show_archived\"\n }), \", \", _jsx(_components.code, {\n children: \"closed_date_filter\"\n }), \", \", _jsx(_components.code, {\n children: \"open_date_filter\"\n }), \", and custom attribute filters (\", _jsx(_components.code, {\n children: \"select_attribute_filters\"\n }), \", \", _jsx(_components.code, {\n children: \"numeric_attribute_filters\"\n }), \", \", _jsx(_components.code, {\n children: \"date_attribute_filters\"\n }), \", \", _jsx(_components.code, {\n children: \"team_member_attribute_filters\"\n }), \", \", _jsx(_components.code, {\n children: \"company_attribute_filters\"\n }), \").\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Sorting\"\n }), \": \", _jsx(_components.code, {\n children: \"name\"\n }), \", \", _jsx(_components.code, {\n children: \"amount\"\n }), \", \", _jsx(_components.code, {\n children: \"win_probability\"\n }), \", \", _jsx(_components.code, {\n children: \"company\"\n }), \", \", _jsx(_components.code, {\n children: \"status\"\n }), \", \", _jsx(_components.code, {\n children: \"closed_date\"\n }), \", \", _jsx(_components.code, {\n children: \"open_date\"\n }), \", \", _jsx(_components.code, {\n children: \"last_contacted_at\"\n }), \", \", _jsx(_components.code, {\n children: \"created_at\"\n }), \", or \", _jsx(_components.code, {\n children: \"custom_\u003cattribute_id>\"\n }), \" for custom attribute sorting.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Include\"\n }), \": Pass \", _jsx(_components.code, {\n children: \"[\\\"custom_fields\\\"]\"\n }), \", \", _jsx(_components.code, {\n children: \"[\\\"client_contacts\\\"]\"\n }), \", and/or \", _jsx(_components.code, {\n children: \"[\\\"deal_status_changes\\\"]\"\n }), \" to embed those sections. \", _jsx(_components.code, {\n children: \"client_contacts\"\n }), \" and \", _jsx(_components.code, {\n children: \"deal_status_changes\"\n }), \" are omitted unless explicitly requested. \", _jsx(_components.code, {\n children: \"deal_status_changes\"\n }), \" is the recorded status history, oldest first.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"For API-key callers, \", _jsx(_components.code, {\n children: \"compensation\"\n }), \" and \", _jsx(_components.code, {\n children: \"compensation_currency_code\"\n }), \" require \", _jsx(_components.code, {\n children: \"compensation:read\"\n }), \"; inaccessible fields are omitted. Deal \", _jsx(_components.code, {\n children: \"amount\"\n }), \" and \", _jsx(_components.code, {\n children: \"pricing_rate\"\n }), \" are available with \", _jsx(_components.code, {\n children: \"deals:read\"\n }), \". \", _jsx(_components.code, {\n children: \"next_task\"\n }), \", \", _jsx(_components.code, {\n children: \"open_task_count\"\n }), \" and \", _jsx(_components.code, {\n children: \"needs_attention\"\n }), \" also require \", _jsx(_components.code, {\n children: \"tasks:read\"\n }), \".\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Search deals","description":"Search and filter deals with pagination and sorting using the deals_list_query RPC.\n\n**Filters**: `keywords` (name + company search), `deal_status_ids_included`/`excluded` (current status), `deal_status_reached` (statuses the deal has entered, with optional `start_date` and `end_date` as inclusive UTC days), `owner_ids_included`/`excluded`, `show_open_deals_only`, `show_archived`, `closed_date_filter`, `open_date_filter`, and custom attribute filters (`select_attribute_filters`, `numeric_attribute_filters`, `date_attribute_filters`, `team_member_attribute_filters`, `company_attribute_filters`).\n\n**Sorting**: `name`, `amount`, `win_probability`, `company`, `status`, `closed_date`, `open_date`, `last_contacted_at`, `created_at`, or `custom_\u003cattribute_id>` for custom attribute sorting.\n\n**Include**: Pass `[\"custom_fields\"]`, `[\"client_contacts\"]`, and/or `[\"deal_status_changes\"]` to embed those sections. `client_contacts` and `deal_status_changes` are omitted unless explicitly requested. `deal_status_changes` is the recorded status history, oldest first.\n\nFor API-key callers, `compensation` and `compensation_currency_code` require `compensation:read`; inaccessible fields are omitted. Deal `amount` and `pricing_rate` are available with `deals:read`. `next_task`, `open_task_count` and `needs_attention` also require `tasks:read`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/deals/search","href":"/api-reference/deals/search-deals","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"searchDeals","summary":"Search deals","description":"Search and filter deals with pagination and sorting using the deals_list_query RPC.\n\n**Filters**: `keywords` (name + company search), `deal_status_ids_included`/`excluded` (current status), `deal_status_reached` (statuses the deal has entered, with optional `start_date` and `end_date` as inclusive UTC days), `owner_ids_included`/`excluded`, `show_open_deals_only`, `show_archived`, `closed_date_filter`, `open_date_filter`, and custom attribute filters (`select_attribute_filters`, `numeric_attribute_filters`, `date_attribute_filters`, `team_member_attribute_filters`, `company_attribute_filters`).\n\n**Sorting**: `name`, `amount`, `win_probability`, `company`, `status`, `closed_date`, `open_date`, `last_contacted_at`, `created_at`, or `custom_\u003cattribute_id>` for custom attribute sorting.\n\n**Include**: Pass `[\"custom_fields\"]`, `[\"client_contacts\"]`, and/or `[\"deal_status_changes\"]` to embed those sections. `client_contacts` and `deal_status_changes` are omitted unless explicitly requested. `deal_status_changes` is the recorded status history, oldest first.\n\nFor API-key callers, `compensation` and `compensation_currency_code` require `compensation:read`; inaccessible fields are omitted. Deal `amount` and `pricing_rate` are available with `deals:read`. `next_task`, `open_task_count` and `needs_attention` also require `tasks:read`.","tags":["Deals"],"requestBody":"7c6ac66b-4d15-4445-9d9f-40dd52bed503","responses":{"200":"1c6e0524-45ef-4cfb-85a9-d42038484ff7","400":"524b4feb-413f-4401-b42b-29c9b8408a6c","403":"eaefcf9e-f5df-4c3f-9616-16da26b41f4b","404":"4ccd7450-41b8-441e-a4c5-f6fd9ad9277c","500":"e35ed348-82bf-4245-afcf-65c994972d09"},"method":"post","type":"path","servers":["d7538d15-a885-40aa-a5a5-e912a47fa5aa"],"security":["ec123555-6fb6-48ad-bf3e-ba9c2f616d21"],"path":"/v1/deals/search","baseUrlOptions":["https://api.stardex.ai"],"title":"Search deals","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"offset":{"type":"integer","minimum":0,"default":0,"description":"Records to skip for pagination. Defaults to 0.","uniqueKey":"offset","typeLabel":"integer"},"limit":{"type":"integer","minimum":1,"maximum":100,"default":100,"description":"Max records to return (1–100). Defaults to 100.","uniqueKey":"limit","typeLabel":"integer"},"sort_by":{"type":"string","description":"Column to sort by. Accepted values:\n- `name` — deal name (alphabetical)\n- `amount` — deal monetary amount\n- `win_probability` — win probability percentage\n- `company` — client company name (alphabetical)\n- `status` — deal status (by stage order)\n- `closed_date` — expected or actual close date\n- `open_date` — deal open date\n- `last_contacted_at` — most recent engagement with client contacts\n- `created_at` — creation timestamp (default)\n- `custom_\u003cattribute_id>` — any custom attribute UUID prefixed with `custom_` (e.g. `custom_e5f6a7b8-...`). Sorts by the attribute's decimal, date, string, or tag value.","uniqueKey":"sort_by","typeLabel":"string"},"sort_order":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort direction. Defaults to desc (newest first).","uniqueKey":"sort_order","typeLabel":"enum\u003cstring>"},"keywords":{"type":"array","items":{"type":"string","uniqueKey":"keywords.items.[INDEX]","typeLabel":"string"},"description":"Full-text search across deal name, client company name, and domain. Multiple keywords use OR logic.","uniqueKey":"keywords","typeLabel":"string[]"},"deal_ids":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"deal_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Pre-filter to a specific set of deal UUIDs.","uniqueKey":"deal_ids","typeLabel":"string\u003cuuid>[]"},"list_id":{"type":"string","format":"uuid","description":"Filter to deals belonging to this list.","uniqueKey":"list_id","typeLabel":"string\u003cuuid>"},"deal_status_ids_included":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"deal_status_ids_included.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Include only deals with these status UUIDs.","uniqueKey":"deal_status_ids_included","typeLabel":"string\u003cuuid>[]"},"deal_status_ids_excluded":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"deal_status_ids_excluded.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Exclude deals with these status UUIDs.","uniqueKey":"deal_status_ids_excluded","typeLabel":"string\u003cuuid>[]"},"owner_ids_included":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"owner_ids_included.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Include only deals owned by these team members. Get IDs from GET /v1/team-members.","uniqueKey":"owner_ids_included","typeLabel":"string\u003cuuid>[]"},"owner_ids_excluded":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"owner_ids_excluded.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Exclude deals owned by these team members.","uniqueKey":"owner_ids_excluded","typeLabel":"string\u003cuuid>[]"},"show_open_deals_only":{"type":"boolean","description":"When true, only return deals with an \"active\" status type.","uniqueKey":"show_open_deals_only","typeLabel":"boolean"},"show_archived":{"type":"boolean","description":"When true, return archived (soft-deleted) deals instead of active ones.","uniqueKey":"show_archived","typeLabel":"boolean"},"closed_date_filter":{"type":"object","properties":{"start_date":{"oneOf":[{"type":"string","description":"Start of date range (ISO 8601). Null for no lower bound.","uniqueKey":"closed_date_filter.start_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"Start of date range (ISO 8601). Null for no lower bound.","uniqueKey":"closed_date_filter.start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"closed_date_filter.start_date","typeLabel":"string | null"},"end_date":{"oneOf":[{"type":"string","description":"End of date range (ISO 8601). Null for no upper bound.","uniqueKey":"closed_date_filter.end_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"End of date range (ISO 8601). Null for no upper bound.","uniqueKey":"closed_date_filter.end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"closed_date_filter.end_date","typeLabel":"string | null"},"include_empty":{"type":"boolean","default":false,"description":"When true, also include deals with no value set for this date field.","uniqueKey":"closed_date_filter.include_empty","typeLabel":"boolean"}},"description":"Filter by closed_date range. Supports start_date, end_date, and include_empty.","uniqueKey":"closed_date_filter","typeLabel":"object"},"open_date_filter":{"type":"object","properties":{"start_date":{"oneOf":[{"type":"string","description":"Start of date range (ISO 8601). Null for no lower bound.","uniqueKey":"open_date_filter.start_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"Start of date range (ISO 8601). Null for no lower bound.","uniqueKey":"open_date_filter.start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"open_date_filter.start_date","typeLabel":"string | null"},"end_date":{"oneOf":[{"type":"string","description":"End of date range (ISO 8601). Null for no upper bound.","uniqueKey":"open_date_filter.end_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"End of date range (ISO 8601). Null for no upper bound.","uniqueKey":"open_date_filter.end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"open_date_filter.end_date","typeLabel":"string | null"},"include_empty":{"type":"boolean","default":false,"description":"When true, also include deals with no value set for this date field.","uniqueKey":"open_date_filter.include_empty","typeLabel":"boolean"}},"description":"Filter by open_date range. Supports start_date, end_date, and include_empty.","uniqueKey":"open_date_filter","typeLabel":"object"},"deal_status_reached":{"type":"object","properties":{"deal_status_ids":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"deal_status_reached.deal_status_ids.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Statuses the deal has entered, including its current status. Get IDs from GET /v1/deals/statuses. Omit or pass an empty array to match any status.","uniqueKey":"deal_status_reached.deal_status_ids","typeLabel":"string\u003cuuid>[]"},"start_date":{"oneOf":[{"type":"string","format":"date","description":"Earliest UTC date the deal entered the status (YYYY-MM-DD), inclusive. Null or omitted for no lower bound.","uniqueKey":"deal_status_reached.start_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"Earliest UTC date the deal entered the status (YYYY-MM-DD), inclusive. Null or omitted for no lower bound.","uniqueKey":"deal_status_reached.start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"deal_status_reached.start_date","typeLabel":"string\u003cdate> | null"},"end_date":{"oneOf":[{"type":"string","format":"date","description":"Latest UTC date the deal entered the status (YYYY-MM-DD), inclusive. Null or omitted for no upper bound.","uniqueKey":"deal_status_reached.end_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"Latest UTC date the deal entered the status (YYYY-MM-DD), inclusive. Null or omitted for no upper bound.","uniqueKey":"deal_status_reached.end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"deal_status_reached.end_date","typeLabel":"string\u003cdate> | null"}},"description":"Keep deals that entered a status in this window. A deal matches when one recorded status change satisfies every bound that is set. Dates are the UTC calendar day of entered_at. This is independent of deal_status_ids_included, which matches the current status only.","uniqueKey":"deal_status_reached","typeLabel":"object"},"select_attribute_filters":{"type":"array","items":{"type":"object","properties":{"attribute_id":{"type":"string","format":"uuid","description":"Attribute definition UUID. Get from GET /v1/custom-fields/{entity}.","isRequired":true,"uniqueKey":"select_attribute_filters.items.[INDEX].attribute_id","typeLabel":"string\u003cuuid>"},"values":{"type":"array","items":{"type":"string","uniqueKey":"select_attribute_filters.items.[INDEX].values.items.[INDEX]","typeLabel":"string"},"default":[],"description":"Tag option UUIDs to include. Get tag IDs from the attribute's tags array in custom field definitions.","uniqueKey":"select_attribute_filters.items.[INDEX].values","typeLabel":"string[]"},"excluded_values":{"type":"array","items":{"type":"string","uniqueKey":"select_attribute_filters.items.[INDEX].excluded_values.items.[INDEX]","typeLabel":"string"},"default":[],"description":"Tag option UUIDs to exclude.","uniqueKey":"select_attribute_filters.items.[INDEX].excluded_values","typeLabel":"string[]"},"require_all":{"type":"boolean","default":false,"description":"When true, record must have ALL specified tags (AND logic). When false, any tag matches (OR logic).","uniqueKey":"select_attribute_filters.items.[INDEX].require_all","typeLabel":"boolean"},"include_empty":{"type":"boolean","default":false,"description":"When true, also include records with no value set for this attribute.","uniqueKey":"select_attribute_filters.items.[INDEX].include_empty","typeLabel":"boolean"}},"required":["attribute_id"],"uniqueKey":"select_attribute_filters.items.[INDEX]","typeLabel":"object"},"description":"Filter by select/multi-select custom fields. Get attribute_id and tag IDs from GET /v1/custom-fields/deals.","uniqueKey":"select_attribute_filters","typeLabel":"object[]"},"numeric_attribute_filters":{"type":"array","items":{"type":"object","properties":{"attribute_id":{"type":"string","format":"uuid","description":"Attribute definition UUID (integer or decimal type). Get from GET /v1/custom-fields/{entity}.","isRequired":true,"uniqueKey":"numeric_attribute_filters.items.[INDEX].attribute_id","typeLabel":"string\u003cuuid>"},"min":{"oneOf":[{"type":"number","description":"Minimum value (inclusive). Null for no lower bound.","uniqueKey":"numeric_attribute_filters.items.[INDEX].min.oneOf.0","typeLabel":"number"},{"type":"null","description":"Minimum value (inclusive). Null for no lower bound.","uniqueKey":"numeric_attribute_filters.items.[INDEX].min.oneOf.1","typeLabel":"null"}],"uniqueKey":"numeric_attribute_filters.items.[INDEX].min","typeLabel":"number | null"},"max":{"oneOf":[{"type":"number","description":"Maximum value (inclusive). Null for no upper bound.","uniqueKey":"numeric_attribute_filters.items.[INDEX].max.oneOf.0","typeLabel":"number"},{"type":"null","description":"Maximum value (inclusive). Null for no upper bound.","uniqueKey":"numeric_attribute_filters.items.[INDEX].max.oneOf.1","typeLabel":"null"}],"uniqueKey":"numeric_attribute_filters.items.[INDEX].max","typeLabel":"number | null"},"include_empty":{"type":"boolean","default":false,"description":"When true, also include records with no value set.","uniqueKey":"numeric_attribute_filters.items.[INDEX].include_empty","typeLabel":"boolean"}},"required":["attribute_id"],"uniqueKey":"numeric_attribute_filters.items.[INDEX]","typeLabel":"object"},"description":"Filter by numeric custom fields (min/max range). Get attribute_id from GET /v1/custom-fields/deals.","uniqueKey":"numeric_attribute_filters","typeLabel":"object[]"},"date_attribute_filters":{"type":"array","items":{"type":"object","properties":{"attribute_id":{"type":"string","format":"uuid","description":"Attribute definition UUID (date type). Get from GET /v1/custom-fields/{entity}.","isRequired":true,"uniqueKey":"date_attribute_filters.items.[INDEX].attribute_id","typeLabel":"string\u003cuuid>"},"start_date":{"oneOf":[{"type":"string","description":"Start of date range (ISO 8601). Null for no lower bound.","uniqueKey":"date_attribute_filters.items.[INDEX].start_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"Start of date range (ISO 8601). Null for no lower bound.","uniqueKey":"date_attribute_filters.items.[INDEX].start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"date_attribute_filters.items.[INDEX].start_date","typeLabel":"string | null"},"end_date":{"oneOf":[{"type":"string","description":"End of date range (ISO 8601). Null for no upper bound.","uniqueKey":"date_attribute_filters.items.[INDEX].end_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"End of date range (ISO 8601). Null for no upper bound.","uniqueKey":"date_attribute_filters.items.[INDEX].end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"date_attribute_filters.items.[INDEX].end_date","typeLabel":"string | null"},"include_empty":{"type":"boolean","default":false,"description":"When true, also include records with no value set.","uniqueKey":"date_attribute_filters.items.[INDEX].include_empty","typeLabel":"boolean"}},"required":["attribute_id"],"uniqueKey":"date_attribute_filters.items.[INDEX]","typeLabel":"object"},"description":"Filter by date custom fields (date range). Get attribute_id from GET /v1/custom-fields/deals.","uniqueKey":"date_attribute_filters","typeLabel":"object[]"},"team_member_attribute_filters":{"type":"array","items":{"type":"object","properties":{"attribute_id":{"type":"string","format":"uuid","description":"Attribute definition UUID (multi-team-member type). Get from GET /v1/custom-fields/{entity}.","isRequired":true,"uniqueKey":"team_member_attribute_filters.items.[INDEX].attribute_id","typeLabel":"string\u003cuuid>"},"values":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"team_member_attribute_filters.items.[INDEX].values.items.[INDEX]","typeLabel":"string\u003cuuid>"},"default":[],"description":"Team member UUIDs to include. Get IDs from GET /v1/team-members.","uniqueKey":"team_member_attribute_filters.items.[INDEX].values","typeLabel":"string\u003cuuid>[]"},"excluded_values":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"team_member_attribute_filters.items.[INDEX].excluded_values.items.[INDEX]","typeLabel":"string\u003cuuid>"},"default":[],"description":"Team member UUIDs to exclude.","uniqueKey":"team_member_attribute_filters.items.[INDEX].excluded_values","typeLabel":"string\u003cuuid>[]"},"require_all":{"type":"boolean","default":false,"description":"When true, record must have ALL specified team members (AND logic).","uniqueKey":"team_member_attribute_filters.items.[INDEX].require_all","typeLabel":"boolean"},"include_empty":{"type":"boolean","default":false,"description":"When true, also include records with no team member assigned for this attribute.","uniqueKey":"team_member_attribute_filters.items.[INDEX].include_empty","typeLabel":"boolean"}},"required":["attribute_id"],"uniqueKey":"team_member_attribute_filters.items.[INDEX]","typeLabel":"object"},"description":"Filter by team-member custom fields. Get attribute_id from GET /v1/custom-fields/deals.","uniqueKey":"team_member_attribute_filters","typeLabel":"object[]"},"company_attribute_filters":{"type":"array","items":{"type":"object","properties":{"attribute_id":{"type":"string","format":"uuid","description":"Attribute definition UUID (multi-company type). Get from GET /v1/custom-fields/{entity}.","isRequired":true,"uniqueKey":"company_attribute_filters.items.[INDEX].attribute_id","typeLabel":"string\u003cuuid>"},"values":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"company_attribute_filters.items.[INDEX].values.items.[INDEX]","typeLabel":"string\u003cuuid>"},"default":[],"description":"Company UUIDs to include. Get IDs from GET /v1/companies/search or search-companies.","uniqueKey":"company_attribute_filters.items.[INDEX].values","typeLabel":"string\u003cuuid>[]"},"excluded_values":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"company_attribute_filters.items.[INDEX].excluded_values.items.[INDEX]","typeLabel":"string\u003cuuid>"},"default":[],"description":"Company UUIDs to exclude.","uniqueKey":"company_attribute_filters.items.[INDEX].excluded_values","typeLabel":"string\u003cuuid>[]"},"require_all":{"type":"boolean","default":false,"description":"When true, record must have ALL specified companies (AND logic).","uniqueKey":"company_attribute_filters.items.[INDEX].require_all","typeLabel":"boolean"},"include_empty":{"type":"boolean","default":false,"description":"When true, also include records with no company assigned for this attribute.","uniqueKey":"company_attribute_filters.items.[INDEX].include_empty","typeLabel":"boolean"}},"required":["attribute_id"],"uniqueKey":"company_attribute_filters.items.[INDEX]","typeLabel":"object"},"description":"Filter by multi-company custom fields. Get attribute_id from GET /v1/custom-fields/deals.","uniqueKey":"company_attribute_filters","typeLabel":"object[]"},"include":{"type":"array","items":{"type":"string","enum":["custom_fields","client_contacts","deal_status_changes"],"uniqueKey":"include.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Extra sections to embed. Values: custom_fields, client_contacts, deal_status_changes. Omit for base fields only. client_contacts and deal_status_changes are absent unless explicitly requested. deal_status_changes is the recorded status history, oldest first.","uniqueKey":"include","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"offset":0,"limit":100,"sort_by":"\u003cstring>","sort_order":"desc","keywords":["\u003cstring>"],"deal_ids":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"list_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","deal_status_ids_included":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"deal_status_ids_excluded":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"owner_ids_included":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"owner_ids_excluded":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"show_open_deals_only":true,"show_archived":true,"closed_date_filter":{"start_date":"\u003cstring>","end_date":"\u003cstring>","include_empty":false},"open_date_filter":{"start_date":"\u003cstring>","end_date":"\u003cstring>","include_empty":false},"deal_status_reached":{"deal_status_ids":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"start_date":"2023-12-25","end_date":"2023-12-25"},"select_attribute_filters":[{"attribute_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","values":[],"excluded_values":[],"require_all":false,"include_empty":false}],"numeric_attribute_filters":[{"attribute_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","min":123,"max":123,"include_empty":false}],"date_attribute_filters":[{"attribute_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","start_date":"\u003cstring>","end_date":"\u003cstring>","include_empty":false}],"team_member_attribute_filters":[{"attribute_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","values":[],"excluded_values":[],"require_all":false,"include_empty":false}],"company_attribute_filters":[{"attribute_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","values":[],"excluded_values":[],"require_all":false,"include_empty":false}],"include":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"1c6e0524-45ef-4cfb-85a9-d42038484ff7":{"description":"Successful search response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique deal UUID.","isRequired":true,"uniqueKey":"data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Deal name.","isRequired":true,"uniqueKey":"data.items.[INDEX].name","typeLabel":"string"},"amount":{"oneOf":[{"type":"number","description":"Deal monetary amount — the fee the firm invoices the client.","isRequired":true,"uniqueKey":"data.items.[INDEX].amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Deal monetary amount — the fee the firm invoices the client.","isRequired":true,"uniqueKey":"data.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].amount","typeLabel":"number | null"},"currency_code":{"type":"string","description":"ISO 4217 currency code for the deal amount (e.g. USD, EUR, GBP). Defaults to the organization setting or USD.","isRequired":true,"uniqueKey":"data.items.[INDEX].currency_code","typeLabel":"string"},"pricing_rate":{"oneOf":[{"type":"number","description":"Recruitment fee percentage (0–100) charged to the client on a successful placement.","isRequired":true,"uniqueKey":"data.items.[INDEX].pricing_rate.oneOf.0","typeLabel":"number"},{"type":"null","description":"Recruitment fee percentage (0–100) charged to the client on a successful placement.","isRequired":true,"uniqueKey":"data.items.[INDEX].pricing_rate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].pricing_rate","typeLabel":"number | null"},"win_probability":{"oneOf":[{"type":"number","description":"Probability of winning the deal (0–100).","isRequired":true,"uniqueKey":"data.items.[INDEX].win_probability.oneOf.0","typeLabel":"number"},{"type":"null","description":"Probability of winning the deal (0–100).","isRequired":true,"uniqueKey":"data.items.[INDEX].win_probability.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].win_probability","typeLabel":"number | null"},"closed_date":{"oneOf":[{"type":"string","description":"ISO 8601 expected or actual close date.","isRequired":true,"uniqueKey":"data.items.[INDEX].closed_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 8601 expected or actual close date.","isRequired":true,"uniqueKey":"data.items.[INDEX].closed_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].closed_date","typeLabel":"string | null"},"open_date":{"type":"string","format":"date","description":"Date the deal was opened (YYYY-MM-DD).","isRequired":true,"uniqueKey":"data.items.[INDEX].open_date","typeLabel":"string\u003cdate>"},"last_contacted_at":{"oneOf":[{"type":"string","description":"ISO 8601 timestamp of last contact with deal client contacts.","isRequired":true,"uniqueKey":"data.items.[INDEX].last_contacted_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 8601 timestamp of last contact with deal client contacts.","isRequired":true,"uniqueKey":"data.items.[INDEX].last_contacted_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].last_contacted_at","typeLabel":"string | null"},"deal_status":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Deal status UUID. Use for deal_status_ids_included/excluded filters.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Human-readable status name (e.g. \"Proposal Sent\", \"Closed Won\").","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status.oneOf.0.name","typeLabel":"string"}},"required":["id","name"],"description":"Current deal status with id and name. Null if no status assigned.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string","format":"uuid","description":"Deal status UUID. Use for deal_status_ids_included/excluded filters."},"name":{"type":"string","description":"Human-readable status name (e.g. \"Proposal Sent\", \"Closed Won\")."}},"required":["id","name"],"description":"Current deal status with id and name. Null if no status assigned.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status","typeLabel":"object | null"},"created_at":{"oneOf":[{"type":"string","description":"ISO 8601 creation timestamp.","isRequired":true,"uniqueKey":"data.items.[INDEX].created_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 8601 creation timestamp.","isRequired":true,"uniqueKey":"data.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].created_at","typeLabel":"string | null"},"client_name":{"oneOf":[{"type":"string","description":"Client company name.","isRequired":true,"uniqueKey":"data.items.[INDEX].client_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Client company name.","isRequired":true,"uniqueKey":"data.items.[INDEX].client_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].client_name","typeLabel":"string | null"},"client_id":{"oneOf":[{"type":"string","format":"uuid","description":"Client company UUID.","isRequired":true,"uniqueKey":"data.items.[INDEX].client_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Client company UUID.","isRequired":true,"uniqueKey":"data.items.[INDEX].client_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].client_id","typeLabel":"string\u003cuuid> | null"},"deal_lost_reason_id":{"oneOf":[{"type":"string","format":"uuid","description":"Selected lost reason UUID, if this deal was lost.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_lost_reason_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Selected lost reason UUID, if this deal was lost.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_lost_reason_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].deal_lost_reason_id","typeLabel":"string\u003cuuid> | null"},"deal_lost_reason_text":{"oneOf":[{"type":"string","description":"Additional notes explaining why the deal was lost.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_lost_reason_text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Additional notes explaining why the deal was lost.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_lost_reason_text.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].deal_lost_reason_text","typeLabel":"string | null"},"deal_lost_reason":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Deal reason UUID.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_lost_reason.oneOf.0.id","typeLabel":"string\u003cuuid>"},"reason":{"type":"string","description":"Human-readable deal reason.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_lost_reason.oneOf.0.reason","typeLabel":"string"}},"required":["id","reason"],"description":"Selected lost reason details, if this deal was lost.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_lost_reason.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string","format":"uuid","description":"Deal reason UUID."},"reason":{"type":"string","description":"Human-readable deal reason."}},"required":["id","reason"],"description":"Selected lost reason details, if this deal was lost.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_lost_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].deal_lost_reason","typeLabel":"object | null"},"deal_won_reason_id":{"oneOf":[{"type":"string","format":"uuid","description":"Selected won reason UUID, if this deal was won.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_won_reason_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Selected won reason UUID, if this deal was won.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_won_reason_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].deal_won_reason_id","typeLabel":"string\u003cuuid> | null"},"deal_won_reason_text":{"oneOf":[{"type":"string","description":"Additional notes explaining why the deal was won.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_won_reason_text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Additional notes explaining why the deal was won.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_won_reason_text.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].deal_won_reason_text","typeLabel":"string | null"},"deal_won_reason":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Deal reason UUID.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_won_reason.oneOf.0.id","typeLabel":"string\u003cuuid>"},"reason":{"type":"string","description":"Human-readable deal reason.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_won_reason.oneOf.0.reason","typeLabel":"string"}},"required":["id","reason"],"description":"Selected won reason details, if this deal was won.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_won_reason.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string","format":"uuid","description":"Deal reason UUID."},"reason":{"type":"string","description":"Human-readable deal reason."}},"required":["id","reason"],"description":"Selected won reason details, if this deal was won.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_won_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].deal_won_reason","typeLabel":"object | null"},"stage_entered_at":{"oneOf":[{"type":"string","description":"ISO 8601 timestamp when the deal entered its current status. Falls back to the creation time when no status history exists.","isRequired":true,"uniqueKey":"data.items.[INDEX].stage_entered_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 8601 timestamp when the deal entered its current status. Falls back to the creation time when no status history exists.","isRequired":true,"uniqueKey":"data.items.[INDEX].stage_entered_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].stage_entered_at","typeLabel":"string | null"},"days_in_stage":{"oneOf":[{"type":"integer","description":"Whole days the deal has been in its current status. Null for won or lost deals.","isRequired":true,"uniqueKey":"data.items.[INDEX].days_in_stage.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Whole days the deal has been in its current status. Null for won or lost deals.","isRequired":true,"uniqueKey":"data.items.[INDEX].days_in_stage.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].days_in_stage","typeLabel":"integer | null"},"is_rotting":{"type":"boolean","description":"True when an open deal has been in its status longer than the status's rotting period (or the organization default).","isRequired":true,"uniqueKey":"data.items.[INDEX].is_rotting","typeLabel":"boolean"},"owners":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Team member UUID. Matches IDs from GET /v1/team-members.","isRequired":true,"uniqueKey":"data.items.[INDEX].owners.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"oneOf":[{"type":"string","description":"Team member full name.","isRequired":true,"uniqueKey":"data.items.[INDEX].owners.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Team member full name.","isRequired":true,"uniqueKey":"data.items.[INDEX].owners.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].owners.items.[INDEX].name","typeLabel":"string | null"}},"required":["id","name"],"uniqueKey":"data.items.[INDEX].owners.items.[INDEX]","typeLabel":"object"},"description":"Deal owners.","isRequired":true,"uniqueKey":"data.items.[INDEX].owners","typeLabel":"object[]"},"compensation":{"oneOf":[{"type":"number","description":"Candidate's expected total annual compensation (salary + bonus + equity). Used to compute the deal amount. Omitted for API-key callers without compensation:read.","uniqueKey":"data.items.[INDEX].compensation.oneOf.0","typeLabel":"number"},{"type":"null","description":"Candidate's expected total annual compensation (salary + bonus + equity). Used to compute the deal amount. Omitted for API-key callers without compensation:read.","uniqueKey":"data.items.[INDEX].compensation.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].compensation","typeLabel":"number | null"},"compensation_currency_code":{"type":"string","description":"ISO 4217 currency code for the estimated compensation. May differ from currency_code when the candidate is paid in a different currency than the firm invoices in. Defaults to the organization setting or USD. Omitted for API-key callers without compensation:read.","uniqueKey":"data.items.[INDEX].compensation_currency_code","typeLabel":"string"},"next_task":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Task UUID. Use GET /v1/tasks/{id} for full task details.","isRequired":true,"uniqueKey":"data.items.[INDEX].next_task.oneOf.0.id","typeLabel":"string\u003cuuid>"},"title":{"oneOf":[{"type":"string","description":"Task text, up to 200 characters.","isRequired":true,"uniqueKey":"data.items.[INDEX].next_task.oneOf.0.title.oneOf.0","typeLabel":"string"},{"type":"null","description":"Task text, up to 200 characters.","isRequired":true,"uniqueKey":"data.items.[INDEX].next_task.oneOf.0.title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].next_task.oneOf.0.title","typeLabel":"string | null"},"task_type":{"type":"string","enum":["text","linkedin_message","linkedin_connection","call","other"],"description":"Task type.","isRequired":true,"uniqueKey":"data.items.[INDEX].next_task.oneOf.0.task_type","typeLabel":"enum\u003cstring>"},"due_date":{"oneOf":[{"type":"string","description":"ISO 8601 due date and time.","isRequired":true,"uniqueKey":"data.items.[INDEX].next_task.oneOf.0.due_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 8601 due date and time.","isRequired":true,"uniqueKey":"data.items.[INDEX].next_task.oneOf.0.due_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].next_task.oneOf.0.due_date","typeLabel":"string | null"}},"required":["id","title","task_type","due_date"],"description":"The open task on this deal with the earliest due date. Null when the deal has no open task. Omitted for API-key callers without tasks:read.","uniqueKey":"data.items.[INDEX].next_task.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string","format":"uuid","description":"Task UUID. Use GET /v1/tasks/{id} for full task details."},"title":{"oneOf":[{"type":"string","description":"Task text, up to 200 characters."},{"type":"null","description":"Task text, up to 200 characters."}]},"task_type":{"type":"string","enum":["text","linkedin_message","linkedin_connection","call","other"],"description":"Task type."},"due_date":{"oneOf":[{"type":"string","description":"ISO 8601 due date and time."},{"type":"null","description":"ISO 8601 due date and time."}]}},"required":["id","title","task_type","due_date"],"description":"The open task on this deal with the earliest due date. Null when the deal has no open task. Omitted for API-key callers without tasks:read.","uniqueKey":"data.items.[INDEX].next_task.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].next_task","typeLabel":"object | null"},"open_task_count":{"type":"integer","description":"Number of open tasks on this deal. Omitted for API-key callers without tasks:read.","uniqueKey":"data.items.[INDEX].open_task_count","typeLabel":"integer"},"needs_attention":{"type":"boolean","description":"True when an open deal is rotting or its next task is overdue. Omitted for API-key callers without tasks:read.","uniqueKey":"data.items.[INDEX].needs_attention","typeLabel":"boolean"},"client_contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Client contact UUID (`client_contacts.id`). Pass these in `client_contact_ids` when creating or updating a deal. This is not the deal_client_contacts junction-row UUID.","isRequired":true,"uniqueKey":"data.items.[INDEX].client_contacts.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"person_id":{"oneOf":[{"type":"string","format":"uuid","description":"UUID of the person this contact represents. Use GET /v1/persons/{id} for full person details.","isRequired":true,"uniqueKey":"data.items.[INDEX].client_contacts.items.[INDEX].person_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"UUID of the person this contact represents. Use GET /v1/persons/{id} for full person details.","isRequired":true,"uniqueKey":"data.items.[INDEX].client_contacts.items.[INDEX].person_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].client_contacts.items.[INDEX].person_id","typeLabel":"string\u003cuuid> | null"},"name":{"oneOf":[{"type":"string","description":"Contact's full name.","isRequired":true,"uniqueKey":"data.items.[INDEX].client_contacts.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Contact's full name.","isRequired":true,"uniqueKey":"data.items.[INDEX].client_contacts.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].client_contacts.items.[INDEX].name","typeLabel":"string | null"},"image_url":{"oneOf":[{"type":"string","description":"Contact's profile image URL.","isRequired":true,"uniqueKey":"data.items.[INDEX].client_contacts.items.[INDEX].image_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Contact's profile image URL.","isRequired":true,"uniqueKey":"data.items.[INDEX].client_contacts.items.[INDEX].image_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].client_contacts.items.[INDEX].image_url","typeLabel":"string | null"},"job_title":{"oneOf":[{"type":"string","description":"Contact's current job title.","isRequired":true,"uniqueKey":"data.items.[INDEX].client_contacts.items.[INDEX].job_title.oneOf.0","typeLabel":"string"},{"type":"null","description":"Contact's current job title.","isRequired":true,"uniqueKey":"data.items.[INDEX].client_contacts.items.[INDEX].job_title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].client_contacts.items.[INDEX].job_title","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","description":"Preferred email address for this person, if any.","isRequired":true,"uniqueKey":"data.items.[INDEX].client_contacts.items.[INDEX].email.oneOf.0","typeLabel":"string"},{"type":"null","description":"Preferred email address for this person, if any.","isRequired":true,"uniqueKey":"data.items.[INDEX].client_contacts.items.[INDEX].email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].client_contacts.items.[INDEX].email","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"Preferred phone number for this person, if any.","isRequired":true,"uniqueKey":"data.items.[INDEX].client_contacts.items.[INDEX].phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Preferred phone number for this person, if any.","isRequired":true,"uniqueKey":"data.items.[INDEX].client_contacts.items.[INDEX].phone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].client_contacts.items.[INDEX].phone","typeLabel":"string | null"}},"required":["id","person_id","name","image_url","job_title","email","phone"],"uniqueKey":"data.items.[INDEX].client_contacts.items.[INDEX]","typeLabel":"object"},"description":"Client contacts linked directly to this deal via deal_client_contacts. On search, included only when include contains \"client_contacts\". Resolved exclusively from deal links — not inferred from the deal client company.","uniqueKey":"data.items.[INDEX].client_contacts","typeLabel":"object[]"},"custom_fields":{"type":"array","items":{"type":"object","properties":{"attribute_id":{"type":"string","format":"uuid","description":"Attribute definition UUID. Get definitions from GET /v1/custom-fields/{entity}.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].attribute_id","typeLabel":"string\u003cuuid>"},"attribute_name":{"type":"string","description":"Attribute display name.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].attribute_name","typeLabel":"string"},"data_type":{"type":"string","enum":["string","integer","decimal","multi-select","single-select","boolean","date","multi-team-member","multi-company","url"],"description":"Attribute data type. Determines which value field contains the data.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].data_type","typeLabel":"enum\u003cstring>"},"job_id":{"oneOf":[{"type":"string","format":"uuid","description":"Job UUID this attribute is scoped to. Null for global person-level attributes. Present when this custom field is specific to a job (candidate-level field).","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].job_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Job UUID this attribute is scoped to. Null for global person-level attributes. Present when this custom field is specific to a job (candidate-level field).","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].job_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].job_id","typeLabel":"string\u003cuuid> | null"},"list_id":{"oneOf":[{"type":"string","format":"uuid","description":"List UUID this attribute is scoped to. Null for global person-level attributes.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].list_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"List UUID this attribute is scoped to. Null for global person-level attributes.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].list_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].list_id","typeLabel":"string\u003cuuid> | null"},"value":{"oneOf":[{"type":"string","description":"Scalar value for string, integer, decimal, date, url, boolean types. Null for select/team-member/company types.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].value.oneOf.0","typeLabel":"string"},{"type":"number","description":"Scalar value for string, integer, decimal, date, url, boolean types. Null for select/team-member/company types.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].value.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"Scalar value for string, integer, decimal, date, url, boolean types. Null for select/team-member/company types.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].value.oneOf.2","typeLabel":"boolean"},{"type":"null","description":"Scalar value for string, integer, decimal, date, url, boolean types. Null for select/team-member/company types.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].value.oneOf.3","typeLabel":"null"},{"type":"null","description":"Scalar value for string, integer, decimal, date, url, boolean types. Null for select/team-member/company types.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].value.oneOf.4","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].value","typeLabel":"string · number · boolean · null · null"},"tag":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Tag option UUID.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].tag.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Tag display name.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].tag.oneOf.0.name","typeLabel":"string"}},"required":["id","name"],"description":"Tag value for single-select and multi-select types. Null for other types. For multi-select, one CustomFieldValue row per tag.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].tag.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string","format":"uuid","description":"Tag option UUID."},"name":{"type":"string","description":"Tag display name."}},"required":["id","name"],"description":"Tag value for single-select and multi-select types. Null for other types. For multi-select, one CustomFieldValue row per tag.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].tag.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].tag","typeLabel":"object | null"},"team_member":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Team member UUID.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].team_member.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"oneOf":[{"type":"string","description":"Team member full name.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].team_member.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Team member full name.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].team_member.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].team_member.oneOf.0.name","typeLabel":"string | null"}},"required":["id","name"],"description":"Team member value for multi-team-member type. Null for other types. One CustomFieldValue row per team member.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].team_member.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string","format":"uuid","description":"Team member UUID."},"name":{"oneOf":[{"type":"string","description":"Team member full name."},{"type":"null","description":"Team member full name."}]}},"required":["id","name"],"description":"Team member value for multi-team-member type. Null for other types. One CustomFieldValue row per team member.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].team_member.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].team_member","typeLabel":"object | null"},"company":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Company UUID.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].company.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"oneOf":[{"type":"string","description":"Company display name.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].company.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Company display name.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].company.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].company.oneOf.0.name","typeLabel":"string | null"}},"required":["id","name"],"description":"Company value for multi-company type. Null for other types. One CustomFieldValue row per company.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].company.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string","format":"uuid","description":"Company UUID."},"name":{"oneOf":[{"type":"string","description":"Company display name."},{"type":"null","description":"Company display name."}]}},"required":["id","name"],"description":"Company value for multi-company type. Null for other types. One CustomFieldValue row per company.","isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].company.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX].company","typeLabel":"object | null"}},"required":["attribute_id","attribute_name","data_type","job_id","list_id","value","tag","team_member","company"],"uniqueKey":"data.items.[INDEX].custom_fields.items.[INDEX]","typeLabel":"object"},"description":"Custom attribute values. Included when include contains \"custom_fields\".","uniqueKey":"data.items.[INDEX].custom_fields","typeLabel":"object[]"},"deal_status_changes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Status-change record UUID.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status_changes.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"deal_status_id":{"type":"string","format":"uuid","description":"Status the deal entered. Matches ids from GET /v1/deals/statuses.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status_changes.items.[INDEX].deal_status_id","typeLabel":"string\u003cuuid>"},"deal_status_name":{"oneOf":[{"type":"string","description":"Name of the status at the time it was recorded.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status_changes.items.[INDEX].deal_status_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the status at the time it was recorded.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status_changes.items.[INDEX].deal_status_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status_changes.items.[INDEX].deal_status_name","typeLabel":"string | null"},"deal_status_type":{"oneOf":[{"type":"string","enum":["active","won","lost"],"description":"Lifecycle category of that status: active, won, or lost.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status_changes.items.[INDEX].deal_status_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["active","won","lost"],"description":"Lifecycle category of that status: active, won, or lost.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status_changes.items.[INDEX].deal_status_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status_changes.items.[INDEX].deal_status_type","typeLabel":"enum\u003cstring> | null"},"entered_at":{"type":"string","description":"ISO 8601 timestamp when the deal entered this status.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status_changes.items.[INDEX].entered_at","typeLabel":"string"},"exited_at":{"oneOf":[{"type":"string","description":"ISO 8601 timestamp when the deal left this status. Null while this is the current status.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status_changes.items.[INDEX].exited_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 8601 timestamp when the deal left this status. Null while this is the current status.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status_changes.items.[INDEX].exited_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status_changes.items.[INDEX].exited_at","typeLabel":"string | null"},"created_at":{"type":"string","description":"ISO 8601 timestamp when this history row was recorded.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status_changes.items.[INDEX].created_at","typeLabel":"string"},"created_by":{"oneOf":[{"type":"string","format":"uuid","description":"Team member who recorded the change. Null when the change was not attributed. Matches ids from GET /v1/team-members.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status_changes.items.[INDEX].created_by.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Team member who recorded the change. Null when the change was not attributed. Matches ids from GET /v1/team-members.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status_changes.items.[INDEX].created_by.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status_changes.items.[INDEX].created_by","typeLabel":"string\u003cuuid> | null"},"reason_text":{"oneOf":[{"type":"string","description":"Optional note stored with the status change.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status_changes.items.[INDEX].reason_text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional note stored with the status change.","isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status_changes.items.[INDEX].reason_text.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].deal_status_changes.items.[INDEX].reason_text","typeLabel":"string | null"}},"required":["id","deal_status_id","deal_status_name","deal_status_type","entered_at","exited_at","created_at","created_by","reason_text"],"uniqueKey":"data.items.[INDEX].deal_status_changes.items.[INDEX]","typeLabel":"object"},"description":"Recorded deal status history, oldest first. Each entry is one stay in a status. Included on search and deal detail when include contains \"deal_status_changes\". Omitted otherwise.","uniqueKey":"data.items.[INDEX].deal_status_changes","typeLabel":"object[]"}},"required":["id","name","amount","currency_code","pricing_rate","win_probability","closed_date","open_date","last_contacted_at","deal_status","created_at","client_name","client_id","deal_lost_reason_id","deal_lost_reason_text","deal_lost_reason","deal_won_reason_id","deal_won_reason_text","deal_won_reason","stage_entered_at","days_in_stage","is_rotting","owners"],"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data","typeLabel":"object[]"},"meta":{"type":"object","properties":{"total":{"type":"number","description":"Total matching records across all pages.","isRequired":true,"uniqueKey":"meta.total","typeLabel":"number"},"offset":{"type":"number","description":"Current pagination offset.","isRequired":true,"uniqueKey":"meta.offset","typeLabel":"number"},"limit":{"type":"number","description":"Page size used for this request.","isRequired":true,"uniqueKey":"meta.limit","typeLabel":"number"}},"required":["total","offset","limit"],"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"required":["success","data","meta"],"uniqueKey":"","typeLabel":"object"},"example":{"success":true,"data":[{"id":"aaa11111-bbbb-cccc-dddd-eeeeeeee1111","name":"Acme Corp Staffing Agreement","amount":150000,"currency_code":"USD","compensation":750000,"compensation_currency_code":"USD","pricing_rate":20,"win_probability":75,"closed_date":"2024-06-30T00:00:00Z","open_date":"2024-01-15","last_contacted_at":"2024-05-20T14:30:00Z","deal_status":{"id":"ccc33333-dddd-eeee-ffff-000000003333","name":"Proposal Sent"},"created_at":"2024-01-15T10:00:00Z","client_name":"Acme Corp","client_id":"bbb22222-cccc-dddd-eeee-ffffffff2222","deal_lost_reason_id":null,"deal_lost_reason_text":null,"deal_lost_reason":null,"deal_won_reason_id":"66666666-7777-8888-9999-aaaaaaaaaaaa","deal_won_reason_text":"Client chose us because of prior executive-search success.","deal_won_reason":{"id":"66666666-7777-8888-9999-aaaaaaaaaaaa","reason":"Strong relationship"},"next_task":{"id":"77777777-8888-9999-aaaa-bbbbbbbbbbbb","title":"Follow-up call","task_type":"call","due_date":"2024-05-22T15:00:00Z"},"open_task_count":2,"stage_entered_at":"2024-05-01T09:00:00Z","days_in_stage":21,"is_rotting":true,"needs_attention":true,"owners":[{"id":"ddd44444-eeee-ffff-0000-111111114444","name":"Jane Smith"}],"custom_fields":[{"attribute_id":"f1e2d3c4-b5a6-7890-abcd-ef1234567890","attribute_name":"Deal Priority","data_type":"single-select","value":null,"tag":{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","name":"High"},"team_member":null,"company":null},{"attribute_id":"c3d4e5f6-a7b8-9012-cdef-345678901234","attribute_name":"Referred By","data_type":"multi-company","value":null,"tag":null,"team_member":null,"company":{"id":"bbb22222-cccc-dddd-eeee-ffffffff2222","name":"Acme Corp"}}],"deal_status_changes":[{"id":"99999999-aaaa-bbbb-cccc-dddddddddddd","deal_status_id":"12121212-3434-5656-7878-909090909090","deal_status_name":"Qualified","deal_status_type":"active","entered_at":"2024-01-15T10:00:00Z","exited_at":"2024-05-01T09:00:00Z","created_at":"2024-01-15T10:00:00Z","created_by":"ddd44444-eeee-ffff-0000-111111114444","reason_text":null},{"id":"88888888-9999-aaaa-bbbb-cccccccccccc","deal_status_id":"ccc33333-dddd-eeee-ffff-000000003333","deal_status_name":"Proposal Sent","deal_status_type":"active","entered_at":"2024-05-01T09:00:00Z","exited_at":null,"created_at":"2024-05-01T09:00:00Z","created_by":"ddd44444-eeee-ffff-0000-111111114444","reason_text":"Proposal sent to the client"}]}],"meta":{"total":100,"offset":0,"limit":20}},"examples":{"Example":{"title":"Example","value":{"success":true,"data":[{"id":"aaa11111-bbbb-cccc-dddd-eeeeeeee1111","name":"Acme Corp Staffing Agreement","amount":150000,"currency_code":"USD","compensation":750000,"compensation_currency_code":"USD","pricing_rate":20,"win_probability":75,"closed_date":"2024-06-30T00:00:00Z","open_date":"2024-01-15","last_contacted_at":"2024-05-20T14:30:00Z","deal_status":{"id":"ccc33333-dddd-eeee-ffff-000000003333","name":"Proposal Sent"},"created_at":"2024-01-15T10:00:00Z","client_name":"Acme Corp","client_id":"bbb22222-cccc-dddd-eeee-ffffffff2222","deal_lost_reason_id":null,"deal_lost_reason_text":null,"deal_lost_reason":null,"deal_won_reason_id":"66666666-7777-8888-9999-aaaaaaaaaaaa","deal_won_reason_text":"Client chose us because of prior executive-search success.","deal_won_reason":{"id":"66666666-7777-8888-9999-aaaaaaaaaaaa","reason":"Strong relationship"},"next_task":{"id":"77777777-8888-9999-aaaa-bbbbbbbbbbbb","title":"Follow-up call","task_type":"call","due_date":"2024-05-22T15:00:00Z"},"open_task_count":2,"stage_entered_at":"2024-05-01T09:00:00Z","days_in_stage":21,"is_rotting":true,"needs_attention":true,"owners":[{"id":"ddd44444-eeee-ffff-0000-111111114444","name":"Jane Smith"}],"custom_fields":[{"attribute_id":"f1e2d3c4-b5a6-7890-abcd-ef1234567890","attribute_name":"Deal Priority","data_type":"single-select","value":null,"tag":{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","name":"High"},"team_member":null,"company":null},{"attribute_id":"c3d4e5f6-a7b8-9012-cdef-345678901234","attribute_name":"Referred By","data_type":"multi-company","value":null,"tag":null,"team_member":null,"company":{"id":"bbb22222-cccc-dddd-eeee-ffffffff2222","name":"Acme Corp"}}],"deal_status_changes":[{"id":"99999999-aaaa-bbbb-cccc-dddddddddddd","deal_status_id":"12121212-3434-5656-7878-909090909090","deal_status_name":"Qualified","deal_status_type":"active","entered_at":"2024-01-15T10:00:00Z","exited_at":"2024-05-01T09:00:00Z","created_at":"2024-01-15T10:00:00Z","created_by":"ddd44444-eeee-ffff-0000-111111114444","reason_text":null},{"id":"88888888-9999-aaaa-bbbb-cccccccccccc","deal_status_id":"ccc33333-dddd-eeee-ffff-000000003333","deal_status_name":"Proposal Sent","deal_status_type":"active","entered_at":"2024-05-01T09:00:00Z","exited_at":null,"created_at":"2024-05-01T09:00:00Z","created_by":"ddd44444-eeee-ffff-0000-111111114444","reason_text":"Proposal sent to the client"}]}],"meta":{"total":100,"offset":0,"limit":20}}}},"exampleType":"examples"}},"exampleType":"examples"},"524b4feb-413f-4401-b42b-29c9b8408a6c":{"description":"Validation error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"description":"Always false for error responses.","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\").","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error description.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"description":"Extra facts about the error when they help you fix it, such as a limit and when it resets.","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["success","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"\u003cstring>","message":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"eaefcf9e-f5df-4c3f-9616-16da26b41f4b":{"description":"You do not have permission to view CRM data. Applies to session and OAuth callers without CRM access; API keys are not affected.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"description":"Always false for error responses.","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\").","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error description.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"description":"Extra facts about the error when they help you fix it, such as a limit and when it resets.","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["success","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"\u003cstring>","message":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"4ccd7450-41b8-441e-a4c5-f6fd9ad9277c":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"description":"Always false for error responses.","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\").","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error description.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"description":"Extra facts about the error when they help you fix it, such as a limit and when it resets.","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["success","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"\u003cstring>","message":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"e35ed348-82bf-4245-afcf-65c994972d09":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"description":"Always false for error responses.","isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code (e.g. \"VALIDATION_ERROR\", \"NOT_FOUND\").","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error description.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"description":"Extra facts about the error when they help you fix it, such as a limit and when it resets.","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["success","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"\u003cstring>","message":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"ec123555-6fb6-48ad-bf3e-ba9c2f616d21":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Authenticate with a Bearer token: API key, OAuth token, or session token.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"d7538d15-a885-40aa-a5a5-e912a47fa5aa":{"url":"https://api.stardex.ai","description":"Production API server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Authenticate with a Bearer token: API key, OAuth token, or session token.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Authenticate with a Bearer token: API key, OAuth token, or session token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi-v1.json"},"subdomain":"stardex","siteName":"Stardex Help Docs","title":"Search deals - Stardex Help Docs","navMaps":{"firstHrefInVersion":{"v1":{"href":"/api-reference/deals/search-deals","matchLevel":0},"v0 (Deprecated)":{"href":"/api-reference/introduction","matchLevel":3}},"firstHrefInLanguage":{}},"lastModified":"2026-11-20T17:13:32.791Z","originalFileLocation":"api-reference/deals/search-deals.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Search and filter deals with pagination and sorting using the deals_list_query RPC. Filters: keywords (name + company search), deal_status_ids_included/excluded (current status), deal_status_reached (statuses the deal has entered, with optional start_date and end_date as inclusive UTC days), owner_ids_included/excluded, show_open_deals_only, show_archived, closed_date_filter, open_date_filter, and custom attribute filters (select_attribute_filters, numeric_attribute_filters, date_attribute_filters, team_member_attribute_filters, company_attribute_filters). Sorting: name, amount, win_probability, company, status, closed_date, open_date, last_contacted_at, created_at, or custom_ for custom attribute sorting. Include: Pass [\u0026quot;custom_fields\u0026quot;], [\u0026quot;client_contacts\u0026quot;], and/or [\u0026quot;deal_status_changes\u0026quot;] to embed those sections. client_contacts and deal_status_changes are omitted unless explicitly requested. deal_status_changes is the recorded status history, oldest first. For API-key callers, compensation and compensation_currency_code require compensation:read; inaccessible fields are omitted. Deal amount and pricing_rate are available with deals:read. next_task, open_task_count and needs_attention also require tasks:read.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Stardex Help Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/stardex/joPRbrJhRInrO3yB/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/stardex/joPRbrJhRInrO3yB/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/stardex/joPRbrJhRInrO3yB/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/stardex/joPRbrJhRInrO3yB/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/stardex/joPRbrJhRInrO3yB/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/stardex/joPRbrJhRInrO3yB/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/stardex/joPRbrJhRInrO3yB/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/stardex/joPRbrJhRInrO3yB/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/stardex/joPRbrJhRInrO3yB/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Search deals - Stardex Help Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Search and filter deals with pagination and sorting using the deals_list_query RPC. Filters: keywords (name + company search), deal_status_ids_included/excluded (current status), deal_status_reached (statuses the deal has entered, with optional start_date and end_date as inclusive UTC days), owner_ids_included/excluded, show_open_deals_only, show_archived, closed_date_filter, open_date_filter, and custom attribute filters (select_attribute_filters, numeric_attribute_filters, date_attribute_filters, team_member_attribute_filters, company_attribute_filters). Sorting: name, amount, win_probability, company, status, closed_date, open_date, last_contacted_at, created_at, or custom_ for custom attribute sorting. Include: Pass [\u0026quot;custom_fields\u0026quot;], [\u0026quot;client_contacts\u0026quot;], and/or [\u0026quot;deal_status_changes\u0026quot;] to embed those sections. client_contacts and deal_status_changes are omitted unless explicitly requested. deal_status_changes is the recorded status history, oldest first. For API-key callers, compensation and compensation_currency_code require compensation:read; inaccessible fields are omitted. Deal amount and pricing_rate are available with deals:read. next_task, open_task_count and needs_attention also require tasks:read.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Stardex Help Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.stardex.com/api-reference/deals/search-deals\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://stardex.mintlify.site/_mintlify/api/og/v2?division=Deals\u0026amp;title=Search+deals\u0026amp;description=Search+and+filter+deals+with+pagination+and+sorting+using+the+deals_list_query+RPC.%0A%0A**Filters**%3A+%60keywords%60+%28name+%2B+company+search%29%2C+%60deal_status_ids_included%60\u0026amp;theme=6b880d364dfb7d609072cc33\u0026amp;signature=3f2dfcfe8d44c1d43d8e6cc011cfb29891a33b72cd5ae680ce3f2873a58d5035\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Search deals - Stardex Help Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Search and filter deals with pagination and sorting using the deals_list_query RPC. Filters: keywords (name + company search), deal_status_ids_included/excluded (current status), deal_status_reached (statuses the deal has entered, with optional start_date and end_date as inclusive UTC days), owner_ids_included/excluded, show_open_deals_only, show_archived, closed_date_filter, open_date_filter, and custom attribute filters (select_attribute_filters, numeric_attribute_filters, date_attribute_filters, team_member_attribute_filters, company_attribute_filters). Sorting: name, amount, win_probability, company, status, closed_date, open_date, last_contacted_at, created_at, or custom_ for custom attribute sorting. Include: Pass [\u0026quot;custom_fields\u0026quot;], [\u0026quot;client_contacts\u0026quot;], and/or [\u0026quot;deal_status_changes\u0026quot;] to embed those sections. client_contacts and deal_status_changes are omitted unless explicitly requested. deal_status_changes is the recorded status history, oldest first. For API-key callers, compensation and compensation_currency_code require compensation:read; inaccessible fields are omitted. Deal amount and pricing_rate are available with deals:read. next_task, open_task_count and needs_attention also require tasks:read.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://stardex.mintlify.site/_mintlify/api/og/v2?division=Deals\u0026amp;title=Search+deals\u0026amp;description=Search+and+filter+deals+with+pagination+and+sorting+using+the+deals_list_query+RPC.%0A%0A**Filters**%3A+%60keywords%60+%28name+%2B+company+search%29%2C+%60deal_status_ids_included%60\u0026amp;theme=6b880d364dfb7d609072cc33\u0026amp;signature=3f2dfcfe8d44c1d43d8e6cc011cfb29891a33b72cd5ae680ce3f2873a58d5035\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/stardex/joPRbrJhRInrO3yB/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Stardex Help Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5853f7\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.stardex.com/api-reference/deals/search-deals\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/deals/search-deals.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.stardex.com/#organization\",\"name\":\"Stardex Help Docs\",\"url\":\"https://docs.stardex.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/stardex/Unebva7RlCeyAgPy/logo/light.svg?fit=max\u0026auto=format\u0026n=Unebva7RlCeyAgPy\u0026q=85\u0026s=6a32bc87265a1562f0ee3793cb4c66e7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.stardex.com#website\",\"name\":\"Stardex Help Docs\",\"url\":\"https://docs.stardex.com\",\"publisher\":{\"@id\":\"https://docs.stardex.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.stardex.com/api-reference/deals/search-deals#webpage\",\"url\":\"https://docs.stardex.com/api-reference/deals/search-deals\",\"name\":\"Search deals\",\"description\":\"Search and filter deals with pagination and sorting using the deals_list_query RPC. Filters: keywords (name + company search), deal_status_ids_included/excluded (current status), deal_status_reached (statuses the deal has entered, with optional start_date and end_date as inclusive UTC days), owner_ids_included/excluded, show_open_deals_only, show_archived, closed_date_filter, open_date_filter, and custom attribute filters (select_attribute_filters, numeric_attribute_filters, date_attribute_filters, team_member_attribute_filters, company_attribute_filters). Sorting: name, amount, win_probability, company, status, closed_date, open_date, last_contacted_at, created_at, or custom_ for custom attribute sorting. Include: Pass [\\\"custom_fields\\\"], [\\\"client_contacts\\\"], and/or [\\\"deal_status_changes\\\"] to embed those sections. client_contacts and deal_status_changes are omitted unless explicitly requested. deal_status_changes is the recorded status history, oldest first. For API-key callers, compensation and compensation_currency_code require compensation:read; inaccessible fields are omitted. Deal amount and pricing_rate are available with deals:read. next_task, open_task_count and needs_attention also require tasks:read.\",\"dateModified\":\"2026-11-20T17:13:32.791Z\",\"isPartOf\":{\"@id\":\"https://docs.stardex.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.stardex.com/api-reference/deals/search-deals#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.stardex.com/api-reference/deals/search-deals#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Deals\",\"item\":\"https://docs.stardex.com/api-reference/deals/list-deal-statuses\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Search deals\",\"item\":\"https://docs.stardex.com/api-reference/deals/search-deals\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.stardex.com/api-reference/deals/search-deals#apireference\",\"headline\":\"Search deals\",\"name\":\"Search deals\",\"description\":\"Search and filter deals with pagination and sorting using the deals_list_query RPC. Filters: keywords (name + company search), deal_status_ids_included/excluded (current status), deal_status_reached (statuses the deal has entered, with optional start_date and end_date as inclusive UTC days), owner_ids_included/excluded, show_open_deals_only, show_archived, closed_date_filter, open_date_filter, and custom attribute filters (select_attribute_filters, numeric_attribute_filters, date_attribute_filters, team_member_attribute_filters, company_attribute_filters). Sorting: name, amount, win_probability, company, status, closed_date, open_date, last_contacted_at, created_at, or custom_ for custom attribute sorting. Include: Pass [\\\"custom_fields\\\"], [\\\"client_contacts\\\"], and/or [\\\"deal_status_changes\\\"] to embed those sections. client_contacts and deal_status_changes are omitted unless explicitly requested. deal_status_changes is the recorded status history, oldest first. For API-key callers, compensation and compensation_currency_code require compensation:read; inaccessible fields are omitted. Deal amount and pricing_rate are available with deals:read. next_task, open_task_count and needs_attention also require tasks:read.\",\"url\":\"https://docs.stardex.com/api-reference/deals/search-deals\",\"mainEntityOfPage\":{\"@id\":\"https://docs.stardex.com/api-reference/deals/search-deals#webpage\"},\"dateModified\":\"2026-11-20T17:13:32.791Z\",\"publisher\":{\"@id\":\"https://docs.stardex.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.stardex.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Stardex Help Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Stardex Help Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/deals/search-deals.md","siteName":"Stardex Help Docs","nav":{"global":{"anchors":[{"anchor":"Home page","icon":"book-open-cover","href":"https://www.stardex.com"},{"anchor":"Blog","icon":"newspaper","href":"https://www.stardex.com/blog"}]},"tabs":[{"tab":"Guides","hidden":true,"pages":[{"title":"Guides","href":"/help-center/ai-activity-updates"}]},{"tab":"Help Center","pages":[{"title":"Help Center","href":"/help-center"}]},{"tab":"Changelog","hidden":true,"pages":[{"title":"Changelog","href":"/changelog-stardex"}]},{"tab":"API Reference","versions":[{"version":"v1","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction-v1"},{"title":"Enrolling people in campaigns","href":"/api-reference/campaigns-guide"}]},{"group":"Activity Reports","pages":[{"title":"Generate an activity \u0026 stage-change report","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/activity-reports","href":"/api-reference/activity-reports/generate-an-activity-\u0026-stage-change-report"}]},{"group":"Automations","pages":[{"title":"Search automations","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/automations/search","href":"/api-reference/automations/search-automations"},{"title":"List automation trigger types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/automations/trigger-types","href":"/api-reference/automations/list-automation-trigger-types"},{"title":"List automation action types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/automations/action-types","href":"/api-reference/automations/list-automation-action-types"},{"title":"List automation run statuses","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/automations/run-statuses","href":"/api-reference/automations/list-automation-run-statuses"},{"title":"Get automation by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/automations/{id}","href":"/api-reference/automations/get-automation-by-id"},{"title":"Archive automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/automations/{id}","href":"/api-reference/automations/archive-automation"},{"title":"Update automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/automations/{id}","href":"/api-reference/automations/update-automation"},{"title":"Create automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/automations","href":"/api-reference/automations/create-automation"},{"title":"Search automation runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/automations/{id}/runs/search","href":"/api-reference/automations/search-automation-runs"},{"title":"Get automation run by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/automations/runs/{runId}","href":"/api-reference/automations/get-automation-run-by-id"}]},{"group":"Calendar Meetings","pages":[{"title":"List calendar meetings","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/calendar-meetings","href":"/api-reference/calendar-meetings/list-calendar-meetings"},{"title":"Get calendar meeting by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/calendar-meetings/{id}","href":"/api-reference/calendar-meetings/get-calendar-meeting-by-id"}]},{"group":"Campaigns","pages":[{"title":"Search campaigns","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/campaigns/search","href":"/api-reference/campaigns/search-campaigns"},{"title":"List campaign types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/campaigns/types","href":"/api-reference/campaigns/list-campaign-types"},{"title":"List campaign variables","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/campaigns/variables","href":"/api-reference/campaigns/list-campaign-variables"},{"title":"List sending mailboxes","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/campaigns/mailboxes","href":"/api-reference/campaigns/list-sending-mailboxes"},{"title":"Get campaign by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/campaigns/{id}","href":"/api-reference/campaigns/get-campaign-by-id"},{"title":"Update campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/campaigns/{id}","href":"/api-reference/campaigns/update-campaign"},{"title":"Create campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/campaigns","href":"/api-reference/campaigns/create-campaign"},{"title":"Add campaign step","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/campaigns/{id}/steps","href":"/api-reference/campaigns/add-campaign-step"},{"title":"Delete campaign step","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/campaigns/{id}/steps/{step_id}","href":"/api-reference/campaigns/delete-campaign-step"},{"title":"Update campaign step","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/campaigns/{id}/steps/{step_id}","href":"/api-reference/campaigns/update-campaign-step"},{"title":"Reorder campaign steps","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/campaigns/{id}/steps/reorder","href":"/api-reference/campaigns/reorder-campaign-steps"},{"title":"List enrollment status groups","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/campaigns/enrollment-statuses","href":"/api-reference/campaigns/list-enrollment-status-groups"},{"title":"Prepare an enrollment","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/campaigns/{id}/enrollment-batches","href":"/api-reference/campaigns/prepare-an-enrollment"},{"title":"Get an enrollment batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/campaigns/{id}/enrollment-batches/{batch_id}","href":"/api-reference/campaigns/get-an-enrollment-batch"},{"title":"Get one person in a batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/campaigns/{id}/enrollment-batches/{batch_id}/recipients/{recipient_id}","href":"/api-reference/campaigns/get-one-person-in-a-batch"},{"title":"Change one person in a batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/campaigns/{id}/enrollment-batches/{batch_id}/recipients/{recipient_id}","href":"/api-reference/campaigns/change-one-person-in-a-batch"},{"title":"Add people to a batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/campaigns/{id}/enrollment-batches/{batch_id}/recipients","href":"/api-reference/campaigns/add-people-to-a-batch"},{"title":"Start an enrollment","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/campaigns/{id}/enrollment-batches/{batch_id}/start","href":"/api-reference/campaigns/start-an-enrollment"},{"title":"Discard an enrollment batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/campaigns/{id}/enrollment-batches/{batch_id}/discard","href":"/api-reference/campaigns/discard-an-enrollment-batch"},{"title":"Search enrollees","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/campaigns/{id}/enrollments/search","href":"/api-reference/campaigns/search-enrollees"},{"title":"Search the campaign queue","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/campaigns/enrollment-steps/search","href":"/api-reference/campaigns/search-the-campaign-queue"},{"title":"Get an enrollee","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/campaigns/{id}/enrollments/{enrollment_id}","href":"/api-reference/campaigns/get-an-enrollee"},{"title":"Edit an enrollee's upcoming step","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/campaigns/{id}/enrollments/{enrollment_id}/steps/{step_id}","href":"/api-reference/campaigns/edit-an-enrollees-upcoming-step"},{"title":"Stop enrollees","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/campaigns/{id}/enrollments/stop","href":"/api-reference/campaigns/stop-enrollees"}]},{"group":"Candidates","pages":[{"title":"Update candidate stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/candidates/update-stage","href":"/api-reference/candidates/update-candidate-stage"},{"title":"Search candidates across jobs","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/candidates/search","href":"/api-reference/candidates/search-candidates-across-jobs"},{"title":"List rejection reasons","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/candidates/rejection-reasons","href":"/api-reference/candidates/list-rejection-reasons"},{"title":"Get candidate by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/candidates/{id}","href":"/api-reference/candidates/get-candidate-by-id"},{"title":"Remove candidate from job","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/candidates/{id}","href":"/api-reference/candidates/remove-candidate-from-job"}]},{"group":"Client Contacts","pages":[{"title":"List client contact statuses","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/client-contacts/statuses","href":"/api-reference/client-contacts/list-client-contact-statuses"},{"title":"List client contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/client-contacts","href":"/api-reference/client-contacts/list-client-contacts"},{"title":"Create client contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/client-contacts","href":"/api-reference/client-contacts/create-client-contact"},{"title":"Get client contact by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/client-contacts/{id}","href":"/api-reference/client-contacts/get-client-contact-by-id"},{"title":"Update client contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/client-contacts/{id}","href":"/api-reference/client-contacts/update-client-contact"}]},{"group":"Companies","pages":[{"title":"List company client statuses","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/companies/statuses","href":"/api-reference/companies/list-company-client-statuses"},{"title":"Search companies","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/companies/search","href":"/api-reference/companies/search-companies"},{"title":"Create or update company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/companies","href":"/api-reference/companies/create-or-update-company"},{"title":"Get company by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/companies/{id}","href":"/api-reference/companies/get-company-by-id"},{"title":"Update company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/companies/{id}","href":"/api-reference/companies/update-company"},{"title":"List company document types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/companies/document-types","href":"/api-reference/companies/list-company-document-types"},{"title":"Get company documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/companies/{id}/documents","href":"/api-reference/companies/get-company-documents"},{"title":"Upload company document","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/companies/{id}/documents","href":"/api-reference/companies/upload-company-document"}]},{"group":"Company Activities","pages":[{"title":"List company activity types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/company-activities/types","href":"/api-reference/company-activities/list-company-activity-types"},{"title":"List company activities","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/company-activities","href":"/api-reference/company-activities/list-company-activities"},{"title":"Create company activity (note)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/company-activities","href":"/api-reference/company-activities/create-company-activity-note"},{"title":"Get company activity by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/company-activities/{id}","href":"/api-reference/company-activities/get-company-activity-by-id"},{"title":"Update company activity (note) by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/company-activities/{id}","href":"/api-reference/company-activities/update-company-activity-note-by-id"}]},{"group":"Company Insights","pages":[{"title":"List AI-extracted insights for a company","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/company-insights","href":"/api-reference/company-insights/list-ai-extracted-insights-for-a-company"},{"title":"Edit content or dismiss/restore an insight","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/company-insights/{id}","href":"/api-reference/company-insights/edit-content-or-dismissrestore-an-insight"},{"title":"Dismiss multiple insights at once","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/company-insights/bulk-dismiss","href":"/api-reference/company-insights/dismiss-multiple-insights-at-once"},{"title":"Manually extract insights from an activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/company-insights/trigger","href":"/api-reference/company-insights/manually-extract-insights-from-an-activity"}]},{"group":"Custom Fields","pages":[{"title":"Get person custom field definitions","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/custom-fields/persons","href":"/api-reference/custom-fields/get-person-custom-field-definitions"},{"title":"Get company custom field definitions","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/custom-fields/companies","href":"/api-reference/custom-fields/get-company-custom-field-definitions"},{"title":"Get job custom field definitions","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/custom-fields/jobs","href":"/api-reference/custom-fields/get-job-custom-field-definitions"},{"title":"Get deal custom field definitions","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/custom-fields/deals","href":"/api-reference/custom-fields/get-deal-custom-field-definitions"}]},{"group":"Deal Activities","pages":[{"title":"List deal activities","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/deal-activities","href":"/api-reference/deal-activities/list-deal-activities"},{"title":"Create deal activity (note)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/deal-activities","href":"/api-reference/deal-activities/create-deal-activity-note"},{"title":"Get deal activity by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/deal-activities/{id}","href":"/api-reference/deal-activities/get-deal-activity-by-id"},{"title":"Update deal activity (note) by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/deal-activities/{id}","href":"/api-reference/deal-activities/update-deal-activity-note-by-id"}]},{"group":"Deals","pages":[{"title":"List deal statuses","description":"Returns all deal statuses for the organization, ordered by stage_order. No pagination — the full list is always returned.\n\n**When to use**: Call this to discover available status IDs for `deal_status_ids_included` / `deal_status_ids_excluded` and `deal_status_reached` filters in `POST /v1/deals/search`, or for `deal_status_id` when creating/updating deals.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/deals/statuses","href":"/api-reference/deals/list-deal-statuses"},{"title":"Search deals","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/deals/search","href":"/api-reference/deals/search-deals"},{"title":"Get deal by ID","description":"Retrieve a single deal by UUID, including won/lost reasons and notes, with optional custom field values.\n\nArchived deals are returned the same as active ones. Check `is_archived` on the response.\n\n`client_contacts` are always included (empty array when none are linked).\n\n**Include**: By default, `custom_fields` are included. Pass `include=` (empty) for base fields only. Pass `include=deal_status_changes` to embed the recorded status history, oldest first. Passing `include` replaces the default, so list `custom_fields` as well when you still want custom fields.\n\nFor API-key callers, `compensation` and `compensation_currency_code` require `compensation:read`; inaccessible fields are omitted. Deal `amount` and `pricing_rate` are available with `deals:read`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/deals/{id}","href":"/api-reference/deals/get-deal-by-id"},{"title":"Archive deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/deals/{id}","href":"/api-reference/deals/archive-deal"},{"title":"Update deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/deals/{id}","href":"/api-reference/deals/update-deal"},{"title":"Create deal","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/deals","href":"/api-reference/deals/create-deal"}]},{"group":"Retainer Packs","pages":[{"title":"List fee statuses","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/fee-statuses","href":"/api-reference/retainer-packs/list-fee-statuses"},{"title":"List retainer packs","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/retainer-packs","href":"/api-reference/retainer-packs/list-retainer-packs"},{"title":"Create a retainer pack","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/retainer-packs","href":"/api-reference/retainer-packs/create-a-retainer-pack"},{"title":"Get a retainer pack","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/retainer-packs/{id}","href":"/api-reference/retainer-packs/get-a-retainer-pack"},{"title":"Delete a retainer pack","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/retainer-packs/{id}","href":"/api-reference/retainer-packs/delete-a-retainer-pack"},{"title":"Update a retainer pack","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/retainer-packs/{id}","href":"/api-reference/retainer-packs/update-a-retainer-pack"},{"title":"Close a retainer pack","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/retainer-packs/{id}/close","href":"/api-reference/retainer-packs/close-a-retainer-pack"},{"title":"Reopen a retainer pack","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/retainer-packs/{id}/reopen","href":"/api-reference/retainer-packs/reopen-a-retainer-pack"},{"title":"Add an adjustment to a closed retainer pack","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/retainer-packs/{id}/adjustments","href":"/api-reference/retainer-packs/add-an-adjustment-to-a-closed-retainer-pack"},{"title":"Delete a retainer pack adjustment","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/retainer-packs/{id}/adjustments/{adjustment_id}","href":"/api-reference/retainer-packs/delete-a-retainer-pack-adjustment"},{"title":"Delete an open retainer from a pack","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/retainer-packs/{id}/retainers/{retainer_id}","href":"/api-reference/retainer-packs/delete-an-open-retainer-from-a-pack"},{"title":"Replace a claimed retainer's split","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json put /v1/retainer-packs/{id}/retainers/{retainer_id}/split","href":"/api-reference/retainer-packs/replace-a-claimed-retainers-split"}]},{"group":"Job Activities","pages":[{"title":"List job activities","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/job-activities","href":"/api-reference/job-activities/list-job-activities"},{"title":"Create job activity (note)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/job-activities","href":"/api-reference/job-activities/create-job-activity-note"},{"title":"Get job activity by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/job-activities/{id}","href":"/api-reference/job-activities/get-job-activity-by-id"},{"title":"Update job activity (note) by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/job-activities/{id}","href":"/api-reference/job-activities/update-job-activity-note-by-id"}]},{"group":"Job Offers","pages":[{"title":"List job offer statuses","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/job-offers/statuses","href":"/api-reference/job-offers/list-job-offer-statuses"},{"title":"Get job offer by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/job-offers/{id}","href":"/api-reference/job-offers/get-job-offer-by-id"},{"title":"Delete job offer","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/job-offers/{id}","href":"/api-reference/job-offers/delete-job-offer"},{"title":"Update job offer","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/job-offers/{id}","href":"/api-reference/job-offers/update-job-offer"},{"title":"List job offers","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/job-offers","href":"/api-reference/job-offers/list-job-offers"},{"title":"Create job offer","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/job-offers","href":"/api-reference/job-offers/create-job-offer"}]},{"group":"Jobs","pages":[{"title":"List jobs (deprecated)","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/jobs","href":"/api-reference/jobs/list-jobs-deprecated"},{"title":"Create job","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/jobs","href":"/api-reference/jobs/create-job"},{"title":"Search jobs","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/jobs/search","href":"/api-reference/jobs/search-jobs"},{"title":"Get job by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/jobs/{id}","href":"/api-reference/jobs/get-job-by-id"},{"title":"Update job","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/jobs/{id}","href":"/api-reference/jobs/update-job"},{"title":"List job candidates","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/jobs/{id}/candidates","href":"/api-reference/jobs/list-job-candidates"},{"title":"List job applicants","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/jobs/{id}/applicants","href":"/api-reference/jobs/list-job-applicants"},{"title":"List job document types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/jobs/document-types","href":"/api-reference/jobs/list-job-document-types"},{"title":"Get job documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/jobs/{id}/documents","href":"/api-reference/jobs/get-job-documents"},{"title":"Upload job document","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/jobs/{id}/documents","href":"/api-reference/jobs/upload-job-document"},{"title":"Add job target companies","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/jobs/{id}/target-companies","href":"/api-reference/jobs/add-job-target-companies"},{"title":"Remove job target companies","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/jobs/{id}/target-companies","href":"/api-reference/jobs/remove-job-target-companies"},{"title":"List job team member roles","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/jobs/team-member-roles","href":"/api-reference/jobs/list-job-team-member-roles"},{"title":"Get job pack retainer split","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/jobs/{id}/pack-retainer-split","href":"/api-reference/jobs/get-job-pack-retainer-split"},{"title":"Set job pack retainer split","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json put /v1/jobs/{id}/pack-retainer-split","href":"/api-reference/jobs/set-job-pack-retainer-split"},{"title":"List job referral partners","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/jobs/{id}/referral-partners","href":"/api-reference/jobs/list-job-referral-partners"},{"title":"Add job referral partner","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/jobs/{id}/referral-partners","href":"/api-reference/jobs/add-job-referral-partner"},{"title":"Remove job referral partner","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/jobs/{id}/referral-partners/{client_contact_id}","href":"/api-reference/jobs/remove-job-referral-partner"},{"title":"Update job referral partner","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/jobs/{id}/referral-partners/{client_contact_id}","href":"/api-reference/jobs/update-job-referral-partner"},{"title":"List job statuses","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/jobs/statuses","href":"/api-reference/jobs/list-job-statuses"},{"title":"List pipeline stages","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/jobs/pipeline-stages","href":"/api-reference/jobs/list-pipeline-stages"}]},{"group":"Lists","pages":[{"title":"Search lists","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/lists/search","href":"/api-reference/lists/search-lists"},{"title":"Get list by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/lists/{id}","href":"/api-reference/lists/get-list-by-id"},{"title":"Create list","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/lists","href":"/api-reference/lists/create-list"},{"title":"Add list items","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/lists/{id}/items","href":"/api-reference/lists/add-list-items"},{"title":"Remove list items","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/lists/{id}/items","href":"/api-reference/lists/remove-list-items"}]},{"group":"Meeting Recordings","pages":[{"title":"List meeting recordings","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/meeting-recordings","href":"/api-reference/meeting-recordings/list-meeting-recordings"},{"title":"Get meeting recording by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/meeting-recordings/{id}","href":"/api-reference/meeting-recordings/get-meeting-recording-by-id"},{"title":"List meeting recording share links","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/meeting-recordings/{id}/share-links","href":"/api-reference/meeting-recordings/list-meeting-recording-share-links"},{"title":"Create meeting recording share link","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/meeting-recordings/{id}/share-links","href":"/api-reference/meeting-recordings/create-meeting-recording-share-link"},{"title":"Delete meeting recording share link","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/meeting-recordings/{id}/share-links/{share_link_id}","href":"/api-reference/meeting-recordings/delete-meeting-recording-share-link"},{"title":"Update meeting recording share link","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/meeting-recordings/{id}/share-links/{share_link_id}","href":"/api-reference/meeting-recordings/update-meeting-recording-share-link"}]},{"group":"Person Activities","pages":[{"title":"List person activity types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/person-activities/types","href":"/api-reference/person-activities/list-person-activity-types"},{"title":"Create person activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/person-activities","href":"/api-reference/person-activities/create-person-activity"},{"title":"Get person activity by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/person-activities/{id}","href":"/api-reference/person-activities/get-person-activity-by-id"},{"title":"Delete person activity by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/person-activities/{id}","href":"/api-reference/person-activities/delete-person-activity-by-id"},{"title":"Update person activity by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/person-activities/{id}","href":"/api-reference/person-activities/update-person-activity-by-id"}]},{"group":"Persons","pages":[{"title":"List person reference types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/persons/reference-types","href":"/api-reference/persons/list-person-reference-types"},{"title":"Create person reference","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons/{id}/references","href":"/api-reference/persons/create-person-reference"},{"title":"Delete person reference","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/persons/{id}/references/{reference_id}","href":"/api-reference/persons/delete-person-reference"},{"title":"Update person reference","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/persons/{id}/references/{reference_id}","href":"/api-reference/persons/update-person-reference"},{"title":"List persons (deprecated)","deprecated":true,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/persons","href":"/api-reference/persons/list-persons-deprecated"},{"title":"Create person","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons","href":"/api-reference/persons/create-person"},{"title":"Advanced person search","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons/search","href":"/api-reference/persons/advanced-person-search"},{"title":"Get person by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/persons/{id}","href":"/api-reference/persons/get-person-by-id"},{"title":"Update person","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/persons/{id}","href":"/api-reference/persons/update-person"},{"title":"Create person compensation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons/{id}/compensations","href":"/api-reference/persons/create-person-compensation"},{"title":"Delete person compensation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/persons/{id}/compensations/{compensation_id}","href":"/api-reference/persons/delete-person-compensation"},{"title":"Update person compensation","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/persons/{id}/compensations/{compensation_id}","href":"/api-reference/persons/update-person-compensation"},{"title":"Get unified person activities","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/persons/{id}/activities","href":"/api-reference/persons/get-unified-person-activities"},{"title":"Get person documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/persons/{id}/documents","href":"/api-reference/persons/get-person-documents"},{"title":"Upload person document","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons/{id}/documents","href":"/api-reference/persons/upload-person-document"},{"title":"List person document types","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/persons/document-types","href":"/api-reference/persons/list-person-document-types"},{"title":"Set preferred email (bulk)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons/preferred-email","href":"/api-reference/persons/set-preferred-email-bulk"},{"title":"Set preferred phone (bulk)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons/preferred-phone","href":"/api-reference/persons/set-preferred-phone-bulk"},{"title":"Mark emails as bounced (bulk)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons/email-bounced","href":"/api-reference/persons/mark-emails-as-bounced-bulk"},{"title":"Remove emails (bulk)","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons/emails/delete","href":"/api-reference/persons/remove-emails-bulk"},{"title":"Set preferred email","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons/{id}/preferred-email","href":"/api-reference/persons/set-preferred-email"},{"title":"Set preferred phone","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons/{id}/preferred-phone","href":"/api-reference/persons/set-preferred-phone"},{"title":"Enrich person contact details","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/persons/{id}/enrich","href":"/api-reference/persons/enrich-person-contact-details"}]},{"group":"Scorecards","pages":[{"title":"Search scorecard templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/scorecard-templates/search","href":"/api-reference/scorecards/search-scorecard-templates"},{"title":"Get scorecard template by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/scorecard-templates/{id}","href":"/api-reference/scorecards/get-scorecard-template-by-id"},{"title":"Archive scorecard template","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/scorecard-templates/{id}","href":"/api-reference/scorecards/archive-scorecard-template"},{"title":"Update scorecard template","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/scorecard-templates/{id}","href":"/api-reference/scorecards/update-scorecard-template"},{"title":"Create scorecard template","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/scorecard-templates","href":"/api-reference/scorecards/create-scorecard-template"},{"title":"Search scorecards","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/scorecards/search","href":"/api-reference/scorecards/search-scorecards"},{"title":"Get scorecard by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/scorecards/{id}","href":"/api-reference/scorecards/get-scorecard-by-id"},{"title":"Delete scorecard","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/scorecards/{id}","href":"/api-reference/scorecards/delete-scorecard"},{"title":"Update scorecard","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/scorecards/{id}","href":"/api-reference/scorecards/update-scorecard"},{"title":"Create scorecard","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/scorecards","href":"/api-reference/scorecards/create-scorecard"}]},{"group":"Tasks","pages":[{"title":"Search tasks","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/tasks/search","href":"/api-reference/tasks/search-tasks"},{"title":"Get task by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/tasks/{id}","href":"/api-reference/tasks/get-task-by-id"},{"title":"Delete task","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json delete /v1/tasks/{id}","href":"/api-reference/tasks/delete-task"},{"title":"Update task","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/tasks/{id}","href":"/api-reference/tasks/update-task"},{"title":"Create task","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json post /v1/tasks","href":"/api-reference/tasks/create-task"}]},{"group":"Team Capacity","pages":[{"title":"Get the Team Capacity report","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/team-capacity","href":"/api-reference/team-capacity/get-the-team-capacity-report"},{"title":"Update Team Capacity settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json patch /v1/team-capacity/settings","href":"/api-reference/team-capacity/update-team-capacity-settings"}]},{"group":"Team Members","pages":[{"title":"List team members","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/team-members","href":"/api-reference/team-members/list-team-members"},{"title":"Get team member by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/team-members/{id}","href":"/api-reference/team-members/get-team-member-by-id"}]},{"group":"Webhooks","pages":[{"title":"Get webhook management portal URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi-v1.json get /v1/webhooks/portal","href":"/api-reference/webhooks/get-webhook-management-portal-url"}]}]},{"version":"v0 (Deprecated)","pages":[{"title":"v0 (Deprecated)","href":"/api-reference/introduction"}]}]},{"tab":"Zapier API Reference","hidden":true,"pages":[{"title":"Zapier API Reference","href":"/api-reference/zapier-introduction"}]}]},"basePath":"","title":"Search deals - Stardex Help Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}