> ## 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 Persons Fields Field ID Dropdown Options Get

> List the dropdown options for an Affinity person field, with the option IDs used to set values. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

List the dropdown options for an Affinity person field, with the option IDs used to set values.

> [!NOTE]
>
> Tool ID: `affinity_v2_persons_fields_field_id_dropdown_options_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_persons_fields_field_id_dropdown_options_get',
  {
    "fieldId": "field_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute affinity_v2_persons_fields_field_id_dropdown_options_get --input '{
  "fieldId": "field_123"
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe affinity_v2_persons_fields_field_id_dropdown_options_get --json` for the complete live contract.

## Input reference

Returns the dropdown options for a specific dropdown or ranked-dropdown field on a Person. Use the returned dropdown option IDs when writing dropdown field values via the field update endpoints.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.fieldId` | `string` | Yes | — | Field ID |
| `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. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns the dropdown options for a specific dropdown or ranked-dropdown field on a Person. Use the returned dropdown option IDs when writing dropdown field values via the field update endpoints.",
    "properties": {
      "fieldId": {
        "type": "string",
        "description": "Field ID"
      },
      "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"
      }
    },
    "required": [
      "fieldId"
    ],
    "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` | `integer` | Yes | — | Format: `int64`. Minimum: 1. Maximum: 9007199254740991. |
| `result.data.data[].text` | `string` | Yes | — | — |
| `result.data.data[].type` | `"dropdown" \| "ranked-dropdown" \| "status-dropdown"` | Yes | — | — |
| `result.data.data[].rank` | `integer` | No | — | Format: `int32`. Minimum: 0. Maximum: 2147483647. |
| `result.data.data[].color` | `"white" \| "gray" \| "blue" \| "green" \| "purple" \| "orange" \| "red" \| null` | No | — | — |
| `result.data.data[].statusCategory` | `"open" \| "won" \| "lost" \| "on-hold"` | No | — | Allowed: `open`, `won`, `lost`, `on-hold`. |
| `result.data.data[].winRate` | `integer \| null` | No | — | Format: `int32`. Minimum: 0. Maximum: 100. |
| `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": "integer",
                  "minimum": 1,
                  "maximum": 9007199254740991,
                  "format": "int64"
                },
                "text": {
                  "type": "string"
                },
                "type": {
                  "anyOf": [
                    {
                      "type": "string",
                      "enum": [
                        "dropdown",
                        "ranked-dropdown"
                      ]
                    },
                    {
                      "type": "string",
                      "const": "status-dropdown"
                    }
                  ]
                },
                "rank": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 2147483647,
                  "format": "int32"
                },
                "color": {
                  "anyOf": [
                    {
                      "type": [
                        "string",
                        "null"
                      ],
                      "enum": [
                        "white",
                        "gray",
                        "blue",
                        "green",
                        "purple",
                        "orange",
                        "red",
                        null
                      ]
                    },
                    {
                      "type": [
                        "string",
                        "null"
                      ],
                      "enum": [
                        "white",
                        "gray",
                        "blue",
                        "green",
                        "purple",
                        "orange",
                        "red",
                        null
                      ]
                    }
                  ]
                },
                "statusCategory": {
                  "type": "string",
                  "enum": [
                    "open",
                    "won",
                    "lost",
                    "on-hold"
                  ]
                },
                "winRate": {
                  "type": [
                    "integer",
                    "null"
                  ],
                  "minimum": 0,
                  "maximum": 100,
                  "format": "int32"
                }
              },
              "required": [
                "id",
                "text",
                "type"
              ],
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 9007199254740991,
                      "format": "int64"
                    },
                    "text": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "id",
                    "text"
                  ],
                  "additionalProperties": false
                },
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 9007199254740991,
                      "format": "int64"
                    },
                    "text": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "id",
                    "text"
                  ],
                  "additionalProperties": false
                },
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 9007199254740991,
                      "format": "int64"
                    },
                    "text": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "id",
                    "text"
                  ],
                  "additionalProperties": false
                }
              ],
              "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.