List Data Fields

Required scope: datafield:read

Use this endpoint to discover data field keys, types, descriptions, options, and archived state before writing portfolio data fields.

Location definitions use PUBLIC_DATA_FIELD_TYPE_LOCATION. Their configJson contains an available_fields array selecting from zipcode, house_number, extension, street, city, country, latitude, longitude, and full_address.

Company definitions use PUBLIC_DATA_FIELD_TYPE_COMPANY. Their configJson selects from company_name, registration_number, and vat_number. Company values do not contain addresses; use a location data field for those.

Currency definitions use PUBLIC_DATA_FIELD_TYPE_CURRENCY. Values use the string contract and contain an integer number of cents, for example "25000" for EUR 250.00.

Generated Reference

POST /public-api/publicapi.v1.DataField/ListDataFields

Lists portfolio data field definitions for the workspace.

Request ListDataFieldsRequest

Response ListDataFieldsResponse

ListDataFieldsRequest

Field	Type
include_archived	bool

ListDataFieldsResponse

Field	Type
data_fields	repeated DataField

Related Types

DataField

Field	Type
id	string
name	string
field_type	DataFieldType
description	string
options	repeated string
created_at	int64
updated_at	int64
archived_at	optional int64
config_json	optional string

Request

{
  "includeArchived": false
}

Response

{
  "dataFields": [
    {
      "id": "9d8cb34e-1c15-418c-9fdb-cfc5293df688",
      "name": "external_status",
      "fieldType": "PUBLIC_DATA_FIELD_TYPE_TEXT",
      "description": "External system status"
    }
  ]
}