Get contacts

Get all the contacts matching the following parameters

Endpoint

Method	URI
POST	https://apiv2.keliweb.it/api/v2/keliweb/get-contacts

Request Parameters

Parameter	Type	Description	Required
HTTP headers: Authorization	string	Bearer + the token to access APIs	Required
limitstart	integer	The offset for the returned log data (default: 0)	Optional
limitnum	integer	The number of records to return (default: 25)	Optional
firstname	string	Find contacts with a specific first name	Optional
lastname	string	Find contacts with a specific last name	Optional
companyname	string	Find contacts with a specific company name	Optional
email	string	Find contacts with a specific email address	Optional
address1	string	Find contacts with a specific address line 1	Optional
address2	string	Find contacts with a specific address line 2	Optional
city	string	Find contacts with a specific city	Optional
state	string	Find contacts with a specific state	Optional
postcode	string	Find contacts with a specific post/zip code	Optional
country	string	Find contacts with a specific country	Optional
phonenumber	string	Find contacts with a specific phone number	Optional
subaccount	boolean	Search for sub-accounts	Optional

Response Parameters

Parameter	Type	Description
result	string	The result of the operation: success or error
totalresults	integer	The total number of results available
startnumber	integer	The starting number for the returned results
numreturned	integer	The total number of results returned
contacts	array	The contact entries returned

Example Request (PHP Curl)

            

                    $curl = curl_init();
                    
                    curl_setopt_array($curl, array(
                      CURLOPT_URL => "https://apiv2.keliweb.it/api/v2/keliweb/get-contacts",
                      CURLOPT_RETURNTRANSFER => true,
                      CURLOPT_ENCODING => "",
                      CURLOPT_MAXREDIRS => 10,
                      CURLOPT_TIMEOUT => 0,
                      CURLOPT_FOLLOWLOCATION => false,
                      CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
                      CURLOPT_CUSTOMREQUEST => "POST",
                      CURLOPT_POSTFIELDS =>
                        http_build_query(
                                array(
                                    'userid' => '1'
                                )
                            ),
                      CURLOPT_HTTPHEADER => array(
                        "Content-Type: multipart/form-data",
                        "X-Requested-With: XMLHttpRequest",
                        "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NhMmNlNkNjNhMmU2MmUxIzZDRkODY5MS1mMDMzLTQ1MWMtYjU-3EHc",
                      ),
                    ));
                    
                    $response = curl_exec($curl);
                    $err = curl_error($curl);
                    
                    curl_close($curl);
                    
                    if ($err) {
                      echo "cURL Error #:" . $err;
                    } else {
                      echo $response;
                    }

            
        

Example Request (jQuery AJAX)

            
                    var form = new FormData();
                    form.append("userid", "1");

                    var settings = {
                        "async": true,
                        "crossDomain": true,
                        "url": "https://apiv2.keliweb.it/api/v2/keliweb/get-contacts",
                        "method": "POST",
                        "headers": {
                            "Authorization": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImNjMDEwYWVlYmUzMjMxMmZlZjBiNzRjYTBhMmNlNDc2MjNjNhMMTA1MzJjODk1In0",
                            "cache-control": "no-cache",
                        },
                        "processData": false,
                        "contentType": false,
                        "mimeType": "multipart/form-data",
                        "data": form
                    }

                    $.ajax(settings).done(function (response) {
                        console.log(response);
                    });
            
        

Example Response (JSON payload)

            
                {
                    "result": "success",
                    "totalresults": "1",
                    "startnumber": "0",
                    "numreturned": "1",
                    "contacts[contact][0][id]": "1",
                    "contacts[contact][0][userid]": "1",
                    "contacts[contact][0][firstname]": "Test",
                    "contacts[contact][0][lastname]": "Contact",
                    "contacts[contact][0][companyname]": "",
                    "contacts[contact][0][email]": "contact@example.com",
                    "contacts[contact][0][address1]": "404 Street Not Found",
                    "contacts[contact][0][address2]": "",
                    "contacts[contact][0][city]": "Test",
                    "contacts[contact][0][state]": "Tester",
                    "contacts[contact][0][postcode]": "TE5 5ST",
                    "contacts[contact][0][country]": "GB",
                    "contacts[contact][0][phonenumber]": "",
                    "contacts[contact][0][subaccount]": "0",
                    "contacts[contact][0][password]": "$2y$10$WuJGdclhF0cocxoKCzNpF.4OfAQNOmbXpg9z0Mt1d977oAPYPoZhq",
                    "contacts[contact][0][permissions]": "",
                    "contacts[contact][0][domainemails]": "1",
                    "contacts[contact][0][generalemails]": "1",
                    "contacts[contact][0][invoiceemails]": "1",
                    "contacts[contact][0][productemails]": "1",
                    "contacts[contact][0][supportemails]": "1",
                    "contacts[contact][0][affiliateemails]": "1",
                    "contacts[contact][0][pwresetkey]": "",
                    "contacts[contact][0][created_at]": "0000-00-00 00:00:00",
                    "contacts[contact][0][updated_at]": "0000-00-00 00:00:00",
                    "contacts[contact][0][pwresetexpiry]": "0000-00-00 00:00:00"
                }