{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/:site_id/subscribers","auth":"required","settings":"56ea050204dc470e002870f1","results":{"codes":[{"code":"[\n    {\n        \"id\": \"f5QfqY8sckoxi0iU8umgNDP1G6WH5UB7nF1ZUx0lg-7x6N7IrifGJqKNF-i9F\",\n        \"uid\": \"1122\",\n        \"avatar_url\": \"https://secure.gravatar.com/avatar/b7cadf744b09851218ef5e6d28b326e8?default=https://app.zetaglobal.net/assets/default_avatar.png\",\n        \"href\": \"https://api.boomtrain.net/subscribers/f5QfqY8sckoxi0iUWH5UB7nF1ZUx0lg-7x6N7IrifGJqKNF-i9F35C2BZmR1YTA==\",\n        \"name\": \"David Davidson\",\n        \"first_name\": \"David\",\n        \"last_name\": \"Davidson\",\n        \"properties\": {\n            \"channel\": \"email\",\n            \"created_at\": \"2019-02-01T19:15:38.671Z\",\n            \"emailable_promo\": \"Y\",\n            \"first_name\": \"David\",\n            \"has_active_email\": \"true\",\n            \"has_active_phone\": \"false\",\n            \"has_active_push_device\": \"false\",\n            \"has_active_subscription\": \"true\",\n            \"last_contact\": \"2019-01-04T15:15:13.000Z\",\n            \"last_name\": \"Davidson\",\n            \"last_opened\": \"2019-01-04T16:52:36.000Z\",\n            \"last_updated\": \"2019-01-04T15:07:07+00:00\",\n            \"name\": \"David Davidson\",\n            \"signed_up_at\": \"2019-02-01T19:15:38.671Z\"\n        },\n        \"scoped_properties\": {},\n        \"sub_site_ids\": [],\n        \"contacts\": [\n            {\n                \"contact_type\": \"email\",\n                \"contact_value\": \"ddavidson:::at:::zetaglobal.com\",\n                \"subscription_status\": \"new\",\n                \"inactivity_reason\": \"\",\n                \"created_at\": 1546614427,\n                \"updated_at\": 1549048538\n            }\n        ],\n        \"scoped_contacts\": {}\n    },\n    {\n        \"id\": \"6baYHoiOGbNYckE1JtW=\",\n        \"uid\": \"99111878\",\n        \"avatar_url\": \"https://secure.gravatar.com/avatar/b7cadf744b09851218ef5e6d28b326e8?default=https://app.zetaglobal.net/assets/default_avatar.png\",\n        \"href\": \"https://api.boomtrain.net/subscribers/6bihMLtaYHoiOGbNYckE1JtWM8Jt6uZL56shlnf-XcZDoeSdSAchpGkQ==\",\n        \"name\": null,\n        \"first_name\": null,\n        \"last_name\": null,\n        \"properties\": {\n            \"created_at\": \"2019-04-10T17:26:47.236Z\",\n            \"has_active_email\": \"true\",\n            \"has_active_phone\": \"false\",\n            \"has_active_push_device\": \"false\",\n            \"has_active_subscription\": \"true\",\n            \"last_contact\": \"2019-04-10T17:28:33.000Z\",\n            \"last_seen\": \"2019-04-10T00:00:00.000Z\",\n            \"last_updated\": \"2019-04-10T17:30:14+00:00\",\n            \"loyalty\": {\n                \"loyalty_id\": \"TH99111878\",\n                \"loyalty_flag\": \"Y\"\n            },\n            \"signed_up_at\": \"2019-04-10T17:26:47.236Z\"\n        },\n        \"scoped_properties\": {},\n        \"sub_site_ids\": [],\n        \"contacts\": [\n            {\n                \"contact_type\": \"email\",\n                \"contact_value\": \"[email protected]\",\n                \"subscription_status\": \"active\",\n                \"inactivity_reason\": \"\",\n                \"created_at\": 1554917207,\n                \"updated_at\": 1554917414\n            }\n        ],\n        \"scoped_contacts\": {}\n    }\n]","language":"text","status":200},{"code":"{}","language":"text","status":400}]},"method":"get","examples":{"codes":[{"language":"http","code":"GET https://api.zetaglobal.net/201507/subscribers?contact_type=email&[email protected]"}]},"params":[{"name":"contact_type","type":"string","default":"email","desc":"The type of contact, generally 'email'.","required":false,"in":"query","ref":"","_id":"56e9d3d19f2cd01700c0b5cd"},{"name":"contact_value","type":"string","default":"","desc":"The email address.  ex)[email protected]","required":false,"in":"query","ref":"","_id":"5d012d7fac5afe002a1bffc3"},{"name":"site_id","type":"string","default":"","desc":"ZMP Site ID","required":false,"in":"path","ref":"","_id":"6059045f4f2a68006c407e50"}]},"next":{"description":"","pages":[]},"title":"Look up User by Contact","type":"endpoint","slug":"look-up-user-by-contact","excerpt":"If you are using a non-email user_id, but only have the email, this API can be used to look up the user_id(s) for that have the associated contact email value.","body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Required Headers\",\n    \"h-1\": \"Value\",\n    \"0-0\": \"Content-Type\",\n    \"0-1\": \"application/json\",\n    \"1-0\": \"Accept\",\n    \"1-1\": \"application/json\",\n    \"2-0\": \"Authorization\",\n    \"2-1\": \"Basic <Auth Key>\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5d012b31539eff001e49522c","project":"56aff08c3a5b810d00745d99","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["56aff08d3a5b810d00745d9d","56aff24f3a5b810d00745da0","56aff25dbc304a0d00ace207","56aff287e0b1e40d00c53798","56aff2b260a37a0d00ed8883","56aff2b8e0b1e40d00c53799","56aff2bd5b1f01170014dc7b","56aff2c9d21e9c0d00b62993","56aff493aef9a21700da0e67","56aff4ce1486990d009c0f64","56aff4da5b1f01170014dc7d","56aff4dfe0b1e40d00c537a2","56aff4e59d32e30d0006d3e9","56aff4e91486990d009c0f65","56aff4f93a5b810d00745da2","56aff4fe9d32e30d0006d3ea","56b91c7ab1e03e0d001057c5","56c4f51aba4a540d0091b9a2","56cd09488c4a331d002c1e44","56d4ec4773dcd20b00fb8769","56e79bc515f96b2200878e54","56ec25c538ff1d2200d56cc2","56ec3a6f36bc8e0e00f190c8","56ec3e308ea7ce0e00a3d8b0","5724d8fe4255580e005938b2","5724dc842ad0bc1700122803","5776ef2a04f7500e0095dc37","57ab9f70b5e8742000e17eb9","57d7117646dcc30e007dd21f","58e6abd5b1eece19008b7d31","59288c65e2653627003e1221","5a8f4797a44f8600128e75ee","5bbf8833eb416300039a2c14","5ea811617bf4b5007328a0af"],"_id":"56aff08c3a5b810d00745d9c","project":"56aff08c3a5b810d00745d99","releaseDate":"2016-02-01T23:55:56.544Z","__v":34,"createdAt":"2016-02-01T23:55:56.544Z"},"category":{"sync":{"isSync":false,"url":""},"pages":["56ec26de1b16a3290030cf58"],"title":"Zeta REST API","slug":"bme-rest-api","order":2,"from_sync":false,"reference":true,"_id":"56ec25c538ff1d2200d56cc2","version":"56aff08c3a5b810d00745d9c","__v":1,"createdAt":"2016-03-18T15:59:01.460Z","project":"56aff08c3a5b810d00745d99"},"user":"5c6d878b750bf101764da244","createdAt":"2019-06-12T16:41:21.448Z","__v":4,"parentDoc":null}

getLook up User by Contact

If you are using a non-email user_id, but only have the email, this API can be used to look up the user_id(s) for that have the associated contact email value.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

site_id:
string
ZMP Site ID

Query Params

contact_type:
stringemail
The type of contact, generally 'email'.
contact_value:
string
The email address. ex)[email protected]

Examples


Result Format


Documentation

[block:parameters] { "data": { "h-0": "Required Headers", "h-1": "Value", "0-0": "Content-Type", "0-1": "application/json", "1-0": "Accept", "1-1": "application/json", "2-0": "Authorization", "2-1": "Basic <Auth Key>" }, "cols": 2, "rows": 3 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}