/datasets/profile/{datasetId}/fields

Obtain a list of member profile variable fields and values.

Prerequisite

• Obtain the datasetId by making a request to /datasets/profile.

Resource URL

/v2/applications/{communityApiKeyName}/datasets/profile/{datasetId}/fields

Note:

Use the appropriate regional endpoint to ensure that you comply with your organization's privacy policy, and applicable laws and regulations. For details about the available regional endpoints, and how to identify your organization's region, see Shared responsibility.

Available methods

Method	Description
GET	Get member profile variable fields and values.

Available fields

Table 1. Elements under the fields attribute

Element	Description
id	The GUID of the member profile variable field.
isSensitive	The value determines whether the member profile variable field contains sensitive data. Possible values are: true false
meta	This element can contains the following values: description: The description of the member profile variable field. visibility: The visibility setting of the member profile variable field. Possible values are: active hidden
name	The name of the member profile variable field.
type	This element can contains the following values: dataType: The value of how the member profile values are stored. Possible values are: string: The value is stored as text. double: The value is stored as numeric. datetime: The value is stored as date-time. identifier: The value is stored as a text identifier. enum: Allows the choice of a single value from a list of possible values. set: Allows the choice of multiple values from a list of possible values. values: Member profile variable field options. id: GUID of the member profile variable field option. name: Name of the member profile variable field option. meta: Contains the option's visibility with the possible values of active or deleted. Note: The element values is not displayed if it is an open dataType. Open data types are values such as string, double, or identifier.

Example

{
    "fields": [
        {
            "id": <GUID of the member profile variable field>,
            "name": <string name of the member profile variable field>,
            "meta": {
                "description": <string description of the member profile variable field>,
                "visibility": <active|hidden>
            },
            "isSensitive": <true|false>,
            "type": {
                "dataType": <enum|string|double|datetime|identifier|set>,
                "values": [
                    {
                        "id": <GUID of the member profile variable field option>,
                        "name": <string name of the member profile variable field option>,
                        "meta": {
                            "visibility": <active|deleted>
                        }
                    }
                ]
            }
        },
        ...
    ]
}

Parent topic: Member Profile Datasets