RelationshipsApi.md

Swagger\Client\RelationshipsApi

All URIs are relative to https://api.insightly.com/v3.0

Method	HTTP request	Description
getRelationships	GET /Relationships	Gets a list of Relationships

getRelationships

object[] getRelationships($authorization, $skip, $top, $count_total)

Gets a list of Relationships

This read only endpoint returns a list of the relationships that have been defined for the Insightly instance. Relationships enable users to define how one Insightly object is related to another. For example: contact A is a customer of contact B. The API only supports read access to relationships, to create or update relationships, you'll need to do so via the web app.

Example

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

$apiInstance = new Swagger\Client\Api\RelationshipsApi(
    // 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()
);
$authorization = "{{Authorization}}"; // string | Authorization
$skip = 56; // int | Optional, number of records to skip.
$top = 56; // int | Optional, maximum number of records to return in the response.
$count_total = false; // bool | Optional, true if total number of records should be returned in the response headers.

try {
    $result = $apiInstance->getRelationships($authorization, $skip, $top, $count_total);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RelationshipsApi->getRelationships: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
authorization	string	Authorization	[default to {{Authorization}}]
skip	int	Optional, number of records to skip.	[optional]
top	int	Optional, maximum number of records to return in the response.	[optional]
count_total	bool	Optional, true if total number of records should be returned in the response headers.	[optional] [default to false]

Return type

object[]

Authorization

No authorization required

HTTP request headers

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

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