Get a list of members and their member variables.
Resource URL
/v1/applications/{communityApiKeyName}/memberfilters/{id}/members
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 | Returns a list of members in a member group and their profile variables and values. |
Parameters
Parameters can be appended to the request to further refine the results returned.
| Operation | Description | Example |
|---|---|---|
| Refine the response by field |
To reduce the number of fields returned, specify the fields in a comma separated list. You can use all of the fields to limit the response except
for:
|
/memberfilters/{id}/members?fields=name
|
| Filtering by value | By default, all the items are returned
unless you specify your criteria using the variable name and value.
You can filter the response on the values in all of the
available fields except for:
|
/memberfilters/{id}/members?name=Canada
|
| Paging | The default, 20 items are returned at a time and the maximum is 1000. | Use the
limit and
offset query string parameters to effectively
page through the results.
|
| Sorting | You can sort the response on all of the
fields except for:
|
/memberfilters/{id}/members?sort=name:d
|
For more information, see Content control.
Available fields
| Item | Description |
|---|---|
communityid
|
This field is not in use. |
datasettype
|
This value is always
Live.
|
email
|
The email address the member used to join community. |
id
|
The GUID for member. |
joindate
|
The date-time UTC of when the member joined the community. |
memberstatus
|
The current status of the member in the
system. Possible values are:
For more information, see System variables. |
recruitmentcommunicationid
|
The GUID for the recruitment email invitation. |
recruitmentmethod
|
The string value for the recruitment
method: Possible values are
|
recruitmentsource
|
The string value for the recruitment
source. Possible values are:
|
recruitmentstatus
|
This value will always be
Joined.
|
statusupdatedby
|
The GUID for the user. |
statusupdateddate
|
The date-timestamp UTC of when the member's status changed. |
uploadid
|
The GUID for the CSV file import for email
invitations when the
recruitmentmethod is
Email.
This field does not appear in the response if the
|
Example Response
In the example below,
gender,
householdincome,
maritalstatus,
age,
state, and
country, are profile variables that were used to
create the member filter in the application. These variables will not appear in
the response unless an admin uses them in the filter condition.
{
"meta": {
"offset": 0,
"limit": 1,
"count": 1
},
"items": [
{
"id": <GUID of member>,
"communityid": <GUID of community>,
"datasettype": "Live",
"email": <email address>,
"recruitmentcommunicationid": <GUID of communication>,
"recruitmentstatus": "Joined",
"memberstatus": <Active|Pending|Nonmember|Purged|Undeliverable>,
"statusupdateddate": <date-time UTC>,
"statusupdatedby": <GUID of user>,
"recruitmentmethod": <Email|SurveyLink>,
"joindate": <date-time UTC>,
"uploadid": "595eba1f-9c81-456e-94a5-a735018b7828",
"recruitmentsource": <GUID of CSV>,
"gender": "Female",
"householdincome": "$50,000 to $74,999",
"maritalstatus": "Single",
"age": "45-54",
"state": "California",
"country of residence": "USA"
}
],
"links": [
{
"rel": "first",
"href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/memberfilters/{memberFilterId}/members?limit=1&offset=0"
},
{
"rel": "prev"
},
{
"rel": "last"
},
{
"rel": "next"
}
],
"href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/memberfilters/{memberFilterId}/memberfilters/{memberFilterId}/members?limit=1"