Affinity: V2 Opportunities Get

List deals (opportunities) in your Affinity CRM.

Tool ID: affinity_v2_opportunities_get

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(
  'affinity_v2_opportunities_get',
  {
    "cursor": "cursor_123",
    "limit": 100,
    "ids": [
      123
    ]
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute affinity_v2_opportunities_get --input '{
  "cursor": "cursor_123",
  "limit": 100,
  "ids": [
    123
  ]
}' --json

Example response

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

{
  "data": {
    "data": [
      {
        "id": 123,
        "name": "Example",
        "listId": 123,
        "listName": "Example",
        "isRestricted": true,
        "isRedacted": true
      }
    ],
    "pagination": {
      "prevUrl": "https://example.com",
      "nextUrl": "https://example.com"
    }
  }
}

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

Input reference

Paginate through Opportunities in Affinity. Returns basic information but not field data on each Opportunity. To access field data on Opportunities, use the /lists/{list_id}/list-entries or the /v2/lists/{list_id}/saved-views/{view_id}/list-entries GET endpoint. Requires the “Export data from Lists” permission.

Name	Type	Required	Default	Details
`payload.cursor`	`string`	No	—	Cursor for the next or previous page
`payload.limit`	`integer`	No	`100`	Number of items to include in the page Format: `int32`. Minimum: 1. Maximum: 100.
`payload.ids`	`array`	No	—	Opportunity IDs

Output reference

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	—
`result.data.data`	`array`	Yes	—	Maximum items: 100.
`result.data.data[].id`	`integer`	Yes	—	Format: `int64`. Minimum: 1. Maximum: 9007199254740991.
`result.data.data[].name`	`string`	Yes	—	—
`result.data.data[].listId`	`integer`	Yes	—	Format: `int64`. Minimum: 1. Maximum: 9007199254740991.
`result.data.data[].listName`	`string`	Yes	—	—
`result.data.data[].isRestricted`	`boolean`	Yes	—	—
`result.data.data[].isRedacted`	`boolean`	Yes	—	—
`result.data.pagination`	`object`	Yes	—	—
`result.data.pagination.prevUrl`	`string \| null`	No	—	Format: `uri`.
`result.data.pagination.nextUrl`	`string \| null`	No	—	Format: `uri`.
`result.meta`	`object`	No	—	—

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