All URIs are relative to https://api.insightly.com/v3.0
| Method | HTTP request | Description |
|---|---|---|
| addActivitySetAssignment | POST /Contacts/{id}/ActivitySetAssignment | Adds an Activity Set to a Contact |
| addDate | POST /Contacts/{id}/Dates | Adds a Date |
| addEntity | POST /Contacts | Adds a Contact |
| addFileAttachment | POST /Contacts/{id}/FileAttachments | Adds a File Attachment to a Contact |
| addFollow | POST /Contacts/{id}/Follow | Start following a Contact |
| addLink | POST /v3.0/Contacts/{id}/Links | Adds a Link |
| addNotes | POST /Contacts/{id}/Notes | Adds a Note to a Contact |
| addTag | POST /Contacts/{id}/Tags | Adds a Tag |
| deleteDate | DELETE /Contacts/{id}/Dates/{dateId} | Deletes a Date |
| deleteEntity | DELETE /Contacts/{id} | Deletes a Contact |
| deleteFollow | DELETE /Contacts/{id}/Follow | Stop following a Contact |
| deleteImage | DELETE /Contacts/{id}/Image | Deletes a Contact's Image |
| deleteLink | DELETE /Contacts/{id}/Links/{linkId} | Deletes a Link |
| deleteTag | DELETE /Contacts/{id}/Tags/{tagName} | Deletes a Tag |
| getEmails | GET /Contacts/{id}/Emails | Gets a list of a Contact's Emails |
| getEntities | GET /Contacts | Gets a list of Contacts |
| getEntitiesBySearch | GET /Contacts/Search | Gets a filtered list of Contacts |
| getEntitiesByTag | GET /Contacts/SearchByTag | Gets a list of Contacts filtered by tags |
| getEntity | GET /Contacts/{id} | Gets a Contact |
| getEvents | GET /Contacts/{id}/Events | Gets a Contact's Events |
| getFileAttachments | GET /Contacts/{id}/FileAttachments | Gets a Contact's File Attachments |
| getFollow | GET /Contacts/{id}/Follow | Gets a Follow state for a Contact |
| getImage | GET /Contacts/{id}/Image | Gets a Contact's Image |
| getLinks | GET /v3.0/Contacts/{id}/Links | Gets a Contact's Links |
| getNotes | GET /Contacts/{id}/Notes | Gets a Contact's Notes |
| getTasks | GET /Contacts/{id}/Tasks | Gets a list of a Contact's Tasks |
| updateDate | PUT /Contacts/{id}/Dates | Updates a Date |
| updateEntity | PUT /Contacts | Updates a Contact |
| updateImage | PUT /Contacts/{id}/Image/{filename} | Updates a Contact's Image |
| updateLink | PUT /v3.0/Contacts/{id}/Links | Updates a Link |
| updateNotes | PUT /Contacts/{id}/Notes | Updates a note of a Contact |
\Swagger\Client\Model\APIActivitySetAssignment addActivitySetAssignment($id, $authorization, $api_activity_set_assignment)
Adds an Activity Set to a Contact
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
$api_activity_set_assignment = new \Swagger\Client\Model\APIActivitySetAssignment(); // \Swagger\Client\Model\APIActivitySetAssignment | The Activity Set Assignment object which contains the configuration information for the Activity Set (just include JSON object as request body)
try {
$result = $apiInstance->addActivitySetAssignment($id, $authorization, $api_activity_set_assignment);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->addActivitySetAssignment: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| api_activity_set_assignment | \Swagger\Client\Model\APIActivitySetAssignment | The Activity Set Assignment object which contains the configuration information for the Activity Set (just include JSON object as request body) |
\Swagger\Client\Model\APIActivitySetAssignment
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APIDate addDate($id, $authorization, $api_date)
Adds a Date
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 Contact's ID (CONTACT_ID)
$authorization = "{{Authorization}}"; // string | Authorization
$api_date = new \Swagger\Client\Model\APIDate(); // \Swagger\Client\Model\APIDate | The Contact Date to add (just include JSON object as request body)
try {
$result = $apiInstance->addDate($id, $authorization, $api_date);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->addDate: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Contact's ID (CONTACT_ID) | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| api_date | \Swagger\Client\Model\APIDate | The Contact Date to add (just include JSON object as request body) |
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\Contact addEntity($authorization, $field_values)
Adds a Contact
If you have trouble with creating a Contact, try creating Contacts via the web interface, and then access those Contacts via the API. This way you can see examples of the fields and sub-elements attached to the Contact. A common source of problems during write/update request is caused when users omit required fields, or insert invalid data in a field (e.g. reference a CATEGORY_ID that does not exist in the user's Insightly instance.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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
$field_values = new \Swagger\Client\Model\Contact2(); // \Swagger\Client\Model\Contact2 | The record to add (just include the JSON object as the request body)
try {
$result = $apiInstance->addEntity($authorization, $field_values);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->addEntity: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| authorization | string | Authorization | [default to {{Authorization}}] |
| field_values | \Swagger\Client\Model\Contact2 | The record to add (just include the JSON object as the request body) |
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APIFileAttachment addFileAttachment($id, $file, $authorization, $file_name, $content_type, $file_category_id)
Adds a File Attachment to a Contact
This endpoint expects multipart/form-data as the request payload. See Stack Overflow for examples of how to generate multipart requests, or see our <a href="http://github.com/Insightly\" target="_blank">client libraries for an example of how this is generated. Only one file can be added per request.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 | Record ID
$file = "/path/to/file.txt"; // \SplFileObject | The file part of the multipart/form-data request. Only one file can be added per request.
$authorization = "{{Authorization}}"; // string | Authorization
$file_name = "file_name_example"; // string |
$content_type = "content_type_example"; // string |
$file_category_id = 56; // int |
try {
$result = $apiInstance->addFileAttachment($id, $file, $authorization, $file_name, $content_type, $file_category_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->addFileAttachment: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | Record ID | |
| file | \SplFileObject | The file part of the multipart/form-data request. Only one file can be added per request. | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| file_name | string | [optional] | |
| content_type | string | [optional] | |
| file_category_id | int | [optional] |
\Swagger\Client\Model\APIFileAttachment
No authorization required
- Content-Type: multipart/form-data
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APIFollow addFollow($id, $authorization)
Start following a Contact
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 Record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization
try {
$result = $apiInstance->addFollow($id, $authorization);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->addFollow: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID (RECORD_ID) | |
| authorization | string | Authorization | [default to {{Authorization}}] |
\Swagger\Client\Model\APIFollow
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APILinkDto addLink($id, $authorization, $api_link)
Adds a Link
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 Record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization
$api_link = new \Swagger\Client\Model\APILinkDto(); // \Swagger\Client\Model\APILinkDto | The Link to add (just include JSON object as request body)
try {
$result = $apiInstance->addLink($id, $authorization, $api_link);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->addLink: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID (RECORD_ID) | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| api_link | \Swagger\Client\Model\APILinkDto | The Link to add (just include JSON object as request body) |
\Swagger\Client\Model\APILinkDto
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APINote addNotes($id, $authorization, $field_values)
Adds a Note to a Contact
If you have trouble with creating a Contact, try creating Contacts via the web interface, and then access those Contacts via the API. This way you can see examples of the fields and sub-elements attached to the Contact. A common source of problems during write/update request is caused when users omit required fields, or insert invalid data in a field (e.g. reference a CATEGORY_ID that does not exist in the user's Insightly instance.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 Record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization
$field_values = new \Swagger\Client\Model\APINote(); // \Swagger\Client\Model\APINote | The record to add (just include the JSON object as the request body)
try {
$result = $apiInstance->addNotes($id, $authorization, $field_values);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->addNotes: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID (RECORD_ID) | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| field_values | \Swagger\Client\Model\APINote | The record to add (just include the JSON object as the request body) |
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APITag addTag($id, $authorization, $api_tag)
Adds a Tag
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 | The record's ID
$authorization = "{{Authorization}}"; // string | Authorization
$api_tag = new \Swagger\Client\Model\APITag(); // \Swagger\Client\Model\APITag | The Tag to add (just include the JSON object as the request body)
try {
$result = $apiInstance->addTag($id, $authorization, $api_tag);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->addTag: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | The record's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| api_tag | \Swagger\Client\Model\APITag | The Tag to add (just include the JSON object as the request body) |
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteDate($id, $date_id, $authorization)
Deletes a Date
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 Record's ID
$date_id = 789; // int | A Date's ID (DATE_ID)
$authorization = "{{Authorization}}"; // string | Authorization
try {
$apiInstance->deleteDate($id, $date_id, $authorization);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->deleteDate: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID | |
| date_id | int | A Date's ID (DATE_ID) | |
| authorization | string | Authorization | [default to {{Authorization}}] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteEntity($id, $authorization)
Deletes a Contact
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 | Entity's ID
$authorization = "{{Authorization}}"; // string | Authorization
try {
$apiInstance->deleteEntity($id, $authorization);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->deleteEntity: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | Entity's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteFollow($id, $authorization)
Stop following a Contact
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 Record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization
try {
$apiInstance->deleteFollow($id, $authorization);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->deleteFollow: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID (RECORD_ID) | |
| authorization | string | Authorization | [default to {{Authorization}}] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteImage($id, $authorization)
Deletes a Contact's Image
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
try {
$apiInstance->deleteImage($id, $authorization);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->deleteImage: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteLink($id, $link_id, $authorization)
Deletes a Link
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 Record's ID (RECORD_ID)
$link_id = 789; // int | A Link's ID (LINK_ID)
$authorization = "{{Authorization}}"; // string | Authorization
try {
$apiInstance->deleteLink($id, $link_id, $authorization);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->deleteLink: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID (RECORD_ID) | |
| link_id | int | A Link's ID (LINK_ID) | |
| authorization | string | Authorization | [default to {{Authorization}}] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteTag($id, $tag_name, $authorization)
Deletes a Tag
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 | The record's ID
$tag_name = "tag_name_example"; // string | A Tag's name
$authorization = "{{Authorization}}"; // string | Authorization
try {
$apiInstance->deleteTag($id, $tag_name, $authorization);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->deleteTag: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | The record's ID | |
| tag_name | string | A Tag's name | |
| authorization | string | Authorization | [default to {{Authorization}}] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APIEmail[] getEmails($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total)
Gets a list of a Contact's Emails
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
$updated_after_utc = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Optional, earliest date when email was last updated.
$top = 56; // int | Optional, maximum number of emails to return.
$skip = 56; // int | Optional, number of emails to skip.
$brief = false; // bool | true if only top level properties needs to be returned.
$count_total = false; // bool | true if total number of records should be returned in the response headers.
try {
$result = $apiInstance->getEmails($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->getEmails: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| updated_after_utc | \DateTime | Optional, earliest date when email was last updated. | [optional] |
| top | int | Optional, maximum number of emails to return. | [optional] |
| skip | int | Optional, number of emails to skip. | [optional] |
| brief | bool | true if only top level properties needs to be returned. | [optional] [default to false] |
| count_total | bool | true if total number of records should be returned in the response headers. | [optional] [default to false] |
\Swagger\Client\Model\APIEmail[]
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object[] getEntities($authorization, $brief, $skip, $top, $count_total)
Gets a list of Contacts
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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
$brief = false; // bool | Optional, true if response should only contain top level properties of the record.
$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->getEntities($authorization, $brief, $skip, $top, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->getEntities: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| authorization | string | Authorization | [default to {{Authorization}}] |
| brief | bool | Optional, true if response should only contain top level properties of the record. | [optional] [default to false] |
| 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] |
object[]
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object[] getEntitiesBySearch($authorization, $field_name, $field_value, $brief, $skip, $top, $count_total)
Gets a filtered list of Contacts
To filter with a field name and value, both field_name and field_value parameters must be provided.
Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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
$field_name = "field_name_example"; // string | Optional, field name for object
$field_value = "field_value_example"; // string | Optional, field value of the record
$brief = false; // bool | Optional, true if response should only contain top level properties of the record.
$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->getEntitiesBySearch($authorization, $field_name, $field_value, $brief, $skip, $top, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->getEntitiesBySearch: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| authorization | string | Authorization | [default to {{Authorization}}] |
| field_name | string | Optional, field name for object | [optional] |
| field_value | string | Optional, field value of the record | [optional] |
| brief | bool | Optional, true if response should only contain top level properties of the record. | [optional] [default to false] |
| 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] |
object[]
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object[] getEntitiesByTag($tag_name, $authorization, $brief, $skip, $top, $count_total)
Gets a list of Contacts filtered by tags
Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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()
);
$tag_name = "tag_name_example"; // string | Tag name to filter on
$authorization = "{{Authorization}}"; // string | Authorization
$brief = false; // bool | Optional, true if response should only contain top level properties of the record.
$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->getEntitiesByTag($tag_name, $authorization, $brief, $skip, $top, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->getEntitiesByTag: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| tag_name | string | Tag name to filter on | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| brief | bool | Optional, true if response should only contain top level properties of the record. | [optional] [default to false] |
| 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] |
object[]
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\Contact getEntity($id, $authorization)
Gets a Contact
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 | The record's ID
$authorization = "{{Authorization}}"; // string | Authorization
try {
$result = $apiInstance->getEntity($id, $authorization);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->getEntity: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | The record's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APIEvent[] getEvents($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total)
Gets a Contact's Events
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
$updated_after_utc = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Optional, earliest date when event was last updated.
$top = 56; // int | Optional, maximum number of events to return.
$skip = 56; // int | Optional, number of events to skip.
$brief = false; // bool | true if only top level properties needs to be returned.
$count_total = false; // bool | true if total number of records should be returned in the response headers.
try {
$result = $apiInstance->getEvents($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->getEvents: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| updated_after_utc | \DateTime | Optional, earliest date when event was last updated. | [optional] |
| top | int | Optional, maximum number of events to return. | [optional] |
| skip | int | Optional, number of events to skip. | [optional] |
| brief | bool | true if only top level properties needs to be returned. | [optional] [default to false] |
| count_total | bool | true if total number of records should be returned in the response headers. | [optional] [default to false] |
\Swagger\Client\Model\APIEvent[]
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APIFileAttachment[] getFileAttachments($id, $authorization, $updated_after_utc, $skip, $top, $count_total)
Gets a Contact's File Attachments
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
$updated_after_utc = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Optional, earliest date when file attachment was last updated.
$skip = 56; // int | Optional, number of file attachments to skip.
$top = 56; // int | Optional, maximum number of file attachments to return in the response.
$count_total = false; // bool | true if total number of records should be returned in the response headers.
try {
$result = $apiInstance->getFileAttachments($id, $authorization, $updated_after_utc, $skip, $top, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->getFileAttachments: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| updated_after_utc | \DateTime | Optional, earliest date when file attachment was last updated. | [optional] |
| skip | int | Optional, number of file attachments to skip. | [optional] |
| top | int | Optional, maximum number of file attachments to return in the response. | [optional] |
| count_total | bool | true if total number of records should be returned in the response headers. | [optional] [default to false] |
\Swagger\Client\Model\APIFileAttachment[]
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APIFollow getFollow($id, $authorization)
Gets a Follow state for a Contact
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization
try {
$result = $apiInstance->getFollow($id, $authorization);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->getFollow: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A record's ID (RECORD_ID) | |
| authorization | string | Authorization | [default to {{Authorization}}] |
\Swagger\Client\Model\APIFollow
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getImage($id, $authorization)
Gets a Contact's Image
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
try {
$apiInstance->getImage($id, $authorization);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->getImage: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APILinkDto[] getLinks($id, $authorization)
Gets a Contact's Links
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
try {
$result = $apiInstance->getLinks($id, $authorization);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->getLinks: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
\Swagger\Client\Model\APILinkDto[]
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APINote[] getNotes($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total)
Gets a Contact's Notes
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 Record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization
$updated_after_utc = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Optional, earliest date when note was last updated.
$top = 56; // int | Optional, maximum number of notes to return.
$skip = 56; // int | Optional, number of notes to skip.
$brief = false; // bool | true if only top level properties needs to be returned.
$count_total = false; // bool | true if total number of records should be returned in the response headers.
try {
$result = $apiInstance->getNotes($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->getNotes: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID (RECORD_ID) | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| updated_after_utc | \DateTime | Optional, earliest date when note was last updated. | [optional] |
| top | int | Optional, maximum number of notes to return. | [optional] |
| skip | int | Optional, number of notes to skip. | [optional] |
| brief | bool | true if only top level properties needs to be returned. | [optional] [default to false] |
| count_total | bool | true if total number of records should be returned in the response headers. | [optional] [default to false] |
\Swagger\Client\Model\APINote[]
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APITask[] getTasks($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total)
Gets a list of a Contact's Tasks
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
$updated_after_utc = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Optional, earliest date when task was last updated.
$top = 56; // int | Optional, maximum number of tasks to return.
$skip = 56; // int | Optional, number of tasks to skip.
$brief = false; // bool | true if only top level properties needs to be returned.
$count_total = false; // bool | true if total number of records should be returned in the response headers.
try {
$result = $apiInstance->getTasks($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->getTasks: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| updated_after_utc | \DateTime | Optional, earliest date when task was last updated. | [optional] |
| top | int | Optional, maximum number of tasks to return. | [optional] |
| skip | int | Optional, number of tasks to skip. | [optional] |
| brief | bool | true if only top level properties needs to be returned. | [optional] [default to false] |
| count_total | bool | true if total number of records should be returned in the response headers. | [optional] [default to false] |
\Swagger\Client\Model\APITask[]
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APIDate updateDate($id, $authorization, $api_contact_date)
Updates a Date
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 Record's ID
$authorization = "{{Authorization}}"; // string | Authorization
$api_contact_date = new \Swagger\Client\Model\APIDate(); // \Swagger\Client\Model\APIDate | The Date to add (just include the JSON object as request body)
try {
$result = $apiInstance->updateDate($id, $authorization, $api_contact_date);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->updateDate: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| api_contact_date | \Swagger\Client\Model\APIDate | The Date to add (just include the JSON object as request body) |
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\Contact updateEntity($authorization, $field_values)
Updates a Contact
If you have trouble updating a Contact, try accessing the Contact via the GET request to inspect its fields and sub-elements. A common source of problems with write/update requests occurs when users either omit required fields, or insert invalid data into a field (for example, by referring a CATEGORY_ID or LINK_ID which does not exist.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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
$field_values = new \Swagger\Client\Model\Contact1(); // \Swagger\Client\Model\Contact1 | The record to update (just include the JSON object as the request body)
try {
$result = $apiInstance->updateEntity($authorization, $field_values);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->updateEntity: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| authorization | string | Authorization | [default to {{Authorization}}] |
| field_values | \Swagger\Client\Model\Contact1 | The record to update (just include the JSON object as the request body) |
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object[] updateImage($id, $filename, $authorization, $file)
Updates a Contact's Image
This action will replace any existing Image attached to the Contact. The contents of the image data should be sent as binary data in the request payload. See our <a href="http://github.com/Insightly\" target="_blank">client libraries for an example of how this is done.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 Record's ID
$filename = "filename_example"; // string | Name of Image File to be attached to Record
$authorization = "{{Authorization}}"; // string | Authorization
$file = "B"; // string | File to upload
try {
$result = $apiInstance->updateImage($id, $filename, $authorization, $file);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->updateImage: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID | |
| filename | string | Name of Image File to be attached to Record | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| file | string | File to upload |
object[]
No authorization required
- Content-Type: application/octet-stream
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APILinkDto updateLink($id, $authorization, $api_link)
Updates a Link
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 Record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization
$api_link = new \Swagger\Client\Model\APILinkDto(); // \Swagger\Client\Model\APILinkDto | The Link to add (just include JSON object as request body)
try {
$result = $apiInstance->updateLink($id, $authorization, $api_link);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->updateLink: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID (RECORD_ID) | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| api_link | \Swagger\Client\Model\APILinkDto | The Link to add (just include JSON object as request body) |
\Swagger\Client\Model\APILinkDto
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\APINote updateNotes($id, $authorization, $field_values, $brief)
Updates a note of a Contact
If you have trouble updating a Contact, try accessing the Contact via the GET request to inspect its fields and sub-elements. A common source of problems with write/update requests occurs when users either omit required fields, or insert invalid data into a field (for example, by referring a CATEGORY_ID or LINK_ID which does not exist.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ContactsApi(
// 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 Record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization
$field_values = new \Swagger\Client\Model\APINote(); // \Swagger\Client\Model\APINote | The record to update (just include the JSON object as the request body)
$brief = false; // bool | Optional, true if response should only contain top level properties of the record.
try {
$result = $apiInstance->updateNotes($id, $authorization, $field_values, $brief);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->updateNotes: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID (RECORD_ID) | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| field_values | \Swagger\Client\Model\APINote | The record to update (just include the JSON object as the request body) | |
| brief | bool | Optional, true if response should only contain top level properties of the record. | [optional] [default to false] |
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]