Nomadesk API

Controller: Partner Management: SearchPartners

SearchPartners

Search partner

This API call supports our standard API filtering, sorting (see separate documentation).

Authentication Methods


  1. With AMS username and password
Input Parameter Type Description
Token* String Security token
Output Parameter Type Description
Success Boolean

*=required

Global search

CURL EXAMPLE
curl -v 'https://example.com/ctrller/api.php?Token=cv816l1113ntof478sovgjcdv6&Task=SearchPartners'
RESPONSE

<Response>
        <Status>1</Status>
        <Message>Success</Message>
        <TotalCount>3</TotalCount>
        <Partners>
            <Partner>
                <Name>nmra000029</Name>
                <Email>partner@nomadesk.com</Email>
                <Company>nomadesk</Company>
        <Type>Sales</Type>
                <Status>Approved</Status>
                <Phone>+32 9 240 10 39</Phone>
                <Created>1486386277</Created>
            </Partner>
            <Partner>
                <Name>nmra000015</Name>
                <Email>partner2@nomadesk.com</Email>
                <Company>nomadesk</Company>
        <Type>Reseller</Type>
                <Status>Pending</Status>
                <Phone>+32 9 240 10 39</Phone>
        <Created>1473767610</Created>
            </Partner>
            <Partner>
                <Name>nmra24911084678</Name>
                <Email>partner3@nomadesk.com</Email>
                <Company>none</Company>
                <Status>Approved</Status>
        <Type>Distributor</Type>
        <Phone>+32 9 240 10 39</Phone>
                <Created>1473759048</Created>
            </Partner>
        </Partners>
</Response>

Search with Email address

CURL EXAMPLE
curl -v 'https://secure.nomadesk.com/ctrller/api.php?Token=cv816l1113ntof478sovgjcdv6&Task=SearchPartners&FilterBy=Email&FilterValue=partner@nomadesk.com'
RESPONSE
    
    <Response>
        <Status>1</Status>
        <Message>Success</Message>
        <TotalCount>1</TotalCount>
        <Partners>
            <Partner>
                <Name>nmra000029</Name>
                <Email>partner@nomadesk.com</Email>
                <Company>nomadesk</Company>
                <Status>Approved</Status>
        <Type>Sales</Type>
                <Phone>+32 9 240 10 39</Phone>
                <Created>1486386277</Created>
            </Partner>
        </Partners>
</Response>