Returns members, and associated profile data, based on criteria specified by parameters.
Results can be paged by passing offset and limit values to the limit parameter as [offset],[limit]. eg. 10,10
string |
Your API access key | |
| brandID | integer |
Filter to user actions and score for specific brand |
| segmentID | integer |
ID of the segment to filter by |
| includeOneTime | boolean |
Value of 1 will show one time actions such as follows and likes (default 0) |
| services | string |
Comma separated list – eg. twitter, facebook, lastfm, rdio, youtube, custom, etc |
| fields | string |
Comma separated list to reduce returned data set to – eg. Email, FirstName, BirthDate |
| domain | string |
Filter by the domain the members registered from, without the 'http' or 'www' eg. mydomain.com |
| country | string |
ISO 3166-1 alpha-2, comma separated list. eg US,CA,GB |
| members | string |
Only include these members, comma separated list of native IDs – eg. 811566,803186 |
| emails | string |
Only include these members by email, comma separated list – eg. abc@here.com,def@there.com |
| paid_only | boolean |
Filter to users who have a paid service attached eg. Spotify Premium |
| optedin | boolean |
Filter to users who have opted in. Brand or Segment ID must also be provided |
| extended | boolean |
include extended data in result set |
| before | integer |
Load all members with id values lower than this value. Note: Will override any value set for 'after' |
| after | integer |
Load all members with id values higher than this value |
| totalmembercount | boolean |
Include the total member count field in API response' |
| limit | integer |
Limit the results, default 10, max 1000 eg 100 or 10,10 (offset,limit) |
Sign in with your developer account to use the console, or sign up here
curl -v -X GET "https://api.theappreciationengine.com/v1.1/members/all?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&limit=10"$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.theappreciationengine.com/v1.1/members/all?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&limit=10",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;import requests
url = "https://api.theappreciationengine.com/v1.1/members/all?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&limit=10"
headers = {}
payload = {}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text.encode('utf8'))var request = require('request');
var options = {
'method': 'GET',
'url': 'https://api.theappreciationengine.com/v1.1/members/all?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&limit=10',
'headers': {}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});{
"totalSize":2,
"items":[
{
"ID": "12345",
"UUID": "11111111-2222-3333-4444-555555555555",
"FirstName": "Beverly",
"Surname": "Crusher",
"Username": "DrCrusherrr",
"Email": "drbeverlycrusher@starfleet.com",
"Gender": "F",
"BirthDate":"2324-10-13",
"Bio": "Fixing people on the Enterprise",
"Age":"37",
"City":null,
"State":null,
"Country":null,
"Address":null,
"Addressline2":null,
"PostCode":null,
"HomePhone":null,
"MobilePhone":null,
"GeoCity":null,
"GeoRegion":null,
"GeoCountry":null,
"GeoLat":null,
"GeoLong":null,
"Joined":"2349-07-18 16:00:00",
"AvatarURL":"https://www.starfleet.com",
"CountryCode":null,
"Services":[
{
"ID": "666666",
"Service": "SpotifyAuthenticator",
"Token": "aDLzPjnhbgvfcdjbhgvfqw",
"TokenSecret": "WRYasdfasdasdfcdxobY",
"Valid": "1",
"ActivitySharing": "1",
"UserID": "123",
"Username": "DrCrusherrr",
"UserURL": "https://open.spotify.com/user/123",
"Expires": "0",
"Followers": "1",
"Likes": "4",
"VerifiedEmail": "drbeverlycrusher@starfleet.com",
"Domains": [
"http://www.someurl.com",
"https://www.starfleet.com"
],
"PaidAccount": "1",
"LastUpdated": "2350-04-30 14:00:00",
"LastLogin": "2350-04-30 14:00:00"
}
],
"OptIns":null,
"VerifiedEmail":"drbeverlycrusher@starfleet.com"
},
{
"ID": "1111",
"UUID": "11111111-1111-1111-1111-111111111111",
"FirstName": "William",
"Surname": "Riker",
"Username": "ImNumber1",
"Email": "williamriker@starfleet.com",
"Gender": "M",
"BirthDate":"2335-08-19",
"Bio":"Guess who's number one...",
"Age":"30",
"City":null,
"State":null,
"Country":"US",
"Address":null,
"Addressline2":null,
"PostCode":null,
"HomePhone":null,
"MobilePhone":null,
"GeoCity":null,
"GeoRegion":null,
"GeoCountry":null,
"GeoLat":null,
"GeoLong":null,
"Joined":"2357-11-04 13:00:00",
"AvatarURL":"https://www.someurl.com",
"CountryCode":"US",
"Services":[
{
"ID": "1111111111",
"Service": "SpotifyAuthenticator",
"Token": "BQAimKCA-duKAUcs6-CxnWBlN7kjqw",
"TokenSecret": "AQDggyhu7yRILTbL-8o5pQH8dtrCobY",
"Valid": "1",
"ActivitySharing": "1",
"UserID": "111",
"Username": "ImNumber1",
"UserURL": "https://open.spotify.com/user/111",
"Expires": "0",
"Followers": "1",
"Likes": "1",
"VerifiedEmail": "williamriker@starfleet.com",
"Domains": [
"http://www.someurl.com",
"https://starfleet.com"
],
"PaidAccount": "1",
"LastUpdated": "2353-04-30 14:00:00",
"LastLogin": "2353-04-30 14:00:00"
}
],
"OptIns":null,
"VerifiedEmail":"williamriker@starfleet.com"
}
],
"paging":{
"next":"http://theappreciationengine.com/v1.1/members/all?apikey=yourkey123&after=12345",
"previous":"http://theappreciationengine.com/v1.1/members/all?apikey=yourkey123&before=12300"
}
}