Return a list of requests and filter it.
Note: Only requests added in the last 45 days will be shown.

GET Parameters

Parameter	Description
limit (numeric)	The number of records to return Default: 15
offset (numeric)	The number of records to 'offset' the results by	(for pagination)
status (string)	A request 'status' to filter on	sent: Requests sent, awaitng resaponse reviewed: Only requests which resulted in a review. invalid: Requests which were invalid addresses pending: Requests which are pending duplicate: Requests which duplicates blacklist: Requests which were on the blacklist bounced: Requests which bounced rated: Only requests which resulted in at least a review.

* denotes a required field

Response

Parameter	Description
results (array)	The Results
-request_id (numeric)	A unique ID for this request
-email (string)	The email this request went to
-template_id (numeric)	The template ID for this request
-added (datetime)	When this request was added
-sent (datetime/false)	When this request was sent	false if not applicable
-reviewed (datetime/false)	When this request was reviewed	false if not applicable
-num_reminders (datetime/false)	When the last reminder was sent	false if not applicable
-rating (numeric/false)	The star rating awarded	false if not applicable
-review_id (numeric/false)	The ID of the review generated	false if not applicable
-source (string)	How this request was addded
-code (string/false)	The code used for this request	false if not applicable
-status (string/false)	The status of this request
-booking_id (numeric/false)	The Booking Id if given	false if not given
-first_name (numeric/false)	The customers firstname	false if not given
-last_name (numeric/false)	The customers lastname	false if not given
-extra_data (array)	Any extra fields added along with the request
--* (mixed)	key - value pairs of any added fields
status_filter (string)	The status filtered by	(if any)
records_from (numeric)	The lower limit of the results
records_to (numeric)	The upper limit of the results
num_records_total (numeric)	The total number of results found
num_records (numeric)	The number of results returned
status (string)	Was this a succesful request?	OK or error

* denotes a response field which is not always present

Example JSON response:

{
"results": [
{
"request_id": 9652,
"email": "example@hotmail.com",
"template_id": 16,
"added": "2013-10-22T05:23:12Z",
"sent": false,
"reviewed": false,
"num_reminders": 0,
"last_reminder": false,
"rating": false,
"review_id": false,
"source": "api",
"code": false,
"status": "duplicate",
"booking_id": "ABSCDFIUHKLNJ",
"first_name": "James",
"last_name": "Smith",
"extra_data": {
"booking_agent": "135"
}
},
{
"request_id": 9651,
"email": "example@gmail.com",
"template_id": 16,
"added": "2013-10-22T05:22:40Z",
"sent": false,
"reviewed": false,
"num_reminders": 0,
"last_reminder": false,
"rating": false,
"review_id": false,
"source": "api",
"code": false,
"status": "pending",
"booking_id": "ABSCDFIUHKLNJ",
"first_name": false,
"last_name": false,
"extra_data": {
"booking_agent": "135"
}
},
{
"request_id": 9650,
"email": "example_12@hotmail.com",
"template_id": 16,
"added": "2013-10-22T05:21:56Z",
"sent": false,
"reviewed": false,
"num_reminders": 0,
"last_reminder": false,
"rating": false,
"review_id": false,
"source": "api",
"code": false,
"status": "duplicate",
"booking_id": false,
"first_name": false,
"last_name": false,
"extra_data": {
"booking_agent": "135"
}
},
{
"request_id": 9649,
"email": "example@hotmail.com",
"template_id": 16,
"added": "2013-10-22T05:21:23Z",
"sent": false,
"reviewed": false,
"num_reminders": 0,
"last_reminder": false,
"rating": false,
"review_id": false,
"source": "api",
"code": false,
"status": "duplicate",
"booking_id": false,
"first_name": false,
"last_name": false,
"extra_data": [
"accomodation": "premium",
"booking_agent": "133"
]
},
{
"request_id": 9648,
"email": "example_121@example.com",
"template_id": 17,
"added": "2013-10-22T05:21:16Z",
"sent": false,
"reviewed": false,
"num_reminders": 0,
"last_reminder": false,
"rating": false,
"review_id": false,
"source": "api",
"code": false,
"status": "duplicate",
"booking_id": false,
"first_name": false,
"last_name": false,
"extra_data": [

]
},
{
"request_id": 9647,
"email": "example_231@example.com",
"template_id": 0,
"added": "2013-10-22T05:20:17Z",
"sent": false,
"reviewed": false,
"num_reminders": 0,
"last_reminder": false,
"rating": false,
"review_id": false,
"source": "api",
"code": false,
"status": "duplicate",
"booking_id": false,
"first_name": false,
"last_name": false,
"extra_data": [

]
},
{
"request_id": 9646,
"email": "example_1245@example.com",
"template_id": 0,
"added": "2013-10-22T05:20:00Z",
"sent": false,
"reviewed": false,
"num_reminders": 0,
"last_reminder": false,
"rating": false,
"review_id": false,
"source": "api",
"code": false,
"status": "duplicate",
"booking_id": false,
"first_name": false,
"last_name": false,
"extra_data": [

]
},
{
"request_id": 9645,
"email": "example_1343@example.com",
"template_id": 0,
"added": "2013-10-22T05:19:59Z",
"sent": false,
"reviewed": false,
"num_reminders": 0,
"last_reminder": false,
"rating": false,
"review_id": false,
"source": "api",
"code": false,
"status": "duplicate",
"booking_id": false,
"first_name": false,
"last_name": false,
"extra_data": [

]
},
{
"request_id": 9644,
"email": "example_12332231@example.com",
"template_id": 0,
"added": "2013-10-22T05:19:41Z",
"sent": false,
"reviewed": false,
"num_reminders": 0,
"last_reminder": false,
"rating": false,
"review_id": false,
"source": "api",
"code": false,
"status": "duplicate",
"booking_id": false,
"first_name": false,
"last_name": false,
"extra_data": [

]
},
{
"request_id": 9643,
"email": "example_1231@example.com",
"template_id": 0,
"added": "2013-10-22T05:18:52Z",
"sent": false,
"reviewed": false,
"num_reminders": 0,
"last_reminder": false,
"rating": false,
"review_id": false,
"source": "api",
"code": false,
"status": "duplicate",
"booking_id": false,
"first_name": false,
"last_name": false,
"extra_data": [

]
},
{
"request_id": 9642,
"email": "example_1212231@example.com",
"template_id": 0,
"added": "2013-10-22T05:18:45Z",
"sent": false,
"reviewed": false,
"num_reminders": 0,
"last_reminder": false,
"rating": false,
"review_id": false,
"source": "api",
"code": false,
"status": "duplicate",
"booking_id": false,
"first_name": false,
"last_name": false,
"extra_data": [

]
},
{
"request_id": 9641,
"email": "example_1121@example.com",
"template_id": 0,
"added": "2013-10-22T05:16:56Z",
"sent": false,
"reviewed": false,
"num_reminders": 0,
"last_reminder": false,
"rating": false,
"review_id": false,
"source": "api",
"code": false,
"status": "duplicate",
"booking_id": false,
"first_name": false,
"last_name": false,
"extra_data": [

]
},
{
"request_id": 9640,
"email": "example_1123@example.com",
"template_id": 0,
"added": "2013-10-22T05:16:55Z",
"sent": false,
"reviewed": false,
"num_reminders": 0,
"last_reminder": false,
"rating": false,
"review_id": false,
"source": "api",
"code": false,
"status": "duplicate",
"booking_id": false,
"first_name": false,
"last_name": false,
"extra_data": [

]
},
{
"request_id": 9639,
"email": "example_1223@example.com",
"template_id": 0,
"added": "2013-10-22T05:16:52Z",
"sent": false,
"reviewed": false,
"num_reminders": 0,
"last_reminder": false,
"rating": false,
"review_id": false,
"source": "api",
"code": false,
"status": "duplicate",
"booking_id": false,
"first_name": false,
"last_name": false,
"extra_data": [

]
}
],
"status_filter": "none",
"records_from": 1,
"records_to": 14,
"num_records_total": 0,
"num_records": 14,
"status": "OK"
}