GET target-lists

Overview

The Target-List API permits interaction with target lists associated with your company. You can use the API's GET /v2/target-lists call to return the names and summary information of your target lists.

In order to limit payload size, the maximum number of target lists that can be returned in a single call is 100. The full list of target lists can be obtained via a series of GET /v2/target-lists calls using appropriate values of the LIMIT and OFFSET parameters.

Resource URI

GEThttps://api.yesmail.com/v2/target-lists

Call Description

The GET /v2/target-lists call returns the names and summary information of your target lists.

Parameters

Parameter

Requirement

Description

limit

Optional

Valid values are integers 0-100. The default is 25.

offset

Optional

Valid values are 0-any positive integer.  The default is 0.

HTTP Return Codes

Code

Description

200 OK

The request has succeeded.

400 Bad Request    

The request could not be understood by the server due to malformed syntax.  For example, invalid parameter values.

401 Unauthorized

The request requires user authentication.  Invalid Api-User and/or Api-Key header value.

 

Response Payload: 
{
    "offset": 0,
    "limit": 25,
    "count": 2,
    "total": 2,
    "lists": [
        {
            "name": "TargetList1",
            "memberCount": 2500,
        },  
        {               
            "name": "TargetList2",
            "memberCount": 2      
        }
    ]
}