Affinity: V2 Persons Fields Field ID Dropdown Options Get - Deepline

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

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.

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

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.

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

Deepline cost

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