Welcome‎ > ‎Version 3‎ > ‎Publisher Api‎ > ‎Methods‎ > ‎2 - Consumer Related‎ > ‎

Get Consumers

Will retrieve a list of consumers based on the search criteria.

Method: GET /api/v3/publisher/consumers
Authentication: oauth
 
Parameters
Required QueryString Value
Explanation
Yes
EmailThe email address to search for.

Returns
consumers- Will return a list of Consumers.

Sample Request:

GET https://api.groupcommerce.com/api/v3/publisher/consumers?email=testlink123%40groupcommerce.com

OAuth oauth_signature="ZMQQuYVavz%2FEmScqKCDEqrhUXKA%3D", oauth_nonce="2809611", oauth_timestamp="1341437339", oauth_consumer_key="eeb6b959-b854-4ad1-b563-e801c83cf81d", oauth_signature_method="HMAC-SHA1", oauth_version="1.0"

Sample JSON Response:

{
    "errors": [],
    "lastPublished": "/Date(1319851251455)/",
    "success": true,
    "version": "3",
    "metaData": {
        "pageCount": 1,
        "pageNumber": 1,
        "pageSize": 2,
        "totalItems": 2
    },
    "consumers": [
        {
            /* see consumer */
        },
        {
            /* see consumer */
        },

    ]
}


Sample XML Response:

<getConsumersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <errors/>
    <lastPublished>2011-10-29T01:21:24.3165547Z</lastPublished>
    <success>true</success>
    <version>3</version>
    <metaData>
        <pageCount>1</pageCount>
        <pageNumber>1</pageNumber>
        <pageSize>3</pageSize>
        <totalItems>3</totalItems>
    </metaData>
    <consumers>
        <consumer>
            <!--
see consumer -->
        </consumer>
        <consumer>
            <!--
see consumer -->
        </consumer>
        <consumer>
            <!--
see consumer -->
        </consumer>
    </consumer>
</getConsumersResponse>
Comments