Get Persons Fields
affinity_get_persons_fieldsRetrieves all person field definitions in Affinity CRM, including types, dropdown options, and enrichment sources, for schema discovery and form generation.
Instructions
Retrieve all global (account-wide) field definitions for persons.
This is a V1 API endpoint - persons fields GET is NOT available in V2.
Returns complete schema information for person fields including:
Field names and IDs
Field types (text, number, dropdown, etc.)
Dropdown options (available choices)
Multiple value support
Enrichment sources (external data providers)
Use Cases:
Schema discovery: "What person fields exist in our CRM?"
Form generation: Build dynamic forms based on available fields
Field validation: Check if input values are valid for dropdown fields
Field resolution: Map field IDs to human-readable names
Data source tracking: Identify which fields come from enrichment providers
No Parameters Required: This is a simple GET request with no parameters. Returns all global person fields.
Returns (JSON): { "fields": [ { "id": number, // Field identifier "name": string, // Field display name "value_type": number, // 0-9 enum (see types below) "value_type_name": string, // Human-readable type "allows_multiple": boolean, // Can have multiple values "dropdown_options": [...], // Available choices (if dropdown) "enrichment_source": string // e.g., "affinity-data", "crunchbase" } ], "count": number, "by_type": { // Distribution by field type "Dropdown": number, "Text": number, ... }, "by_source": { // Distribution by data source "affinity-data": number, "none": number, ... }, "summary": string }
Field Value Types:
0 = Person: References another person
1 = Organization: References an organization
2 = Dropdown: Single/multi-select from predefined options
3 = Number: Numeric value
4 = Date: Date/timestamp
5 = Location: Geographic location (city, state, country)
6 = Text: Free-form text
7 = Ranked Dropdown: Ordered dropdown (e.g., pipeline stages)
8 = Formula: Computed/calculated value
9 = Interaction: Email/meeting reference
Enrichment Sources:
"affinity-data": Affinity's proprietary data
"crunchbase": Crunchbase data
"dealroom": Dealroom data
"none" or null: Custom fields created by your team
Example Use Cases:
Discover all person fields: No parameters needed Returns: Complete list of person field schemas
Find dropdown fields: Filter response by fields that have dropdown_options
Identify enriched fields: Filter by enrichment_source to see external data
Build dynamic forms: Use field definitions to generate input forms programmatically
Response Format: Use responseFormat parameter to get either:
"json": Structured data with statistics (default)
"markdown": Human-readable formatted output
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| responseFormat | No | Output format: "json" for structured data or "markdown" for human-readable. Default: "json" |