» Removals » Get

GET removals

Retrieve Removals in the account

Resource

Method GET
URL http://api.responder.co.il/v1.0/removals

Parameters

emails
optional

A comma separated list of emails to get Removals for.

Example value: test1@domain.com,test2@domain.com
type_id
optional

The type of Removals to get:
1 - blocked
2 - manually removed
3 - unsubscribed

Example value: 1
status
optional

The status of Removals to get:
1 - active

Example value: 1
limit
optional

Maximum number of rows to be retrived.
Range between 1 to 500.

Example value: 25
Default value: 500
offset
optional

The position to start the count of "limit" from.
Value must be larger or equal to 0

Example value: 10
Default value: 0
dir
optional

The order of the rows.
For "dir=0" the rows will be in ascending order according to creation date.
For "dir=1" the rows will be in descending order according to creation date.
Value can be either 0 or 1

Example value: 1
Default value: 0

Example

GET http://api.responder.co.il/v1.0/removals

Response

{
   "REMOVALS" : [
      {
         "EMAIL" : "test1@domain.com",
         "TYPE_ID" : 1,
         "TYPE" : "נחסם",
         "STATUS" : 0,
         "DATE" : "2019-01-01 00:00:00"
      },
      {
         "EMAIL" : "test2@domain.com",
         "TYPE_ID" : 2,
         "TYPE" : "הוסר ידנית",
         "STATUS" : 0,
         "DATE" : "2019-02-01 00:00:00"
      }
   ]
}