Affinity: V2 Companies Fields Get

Get metadata on Company Fields.

Tool ID: affinity_v2_companies_fields_get

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'affinity_v2_companies_fields_get',
  {
    "cursor": "cursor_123",
    "limit": 100,
    "filter": "example"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute affinity_v2_companies_fields_get --input '{
  "cursor": "cursor_123",
  "limit": 100,
  "filter": "example"
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "data": [
      {
        "id": "id_123",
        "name": "Example",
        "type": "enriched",
        "enrichmentSource": "affinity-data",
        "valueType": "person",
        "createdAt": "2026-01-15T12:00:00Z"
      }
    ],
    "pagination": {
      "prevUrl": "https://example.com",
      "nextUrl": "https://example.com"
    }
  }
}

Use deepline tools get affinity_v2_companies_fields_get --json for the latest machine-readable contract.

Input reference

Returns metadata on non-list-specific Company Fields. Use the returned Field IDs to request field data from the GET /v2/companies and GET /v2/companies/{id} endpoints. You can filter Fields using the filter query parameter. The filter parameter is a string that you can specify conditions based on the following properties. | Property Name | Type | Allowed Operators | Examples | |---|---|---|---| | name | text | =, =~ | name="Location", name=~loc | Use the includes query parameter to add optional metadata to each Field in the response. Pass includes more than once to request multiple values. | Value | Adds to each Field | |---|---| | filterability | How the field can be used in filter expressions on GET /v2/companies and POST /v2/companies/search | | sortability | How the field can be used in sort expressions on those endpoints | See the live schema below for the complete notes.

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.filter`	`string`	No	—	Filter options
`payload.includes`	`array`	No	—	Additional properties to include in the response Items must be unique.

Output reference

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	—
`result.data.data`	`array`	Yes	—	Maximum items: 100.
`result.data.data[].id`	`string`	Yes	—	—
`result.data.data[].name`	`string`	Yes	—	—
`result.data.data[].type`	`"enriched" \| "global" \| "list" \| "relationship-intelligence"`	Yes	—	Allowed: `enriched`, `global`, `list`, `relationship-intelligence`.
`result.data.data[].enrichmentSource`	`"affinity-data" \| "dealroom" \| "eventbrite" \| "mailchimp" \| null`	Yes	—	Allowed: `affinity-data`, `dealroom`, `eventbrite`, `mailchimp`, `null`.
`result.data.data[].valueType`	`"person" \| "person-multi" \| "company" \| "company-multi" \| "filterable-text" \| "filterable-text-multi" \| "number" \| "number-multi" \| "datetime" \| "location" \| "location-multi" \| "text" \| "ranked-dropdown" \| "dropdown" \| "dropdown-multi" \| "formula-number" \| "interaction"`	Yes	—	Allowed: `person`, `person-multi`, `company`, `company-multi`, `filterable-text`, `filterable-text-multi`, `number`, `number-multi`, `datetime`, `location`, `location-multi`, `text`, `ranked-dropdown`, `dropdown`, `dropdown-multi`, `formula-number`, `interaction`.
`result.data.data[].createdAt`	`string \| null`	Yes	—	Format: `date-time`.
`result.data.data[].filterability`	`record`	No	—	—
`result.data.data[].sortability`	`record`	No	—	—
`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.

Getting Started

GTM is code

Features

Deepline SDK beta

Integrations

API Reference

Affinity: V2 Companies Fields Get

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​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