Accessing your custom fields via the API

Additional fields are the custom fields your Gold-Vision administrator has configured — things like customer tier, contract type, or industry classification, depending on your setup. They sit alongside the standard system fields but are excluded from API responses by default.

Requesting specific additional fields

Ask for additional fields by name using the AdditionalFields query parameter:

You can request as many as you need, comma-separated. To return every additional field on the record in one call, pass includeAllAdditionalFields=true — though for production integrations we’d recommend naming only the fields you need, as returning everything adds significant weight to every response.

Finding field names

The best way to discover available field names is to call the metadata endpoint for the relevant entity. Additional fields appear with their API name, display label, and data type.

What the response looks like

Additional fields are returned as an additionalFields array on each record:

{
  "id": "abc123...",
  "summary": "Acme Ltd",
  "additionalFields": [
    { "name": "AC_INDUSTRY",  "value": "Manufacturing" },
    { "name": "AC_SECTOR",    "value": { "id": "...", "summary": "Industrials" } },
    { "name": "AC_JOIN_DATE", "value": "2019-03-15T00:00:00" }
  ]
}

Plain text and date fields return a string value. Lookup fields return an object with id and summary.

A note on activities

Activities have entity-specific additional fields that vary by activity type. The field names use a different prefix depending on the activity context — your Gold-Vision administrator or the metadata endpoint can tell you the correct names for your activity types.