API › User.GetClients

User.GetClients

Gets all clients for a given user.

Parameters and required information

Here’s a list of all the parameters you’ll need to pass to the User.GetClients method. All of the parameters are required unless otherwise noted.

ApiKey
Your API application key. See here for more details.

Return Codes

Success

Upon a successful call, this method will return a collection of Client objects, each of which consists of a ClientID, and the name of the client.

Error

100: Invalid API Key
The API key pass was not valid or has expired.

SOAP 1.1

The following is a sample SOAP request and response. The placeholders shown need to be replaced with actual values.

POST /api/api.asmx HTTP/1.1
Host: api.createsend.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.createsend.com/api/User.GetClients"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <User.GetClients xmlns="http://api.createsend.com/api/">
      <ApiKey>string</ApiKey>
    </User.GetClients>
  </soap:Body>
</soap:Envelope>
 
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

  <soap:Body>
    <User.GetClientsResponse xmlns="http://api.createsend.com/api/">
      <User.GetClientsResult>
        <Client>
          <ClientID>string</ClientID>
          <Name>string</Name>
        </Client>
        <Client>
          <ClientID>string</ClientID>
          <Name>string</Name>
        </Client>
      </User.GetClientsResult>
    </User.GetClientsResponse>
  </soap:Body>
</soap:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /api/api.asmx/User.GetClients?ApiKey=string HTTP/1.1
Host: api.createsend.com
 
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfClient xmlns="http://api.createsend.com/api/">
  <Client>
    <ClientID>string</ClientID>
    <Name>string</Name>
  </Client>
  <Client>
    <ClientID>string</ClientID>
    <Name>string</Name>
  </Client>
</ArrayOfClient>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /api/api.asmx/User.GetClients HTTP/1.1
Host: api.createsend.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

ApiKey=string
 
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfClient xmlns="http://api.createsend.com/api/">
  <Client>
    <ClientID>string</ClientID>
    <Name>string</Name>
  </Client>
  <Client>
    <ClientID>string</ClientID>
    <Name>string</Name>
  </Client>
</ArrayOfClient>