Affinity: V2 Lists Get

List the Affinity lists you can access, with name, owner and privacy settings.

Tool ID: affinity_v2_lists_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_lists_get',
  {
    "term": "software companies hiring engineers",
    "cursor": "cursor_123",
    "limit": 100
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute affinity_v2_lists_get --input '{
  "term": "software companies hiring engineers",
  "cursor": "cursor_123",
  "limit": 100
}' --json

Example response

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

{
  "data": {
    "data": [
      {
        "id": 123,
        "name": "Example",
        "creatorId": 123,
        "ownerId": 123,
        "isPublic": true,
        "type": "company",
        "createdAt": "2026-01-15T12:00:00Z"
      }
    ],
    "pagination": {
      "prevUrl": "https://example.com",
      "nextUrl": "https://example.com"
    }
  }
}

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

Input reference

Paginate through all Lists in your organization that you have access to view. Returns basic information about each List, including name, owner, and privacy settings.

Name	Type	Required	Default	Details
`payload.term`	`string`	No	—	Case-insensitive substring match on List name.
`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.

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[].creatorId`	`integer`	Yes	—	Format: `int64`. Minimum: 1. Maximum: 9007199254740991.
`result.data.data[].ownerId`	`integer`	Yes	—	Format: `int64`. Minimum: 1. Maximum: 9007199254740991.
`result.data.data[].isPublic`	`boolean`	Yes	—	—
`result.data.data[].type`	`"company" \| "opportunity" \| "person"`	Yes	—	Allowed: `company`, `opportunity`, `person`.
`result.data.data[].createdAt`	`string`	Yes	—	Format: `date-time`.
`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