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

====== List Campaigns ======

==== Previous Versions ====
<wrap button>[[restapi:list_campaigns_3_34|Tag 34]]</wrap>

==== Overview ====

List all campaigns for the given user, you also can narrow the results using the campaign name.

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

Parameters on the following URL are inside braces { }
  {base_url}/rest/api/mims/{instanceId}/{userName}/{campaignName}/{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// |
| userName | The user name that owns the campaigns. This parameter must be [[restapi:appx_ciphering|Base64 encoded]] |
| campaignName \\ <wrap notice>OPTIONAL</wrap> | The desired campaign name \\ <wrap info>Use **null** to ignore this parameter</wrap>. This parameter must be [[restapi:appx_ciphering|Base64 encoded]] |
| 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>getMims</input>
<status>OK</status>
<description>Completed</description>
<result>
	<mIMs>
		<mim>
			<id>1</id>
			<msgtype>1</msgtype>
			<name>MIM1</name>
			<description>*</description>
			<functionTag>DEFAULT</functionTag>
			<active>1</active>
		</mim>

		...

		<mim>
			<id>2</id>
			<msgtype>2</msgtype>
			<name>MIM2</name>
			<description>*</description>
			<functionTag>DEFAULT</functionTag>
			<active>1</active>
		</mim>
	</mIMs>
</result>
</code>