Get list

This method allows you to retrieve the contacts of a list.

GET

/list/:id

Query Parameters

id required	The list id
search	With this param, you can filter on `destination`, `info1`, `info2`, `info3` or `info4`
start	You can define the start record for pagination. Default 0
length	You can define the number of records to retrieve per request. Default 100. Maximum 1000

Examples


GET /list/5a0331bffc5886074551ce00 HTTP/1.1
Host: api.smsup.ch
Accept: application/json
Authorization: Bearer your.token

Result Format


{
    "status": 1,
    "message": "OK",
    "list": [
        {
            "id": "5a0331bffc5886074551ce97",
            "destination": "41781234567",
            "info1": "Louis",
            "info2": "de Broglie",
            "info3": "1892",
            "info4": "Dieppe"
        },
        {
            "id": "5a0331bffc5886074551ce98",
            "destination": "41781234566",
            "info1": "Richard",
            "info2": "Feynman",
            "info3": "1918",
            "info4": "New-York"
        },
        {
            "id": "5a0331bffc5886074551ce99",
            "destination": "41781234565",
            "info1": "Hiroo",
            "info2": "Onoda"
        },
        {
            "id": "5a0331bffc5886074551cf00",
            "destination": "41781234564",
            "info1": "Grace",
            "info2": "Hopper"
        },
        {
            "id": "5a0331bffc5886074551cf01",
            "destination": "41781234563",
            "info1": "Hedy",
            "info2": "Lamarr",
            "info3": "Extase",
            "info4": "1933"
        }
    ],
    "name": "Liste API",
    "contacts": "5",
    "totalRecords": 5,
    "totalDisplayRecords": 5
}


<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>1</status>
    <message>OK</message>
    <list>
        <id>5a0331bffc5886074551ce97</id>
        <destination>41781234567</destination>
        <info1>Louis</info1>
        <info2>de Broglie</info2>
        <info3>1892</info3>
        <info4>Dieppe</info4>
    </list>
    <list>
        <id>5a0331bffc5886074551ce98</id>
        <destination>41781234566</destination>
        <info1>Richard</info1>
        <info2>Feynman</info2>
        <info3>1918</info3>
        <info4>New-York</info4>
    </list>
    <list>
        <id>5a0331bffc5886074551ce99</id>
        <destination>41781234565</destination>
        <info1>Hiroo</info1>
        <info2>Onoda</info2>
    </list>
    <list>
        <id>5a0331bffc5886074551cf00</id>
        <destination>41781234564</destination>
        <info1>Grace</info1>
        <info2>Hopper</info2>
    </list>
    <list>
        <id>5a0331bffc5886074551cf01</id>
        <destination>41781234563</destination>
        <info1>Hedy</info1>
        <info2>Lamarr</info2>
        <info3>Extase</info3>
        <info4>1933</info4>
    </list>
    <name>Liste API</name>
    <contacts>5</contacts>
    <totalRecords>5</totalRecords>
    <totalDisplayRecords>5</totalDisplayRecords>
</response>