API Reference – Marketing API – Getting Lists

Marketing API Method Documentation

©2009-2014 SocketLabs, Inc., Version 0.1, Last Edit: March 25, 2014

GET /lists

Synopsis:

Returns the contact lists for your server.

Recommended Usage:

This simple GET call can be used to retrieve information on the contact lists for your server, including list name and the integer list ID value. This ID value can be used in subsequent calls to add and remove contacts from that list.

Request Information

HTTP Method:

GET

URL:

https://api.socketlabs.com/marketing/v1/lists

Response Format Types:

JSON or XML

Example Request:

GET /marketing/v1/lists HTTP/1.1
Host: api.socketlabs.com
Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXX==
Cache-Control: no-cache

Response Parameters

id
The list Id
serverId
Your Server’s Id
name
The friendly name you gave to your list

Response Examples

Example Response (JSON):

[
    {
        "id": 554,
        "serverId": 1234,
        "name": "MyFirstList"
    },
    {
        "id": 593,
        "serverId": 1234,
        "name": "AnotherList"
    },
    {
        "id": 594,
        "serverId": 1234,
        "name": "YetOneMoreList"
    }
]

Example Response (XML):

    <ArrayOfList 
    xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <List>
        <Id>554</Id>
        <Name>AutoR2</Name>
        <ServerId>1234</ServerId>
    </List>
    <List>
        <Id>593</Id>
        <Name>List Test 1</Name>
        <ServerId>1234</ServerId>
    </List>
    <List>
        <Id>594</Id>
        <Name>UploadTest</Name>
        <ServerId>1234</ServerId>
    </List>
    <List>
        <Id>595</Id>
        <Name>HugeList</Name>
        <ServerId>1234</ServerId>
    </List>
</ArrayOfList>

Customers Who Trust in SocketLabs

You’re in good company when working with SocketLabs. Here are some companies who have also trusted SocketLabs.

Why SocketLabs?

What Our Customers Are Saying!