> ## Documentation Index > Fetch the complete documentation index at: https://deepline.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Outreach: List Opportunities > List Outreach opportunities, filtered by stage, owner, account, or close date. Includes SDK V2 examples, input constraints, response fields, and Deepline cost. List Outreach opportunities, filtered by stage, owner, account, or close date. > [!NOTE] > > Tool ID: `outreach_list_opportunities` ## Run this action Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing. ```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}} import { Deepline } from 'deepline'; const deepline = await Deepline.connect(); const result = await deepline.tools.execute( 'outreach_list_opportunities', { "newFilterSyntax": true, "page_size": 123, "page_after": "cursor_123" }, ); console.log(result.toolResponse.raw); ``` ### CLI ```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}} deepline tools execute outreach_list_opportunities --input '{ "newFilterSyntax": true, "page_size": 123, "page_after": "cursor_123" }' --json ``` ## Example response The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response. ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}} { "data": { "data": [ { "attributes": { "amount": 1, "amountPrecise": "example", "closeDate": "2026-01-15T12:00:00Z" }, "id": 123, "relationships": { "account": {}, "assignedTeams": {}, "assignedUsers": {} } } ] } } ``` Use `deepline describe outreach_list_opportunities --json` for the latest machine-readable contract. ## Input reference Get a Collection of Opportunities | Name | Type | Required | Default | Details | | - | - | - | - | - | | `payload.newFilterSyntax` | `boolean` | No | — | Use Outreach array/range filter syntax for literal commas and ranges. | | `payload.page_size` | `integer` | No | — | Cursor page size sent as page\[size]. Minimum: 1. Maximum: 1000. | | `payload.page_after` | `string` | No | — | Cursor returned by the previous page. | | `payload.page_before` | `string` | No | — | Cursor returned by the next page. | | `payload.page_limit` | `integer` | No | — | Deprecated offset-pagination limit sent as page\[limit]. Prefer page\_size. Minimum: 1. Maximum: 1000. | | `payload.page_offset` | `integer` | No | — | Deprecated offset-pagination offset sent as page\[offset]. Prefer cursors. Minimum: 0. Maximum: 10000. | | `payload.count` | `boolean` | No | — | Request Outreach total-count metadata. false is faster for pagination. | | `payload.sort` | `string` | No | — | Comma-separated sortable fields. prefix a field with - for descending order. | | `payload.include` | `string` | No | — | Comma-separated related resources to include. | | `payload.fields` | `object` | No | — | Sparse fieldsets keyed by JSON:API resource type, sent as fields\[resource]. | | `payload.filters` | `object` | No | — | Endpoint-specific Outreach filters. Relationship attributes use keys such as owner\[id]. |
Show raw input schema ### Input JSON Schema ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}} { "type": "object", "description": "Get a Collection of Opportunities", "properties": { "newFilterSyntax": { "type": "boolean", "description": "Use Outreach array/range filter syntax for literal commas and ranges." }, "page_size": { "type": "integer", "description": "Cursor page size sent as page[size].", "minimum": 1, "maximum": 1000 }, "page_after": { "type": "string", "description": "Cursor returned by the previous page." }, "page_before": { "type": "string", "description": "Cursor returned by the next page." }, "page_limit": { "type": "integer", "description": "Deprecated offset-pagination limit sent as page[limit]. Prefer page_size.", "minimum": 1, "maximum": 1000 }, "page_offset": { "type": "integer", "description": "Deprecated offset-pagination offset sent as page[offset]. Prefer cursors.", "minimum": 0, "maximum": 10000 }, "count": { "type": "boolean", "description": "Request Outreach total-count metadata; false is faster for pagination." }, "sort": { "type": "string", "description": "Comma-separated sortable fields; prefix a field with - for descending order." }, "include": { "type": "string", "description": "Comma-separated related resources to include." }, "fields": { "type": "object", "description": "Sparse fieldsets keyed by JSON:API resource type, sent as fields[resource].", "properties": { "account": { "type": "string" }, "accountNote": { "type": "string" }, "auditLog": { "type": "string" }, "batch": { "type": "string" }, "batchItem": { "type": "string" }, "call": { "type": "string" }, "callDisposition": { "type": "string" }, "callPurpose": { "type": "string" }, "complianceRequest": { "type": "string" }, "contentCategory": { "type": "string" }, "contentCategoryMembership": { "type": "string" }, "contentCategoryOwnership": { "type": "string" }, "customDuty": { "type": "string" }, "duty": { "type": "string" }, "emailAddress": { "type": "string" }, "event": { "type": "string" }, "favorite": { "type": "string" }, "import": { "type": "string" }, "kaiaRecording": { "type": "string" }, "kaiaVoiceImport": { "type": "string" }, "mailAlias": { "type": "string" }, "mailbox": { "type": "string" }, "mailing": { "type": "string" }, "opportunity": { "type": "string" }, "opportunityProspectRole": { "type": "string" }, "opportunityStage": { "type": "string" }, "orgSetting": { "type": "string" }, "persona": { "type": "string" }, "phoneNumber": { "type": "string" }, "product": { "type": "string" }, "profile": { "type": "string" }, "prospect": { "type": "string" }, "prospectNote": { "type": "string" }, "purchase": { "type": "string" }, "recipient": { "type": "string" }, "role": { "type": "string" }, "ruleset": { "type": "string" }, "sequence": { "type": "string" }, "sequenceState": { "type": "string" }, "sequenceStep": { "type": "string" }, "sequenceTemplate": { "type": "string" }, "snippet": { "type": "string" }, "stage": { "type": "string" }, "task": { "type": "string" }, "taskDisposition": { "type": "string" }, "taskPriority": { "type": "string" }, "taskPurpose": { "type": "string" }, "team": { "type": "string" }, "template": { "type": "string" }, "user": { "type": "string" }, "webhook": { "type": "string" } }, "additionalProperties": false }, "filters": { "type": "object", "description": "Endpoint-specific Outreach filters. Relationship attributes use keys such as owner[id].", "additionalProperties": false } }, "required": [], "additionalProperties": false } ```
## Output reference Standard tool result payload. | Name | Type | Required | Default | Details | | - | - | - | - | - | | `result.data` | `object` | Yes | — | Provider response payload. | | `result.data.data` | `array` | No | — | — | | `result.data.data[].attributes` | `object` | No | — | An opportunity for a sale or pending deal. Requires the Opportunities SKU to be enabled in order to have access. Please contact support for more assistance. | | `result.data.data[].attributes.amount` | `integer \| null` | No | — | The amount the opportunity is worth. | | `result.data.data[].attributes.amountPrecise` | `string \| null` | No | — | The precise amount that the opportunity is worth. Maximum length: 15. | | `result.data.data[].attributes.closeDate` | `string \| null` | No | — | The date the opportunity is expected to close. Format: `date-time`. | | `result.data.data[].attributes.createdAt` | `string \| null` | No | — | The date the opportunity was created. Format: `date-time`. | | `result.data.data[].attributes.currencyType` | `string \| null` | No | — | The ISO code of the currency this opportunity is in. Maximum length: 255. | | `result.data.data[].attributes.custom1` | `string \| null` | No | — | The value of the opportunity's first custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom2` | `string \| null` | No | — | The value of the opportunity's second custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom3` | `string \| null` | No | — | The value of the opportunity's third custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom4` | `string \| null` | No | — | The value of the opportunity's fourth custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom5` | `string \| null` | No | — | The value of the opportunity's fifth custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom6` | `string \| null` | No | — | The value of the opportunity's sixth custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom7` | `string \| null` | No | — | The value of the opportunity's seventh custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom8` | `string \| null` | No | — | The value of the opportunity's eighth custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom9` | `string \| null` | No | — | The value of the opportunity's ninth custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom10` | `string \| null` | No | — | The value of the opportunity's 10th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom11` | `string \| null` | No | — | The value of the opportunity's 11th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom12` | `string \| null` | No | — | The value of the opportunity's 12th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom13` | `string \| null` | No | — | The value of the opportunity's 13th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom14` | `string \| null` | No | — | The value of the opportunity's 14th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom15` | `string \| null` | No | — | The value of the opportunity's 15th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom16` | `string \| null` | No | — | The value of the opportunity's 16th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom17` | `string \| null` | No | — | The value of the opportunity's 17th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom18` | `string \| null` | No | — | The value of the opportunity's 18th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom19` | `string \| null` | No | — | The value of the opportunity's 19th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom20` | `string \| null` | No | — | The value of the opportunity's 20th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom21` | `string \| null` | No | — | The value of the opportunity's 21st custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom22` | `string \| null` | No | — | The value of the opportunity's 22nd custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom23` | `string \| null` | No | — | The value of the opportunity's 23rd custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom24` | `string \| null` | No | — | The value of the opportunity's 24th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom25` | `string \| null` | No | — | The value of the opportunity's 25th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom26` | `string \| null` | No | — | The value of the opportunity's 26th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom27` | `string \| null` | No | — | The value of the opportunity's 27th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom28` | `string \| null` | No | — | The value of the opportunity's 28th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom29` | `string \| null` | No | — | The value of the opportunity's 29th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom30` | `string \| null` | No | — | The value of the opportunity's 30th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom31` | `string \| null` | No | — | The value of the opportunity's 31st custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom32` | `string \| null` | No | — | The value of the opportunity's 32nd custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom33` | `string \| null` | No | — | The value of the opportunity's 33rd custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom34` | `string \| null` | No | — | The value of the opportunity's 34th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom35` | `string \| null` | No | — | The value of the opportunity's 35th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom36` | `string \| null` | No | — | The value of the opportunity's 36th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom37` | `string \| null` | No | — | The value of the opportunity's 37th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom38` | `string \| null` | No | — | The value of the opportunity's 38th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom39` | `string \| null` | No | — | The value of the opportunity's 39th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom40` | `string \| null` | No | — | The value of the opportunity's 40th custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom41` | `string \| null` | No | — | The value of the opportunity's 41st custom field. Maximum length: 32000. | | `result.data.data[].attributes.custom42` | `string \| null` | No | — | The value of the opportunity's 42nd custom field. Maximum length: 32000. | The table shows the first 50 fields. Use the live contract below for every field. > [!NOTE] > > This output schema is too large for an inline display. Read the complete live contract with `deepline describe outreach_list_opportunities --json`. ## Deepline cost * Pricing model: `fixed` (per call). * Estimated Deepline credits: `0` per pricing unit. * Provider-native pricing may still exist outside Deepline credit billing. ## Related documentation * [Outreach provider guide](https://deepline.com/docs/providers/outreach/guide.md) * [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md) * [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md) * [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.