Affinity: V2 Companies Search Post

Search companies in your Affinity CRM by keyword or field filters, with sorting.

Tool ID: affinity_v2_companies_search_post

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_companies_search_post',
  {
    "fieldIds": [
      "field_123"
    ],
    "fieldTypes": [
      "enriched"
    ],
    "cursor": "cursor_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute affinity_v2_companies_search_post --input '{
  "fieldIds": [
    "field_123"
  ],
  "fieldTypes": [
    "enriched"
  ],
  "cursor": "cursor_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",
        "domain": "example.com",
        "domains": [
          "example.com"
        ],
        "isGlobal": true
      }
    ],
    "pagination": {
      "prevUrl": "https://example.com",
      "nextUrl": "https://example.com"
    }
  }
}

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

Input reference

Search criteria for filtering, sorting, and searching. All fields are optional — omitting the body returns all results with default pagination.

Name	Type	Required	Default	Details
`payload.fieldIds`	`array`	No	—	Specific field IDs for which to return field data on each Company. Cannot be used together with `fieldTypes`. Use one or the other. Use `GET /v2/companies/fields` to discover available field IDs.
`payload.fieldTypes`	`array`	No	—	A category of fields for which to return field data on each Company. Cannot be used together with `fieldIds`. Use one or the other.
`payload.cursor`	`string`	No	—	Cursor for the next or previous page.
`payload.limit`	`integer`	No	`100`	Maximum number of Companies to return per page. Format: `int32`. Minimum: 1. Maximum: 100.
`payload.totalCount`	`boolean`	No	`false`	When `true`, includes the total count of matching Companies in the pagination response. Adds additional query cost. Use only when needed.
`payload.filters`	`object`	No	—	A logical group of filters combined with AND or OR. Groups can be nested to build complex filter trees. Each group may contain up to 50 items. Items can be individual filters or nested filter groups.
`payload.sorts`	`array`	No	—	One or more sort criteria, applied in order. Supports up to 5 sort items. Use the relevant fields endpoint for your resource type to discover sortable fields. Minimum items: 1. Maximum items: 5.
`payload.search`	`object`	No	—	A single keyword or phrase to match against field values. Multiple terms or comma-separated values are not supported. Use a single search string.

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[].domain`	`string \| null`	Yes	—	Format: `hostname`.
`result.data.data[].domains`	`array`	Yes	—	—
`result.data.data[].isGlobal`	`boolean`	Yes	—	—
`result.data.data[].fields`	`array`	No	—	—
`result.data.data[].fields[].id`	`string`	Yes	—	—
`result.data.data[].fields[].name`	`string`	Yes	—	—
`result.data.data[].fields[].type`	`"enriched" \| "global" \| "list" \| "relationship-intelligence" \| "hidden"`	Yes	—	Allowed: `enriched`, `global`, `list`, `relationship-intelligence`, `hidden`.
`result.data.data[].fields[].enrichmentSource`	`"affinity-data" \| "dealroom" \| "eventbrite" \| "mailchimp" \| null`	Yes	—	Allowed: `affinity-data`, `dealroom`, `eventbrite`, `mailchimp`, `null`.
`result.data.data[].fields[].value`	`object`	Yes	—	—
`result.data.data[].fields[].value.type`	`"company-multi"`	Yes	—	—
`result.data.data[].fields[].value.data`	`array \| null`	Yes	—	—
`result.data.data[].fields[].value.data[].id`	`integer`	Yes	—	—
`result.data.data[].fields[].value.data[].name`	`string`	Yes	—	—
`result.data.data[].fields[].value.data[].domain`	`string \| null`	Yes	—	—
`result.data.data[].fields[].value.totalCount`	`integer`	No	—	Format: `int32`. Minimum: 0. Maximum: 2147483647.
`result.data.data[].fields[].value.data[].dropdownOptionId`	`integer`	Yes	—	—
`result.data.data[].fields[].value.data[].text`	`string`	Yes	—	—
`result.data.data[].fields[].value.data[].streetAddress`	`string \| null`	Yes	—	—
`result.data.data[].fields[].value.data[].city`	`string \| null`	Yes	—	—
`result.data.data[].fields[].value.data[].state`	`string \| null`	Yes	—	—
`result.data.data[].fields[].value.data[].country`	`string \| null`	Yes	—	—
`result.data.data[].fields[].value.data[].continent`	`string \| null`	Yes	—	—
`result.data.data[].fields[].value.data[].firstName`	`string \| null`	Yes	—	—
`result.data.data[].fields[].value.data[].lastName`	`string \| null`	Yes	—	—
`result.data.data[].fields[].value.data[].primaryEmailAddress`	`string \| null`	Yes	—	—
`result.data.data[].fields[].value.data[].type`	`"internal" \| "collaborator" \| "external"`	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	—	—

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