~~NOTOC~~
//[[restapi:start|RESTful API]]//

====== Get List Subscribers ======

==== Overview ====

This method will return the information about an specific distribution list, including the users registered to the list in a paginated fashion.

==== URL ====
Http access method: <wrap notice>GET</wrap>

Parameters on the following URL are inside braces { }
  {base_url}/rest/api/distributionList/{instanceId}/{distListId}/{from}/{size}/{publicKey}/{signature}

^ Parameter Name ^ Description ^
| instanceId | An **instance id** is the workspace identification number, //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| distListId | The distribution list Id |
| from | Defines the offset from the first result you want to fetch \\ //Use **0** to start with the first element// |
| size | Allows you to configure the maximum amount of hits to be returned \\ //By default the max size allowed is **1000**. This could change depending on the usage // |
| publicKey | The public key to access this API. //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| signature | The unique [[restapi:appx_ciphering#SHA256 - Cipher|SHA256]] signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our [[restapi:appx_call_ex|Java Example]] |

==== Response ====

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our [[restapi:appx_resp_xml|Response XML Basics]] section if you want to learn more about the response parts.

<code xml>
<input>distributionList</input>
<status>OK</status>
<description>Completed</description>
<result>
     <distributionlist>
         <id>8669</id>
         <name>Demo</name>
         <totalRecords>1000</totalRecords>
         <currentRecords>5</currentRecords>
         <users>
            <user>
               <mobileNumber>5840000001</mobileNumber>
               <parameters>
                  <parameter>
                     <key>key1</key>
                     <value>value1</value>
                  </parameter>
                  ...
                  <parameter>
                     <key>key2</key>
                     <value>value2</value>
                  </parameter>                  
               </parameters>
            </user>
            ...
            <user>
               <mobileNumber>5840000002</mobileNumber>
               <parameters>
                  <parameter>
                     <key>key1</key>
                     <value>value1</value>
                  </parameter>
                  ...
                  <parameter>
                     <key>key2</key>
                     <value>value2</value>
                  </parameter>                  
               </parameters>
            </user>
         </users>
     </distributionlist>
</result>

</code>

== Result parameters ==

^ Parameter Name ^ Description ^ Possible Values ^
| distributionlist.id | The distribution list Id | Number |
| distributionlist.name | Name of the distribution list | Text |
| distributionlist.totalRecords | How many users are registered to the list (total) | Number |
| distributionlist.currentRecords | How many users are contained on this response (related to the single call) | Number |
| distributionlist.users.user.mobileNumber | User's Mobile Number  | Text |
| distributionlist.users.user.parameters.parameter.key | List parameter name | Text |
| distributionlist.users.user.parameters.parameter.value | List parameter value  | Text |