Outreach: Get Prospect

Get one Outreach prospect, with their contact details, stage, and owner, by ID.

Tool ID: outreach_get_prospect

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.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'outreach_get_prospect',
  {
    "id": 123
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute outreach_get_prospect --input '{
  "id": 123
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "data": {
      "attributes": {
        "addedAt": "2026-01-15T12:00:00Z",
        "addressCity": "San Francisco",
        "addressCountry": "US"
      },
      "id": 123,
      "relationships": {
        "account": {
          "data": {},
          "links": {}
        },
        "activeSequenceStates": {
          "links": {}
        },
        "assignedTeams": {
          "links": {}
        }
      }
    }
  }
}

Use deepline describe outreach_get_prospect --json for the latest machine-readable contract.

Input reference

Get a Prospect by ID

Name	Type	Required	Default	Details
`payload.id`	`integer`	Yes	—	—
`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.provideAuthorizationMeta`	`boolean`	No	—	Request resource authorization metadata.
`payload.provideDataConnections`	`boolean`	No	—	Request resource data-connection metadata.
`payload.actionParams_withUnnamedAccount`	`boolean`	No	—	Send actionParams[withUnnamedAccount] to control unnamed account relationships.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.data`	`object`	No	—	—
`result.data.data.attributes`	`object`	No	—	A descriptor of a person.
`result.data.data.attributes.addedAt`	`string \| null`	No	—	The date and time the prospect was added to any system. Format: `date-time`.
`result.data.data.attributes.addressCity`	`string \| null`	No	—	The prospect’s city (e.g. “Seattle”). Maximum length: 255.
`result.data.data.attributes.addressCountry`	`string \| null`	No	—	The prospect’s country (e.g. “USA”). Maximum length: 255.
`result.data.data.attributes.addressState`	`string \| null`	No	—	The prospect’s state (e.g. “Washington”). Maximum length: 255.
`result.data.data.attributes.addressStreet`	`string \| null`	No	—	The prospect’s street address (e.g. “1441 N 34th St”). Maximum length: 255.
`result.data.data.attributes.addressStreet2`	`string \| null`	No	—	The prospect’s second street address, if applicable. Maximum length: 255.
`result.data.data.attributes.addressZip`	`string \| null`	No	—	The prospect’s postal code (e.g. “98103”). Maximum length: 255.
`result.data.data.attributes.angelListUrl`	`string \| null`	No	—	The prospect’s AngelList URL. Maximum length: 255.
`result.data.data.attributes.availableAt`	`string \| null`	No	—	The date and time the prospect is available to contact again. Format: `date-time`.
`result.data.data.attributes.callOptedOut`	`boolean \| null`	No	—	Whether the prospect is opted out of calling, or opted out in general if granular opt-out is not enabled.
`result.data.data.attributes.callsOptStatus`	`string \| null`	No	—	A string (“opted_in”, “opted_out”, “null”) that represents whether a prospect has opted into or out of calls. Maximum length: 255.
`result.data.data.attributes.callsOptedAt`	`string \| null`	No	—	The date and time the prospect opted in/out of calls. Format: `date-time`.
`result.data.data.attributes.campaignName`	`string \| null`	No	—	The name of the campaign the prospect is associated with. Maximum length: 255.
`result.data.data.attributes.clickCount`	`integer \| null`	No	—	The number of clicks the prospect has made since the last touch point.
`result.data.data.attributes.company`	`string \| null`	No	—	The name of the company the prospect works at. If associated with an account, this is the name of the account. (e.g. Acme International).
`result.data.data.attributes.contactHistogram`	`array \| null`	No	—	The last 12 months of email contact history with the prospect, with the current month being the last element. The format for each month is ‘[inboundCount, outboundCount]’. Note: Retrieving this field will slow down the queries. Unless this field is required, it is best to filter it out. See Specify Sparse Fieldsets for examples
`result.data.data.attributes.createdAt`	`string \| null`	No	—	The date and time the prospect was created. Format: `date-time`.
`result.data.data.attributes.custom1`	`string \| null`	No	—	The value of the prospect’s first custom field. Maximum length: 32000.
`result.data.data.attributes.custom2`	`string \| null`	No	—	The value of the prospect’s second custom field. Maximum length: 32000.
`result.data.data.attributes.custom3`	`string \| null`	No	—	The value of the prospect’s third custom field. Maximum length: 32000.
`result.data.data.attributes.custom4`	`string \| null`	No	—	The value of the prospect’s fourth custom field. Maximum length: 32000.
`result.data.data.attributes.custom5`	`string \| null`	No	—	The value of the prospect’s fifth custom field. Maximum length: 32000.
`result.data.data.attributes.custom6`	`string \| null`	No	—	The value of the prospect’s sixth custom field. Maximum length: 32000.
`result.data.data.attributes.custom7`	`string \| null`	No	—	The value of the prospect’s seventh custom field. Maximum length: 32000.
`result.data.data.attributes.custom8`	`string \| null`	No	—	The value of the prospect’s eight custom field. Maximum length: 32000.
`result.data.data.attributes.custom9`	`string \| null`	No	—	The value of the prospect’s ninth custom field. Maximum length: 32000.
`result.data.data.attributes.custom10`	`string \| null`	No	—	The value of the prospect’s 10th custom field. Maximum length: 32000.
`result.data.data.attributes.custom11`	`string \| null`	No	—	The value of the prospect’s 11th custom field. Maximum length: 32000.
`result.data.data.attributes.custom12`	`string \| null`	No	—	The value of the prospect’s 12th custom field. Maximum length: 32000.
`result.data.data.attributes.custom13`	`string \| null`	No	—	The value of the prospect’s 13th custom field. Maximum length: 32000.
`result.data.data.attributes.custom14`	`string \| null`	No	—	The value of the prospect’s 14th custom field. Maximum length: 32000.
`result.data.data.attributes.custom15`	`string \| null`	No	—	The value of the prospect’s 15th custom field. Maximum length: 32000.
`result.data.data.attributes.custom16`	`string \| null`	No	—	The value of the prospect’s 16th custom field. Maximum length: 32000.
`result.data.data.attributes.custom17`	`string \| null`	No	—	The value of the prospect’s 17th custom field. Maximum length: 32000.
`result.data.data.attributes.custom18`	`string \| null`	No	—	The value of the prospect’s 18th custom field. Maximum length: 32000.
`result.data.data.attributes.custom19`	`string \| null`	No	—	The value of the prospect’s 19th custom field. Maximum length: 32000.
`result.data.data.attributes.custom20`	`string \| null`	No	—	The value of the prospect’s 20th custom field. Maximum length: 32000.
`result.data.data.attributes.custom21`	`string \| null`	No	—	The value of the prospect’s 21st custom field. Maximum length: 32000.
`result.data.data.attributes.custom22`	`string \| null`	No	—	The value of the prospect’s 22nd custom field. Maximum length: 32000.
`result.data.data.attributes.custom23`	`string \| null`	No	—	The value of the prospect’s 23rd custom field. Maximum length: 32000.
`result.data.data.attributes.custom24`	`string \| null`	No	—	The value of the prospect’s 24th custom field. Maximum length: 32000.
`result.data.data.attributes.custom25`	`string \| null`	No	—	The value of the prospect’s 25th custom field. Maximum length: 32000.
`result.data.data.attributes.custom26`	`string \| null`	No	—	The value of the prospect’s 26th custom field. Maximum length: 32000.
`result.data.data.attributes.custom27`	`string \| null`	No	—	The value of the prospect’s 27th custom field. Maximum length: 32000.
`result.data.data.attributes.custom28`	`string \| null`	No	—	The value of the prospect’s 28th custom field. Maximum length: 32000.
`result.data.data.attributes.custom29`	`string \| null`	No	—	The value of the prospect’s 29th custom field. Maximum length: 32000.
`result.data.data.attributes.custom30`	`string \| null`	No	—	The value of the prospect’s 30th custom field. Maximum length: 32000.

The table shows the first 50 fields. Use the live contract below for every field.

This output schema is too large for an inline display. Read the complete live contract with deepline describe outreach_get_prospect --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.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation