Skip to content

Latest commit

 

History

History
115 lines (81 loc) · 3.9 KB

PipelinesApi.md

File metadata and controls

115 lines (81 loc) · 3.9 KB

SternerStuff\InsightlyPHP\PipelinesApi

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

Method HTTP request Description
getPipeline GET /Pipelines/{id} Gets a Pipeline
getPipelines GET /Pipelines Gets a list of Pipelines

getPipeline

getPipeline($id, $authorization)

Gets a Pipeline

This endpoint returns the graph for a specific pipeline.

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\PipelinesApi(
    // 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()
);
$id = 789; // int | A Pipeline's ID
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $apiInstance->getPipeline($id, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->getPipeline: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int A Pipeline's ID
authorization string Authorization [default to {{Authorization}}]

Return type

void (empty response body)

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]

getPipelines

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

Gets a list of Pipelines

This read only endpoint returns a list of pipelines that have been set up for the Insightly instance. Pipelines can be defined for both projects and opportunities, and are used to track the progression of projects and opportunities. To create and update pipelines, you'll need to go to the web app (API access is read-only).

Example

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\PipelinesApi(
    // 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 pipelines to skip.
$top = 56; // int | Optional, maximum number of pipelines 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->getPipelines($authorization, $skip, $top, $count_total);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PipelinesApi->getPipelines: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
authorization string Authorization [default to {{Authorization}}]
skip int Optional, number of pipelines to skip. [optional]
top int Optional, maximum number of pipelines 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]