Field Selection

For both raw APIs and _query APIs, field selection is achieved with the use of the fields parameter.

The fields parameter simple takes a comma-delimited list of fields that should be returned in the API call.

If the fields parameter is omitted or empty, all fields will be returned.

If any of the fields listed in the fields parameter do not exist, these fields will be ignored and only the fields that do exist in the dataset will be returned. No error will be raised if field names are included that do not exist in the data set.

For example:

https://my_workspace.api.vitruvi.cc/api/v1/raw/core/customfieldvalue?limit=10000&offset=0&fields=id,settings_id,object_id,value

would retrieve only the id, settings_id, object_id and value fields from the Custom Field Value data set.