> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Affinity: V2 Companies Fields Get

> List the company fields in Affinity, with the field IDs used to read company data. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

List the company fields in Affinity, with the field IDs used to read company data.

> [!NOTE]
>
> Tool ID: `affinity_v2_companies_fields_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.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute affinity_v2_companies_fields_get --input '{
  "cursor": "cursor_123",
  "limit": 100,
  "filter": "example"
}' --json
```

## Example response

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

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "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 describe 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. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "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 | Example: `GET /v2/companies/fields?includes=filterability&includes=sortability`",
    "properties": {
      "cursor": {
        "type": "string",
        "description": "Cursor for the next or previous page"
      },
      "limit": {
        "type": "integer",
        "description": "Number of items to include in the page",
        "default": 100,
        "minimum": 1,
        "maximum": 100,
        "format": "int32"
      },
      "filter": {
        "type": "string",
        "description": "Filter options"
      },
      "includes": {
        "type": "array",
        "description": "Additional properties to include in the response",
        "uniqueItems": true,
        "items": {
          "type": "string",
          "enum": [
            "filterability",
            "sortability"
          ]
        }
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## 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 | — | — |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "properties": {
      "data": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "maxItems": 100,
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "enriched",
                    "global",
                    "list",
                    "relationship-intelligence"
                  ]
                },
                "enrichmentSource": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "enum": [
                    "affinity-data",
                    "dealroom",
                    "eventbrite",
                    "mailchimp",
                    null
                  ]
                },
                "valueType": {
                  "type": "string",
                  "enum": [
                    "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"
                  ]
                },
                "createdAt": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time"
                },
                "filterability": {
                  "type": "object",
                  "additionalProperties": true
                },
                "sortability": {
                  "type": "object",
                  "additionalProperties": true
                }
              },
              "required": [
                "createdAt",
                "enrichmentSource",
                "id",
                "name",
                "type",
                "valueType"
              ],
              "additionalProperties": false
            }
          },
          "pagination": {
            "type": "object",
            "properties": {
              "prevUrl": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "uri"
              },
              "nextUrl": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "uri"
              }
            },
            "additionalProperties": false
          }
        },
        "required": [
          "data",
          "pagination"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Affinity provider guide](https://deepline.com/docs/providers/affinity/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.