Skip to content

ContactGroupApi.md

Latest commit

 

History

History
64 lines (43 loc) · 2.13 KB

ContactGroupApi.md

File metadata and controls

64 lines (43 loc) · 2.13 KB

SynergiTech\Iplicit\ContactGroupApi

All URIs are relative to https://api.iplicit.com, except if the operation defines another base path.

Method HTTP request Description
getContactGroup() GET /api/ContactGroup/{contactGroupRef} Get a contact group

getContactGroup()

getContactGroup($contactGroupRef, $include): \SynergiTech\Iplicit\Model\ContactGroupRead

Get a contact group

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new SynergiTech\Iplicit\Api\ContactGroupApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$contactGroupRef = 'contactGroupRef_example'; // string | Id or code of the contact group
$include = 'customer,supplier'; // string | Comma separated list of details to include: Permitted values are `customer`, `supplier` or `customer,supplier` (the default)

try {
    $result = $apiInstance->getContactGroup($contactGroupRef, $include);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactGroupApi->getContactGroup: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
contactGroupRef string Id or code of the contact group
include string Comma separated list of details to include: Permitted values are `customer`, `supplier` or `customer,supplier` (the default) [optional] [default to 'customer,supplier']

Return type

\SynergiTech\Iplicit\Model\ContactGroupRead

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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