SearchApi.md

ClickSend\SearchApi

All URIs are relative to https://rest.clicksend.com/v3

Method	HTTP request	Description
searchContactsListsGet	GET /search/contacts-lists	Get list of searched contact list

searchContactsListsGet

string searchContactsListsGet($q, $page, $limit)

Get list of searched contact list

Get list of searched contact list

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
$config = ClickSend\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new ClickSend\Api\SearchApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$q = "q_example"; // string | Your keyword or query.
$page = 1; // int | Page number
$limit = 10; // int | Number of records per page

try {
    $result = $apiInstance->searchContactsListsGet($q, $page, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchApi->searchContactsListsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
q	string	Your keyword or query.
page	int	Page number	[optional] [default to 1]
limit	int	Number of records per page	[optional] [default to 10]

Return type

string

Authorization

BasicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]