Retrieving subscriber information

To retrieve information for all subscribers, send an HTTP GET request to this endpoint:

https://app.prompty.io/api/[SITE_ID]/subscribers?api_token=[API_TOKEN]

To limit your request to a specific subscriber, use this endpoint instead (replacing [SUB_ID] with the actual subscriber ID):

https://app.prompty.io/api/[SITE_ID]/subscribers?id=[SUB_ID]&api_token=[API_TOKEN]

You may also query by the subscriber’s external ID value:

https://app.prompty.io/api/[SITE_ID]/subscribers?external_id=[EXT_ID]&api_token=[API_TOKEN]

Or email address:

https://app.prompty.io/api/[SITE_ID]/subscribers?email=[EMAIL]&api_token=[API_TOKEN]

CURL example

curl "https://app.prompty.io/api/[SITE_ID]/subscribers?external_id=1001&api_token=[API_TOKEN]"

Example response

{"status":"success","code":"OK","message":"Subscriber information retrieved.","data":{"subscribers":{"21":{"id":21,"name":"Test Subscriber","email":"[email protected]","active":1,"created_at":"2020-05-21 18:02:15","browser":"Chrome","os":"Windows","is_mobile":0,"city":"New York","state":"New York","country":"United States","external_id":"1001"}}}}