Obtain a list of member profile variable fields and values.
Prerequisite
- Obtain the
datasetIdby 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
| 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:
|
meta
|
This element can contains the following
values:
|
name
|
The name of the member profile variable field. |
type
|
This element can contains the following
values:
|
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>
}
}
]
}
},
...
]
}