Web Service Documentation / Categories / Basic Account Services / Get Customer List

Get Customer List

Updated on February 10, 2014

Description

This web service returns a list of customers that you are connected to.

Version

9.0

HTTP Method

GET

Resource URL

/customer/list

Header

Field Name Value Comments
Authorization Basic credentials

Authorization Required

Yes

Parameters

None

XML Schemas

Request/Response Schema Name
Request None
Response response.xsd

Example Request

The following example retrieves a list of customers that you are connected to.

GET  /customer/list

Example Responses

The following example returns a list of customers that you are connected to. The list contains web service links for you to call to retrieve information for each customer. Each link contains a hint that refers to the customer's organization.

<response status="Ok">
    <links>
        <link id="143" hint="QWERTY Company" httpMethod="GET" link="/customer/143"
              linkDescription="This is the GET url for this Customer."/>
        <link id="5432" hint="Galaxy Corp" httpMethod="GET" link="/customer/5432"
              linkDescription="This is the GET url for this Customer."/>
        <link id="5553" hint="Thrift Bank" httpMethod="GET" link="/customer/5553"
              linkDescription="This is the GET url for this Customer."/>
        <link id="1454" httpMethod="GET" link="/customer/1454"
              linkDescription="This is the GET url for this Customer."/>
        <link id="86785" hint="Sample Company" httpMethod="GET" link="/customer/86785"
              linkDescription="This is the GET url for this Customer."/>
    </links>
</response>

A list with no customers is returned. The user is not connected to any customers.

<response status="Ok">
    <links/>
</response>
LIVE