Skip to content

sterner-stuff/insightly-php

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SwaggerClient-php

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: v3.1
  • Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/sterner-stuff/insightly-php.git"
    }
  ],
  "require": {
    "sterner-stuff/insightly-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/insightly-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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

$apiInstance = new SternerStuff\InsightlyPHP\Api\ActivitySetsApi(
    // 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 | An Activity Set's ID
$authorization = "{{Authorization}}"; // string | Authorization, see below

try {
    $result = $apiInstance->getActivitySet($id, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ActivitySetsApi->getActivitySet: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

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

Class Method HTTP request Description
ActivitySetsApi getActivitySet GET /ActivitySets/{id} Gets a single Activity Set
ActivitySetsApi getActivitySets GET /ActivitySets Gets a list of Activity Sets
CommentsApi addFileAttachment POST /Comments/{id}/FileAttachments Adds a File Attachment to a Comment
CommentsApi deleteEntity DELETE /Comments/{id} Deletes a Comment
CommentsApi getFileAttachments GET /Comments/{id}/FileAttachments Gets a Comment's File Attachments
CommentsApi updateEntity PUT /Comments Updates a Comment
ContactsApi addActivitySetAssignment POST /Contacts/{id}/ActivitySetAssignment Adds an Activity Set to a Contact
ContactsApi addEntity POST /Contacts Adds a Contact
ContactsApi addFileAttachment POST /Contacts/{id}/FileAttachments Adds a File Attachment to a Contact
ContactsApi addFollow POST /Contacts/{id}/Follow Start following a Contact
ContactsApi addLink POST /Contacts/{id}/Links Adds a Link
ContactsApi addNotes POST /Contacts/{id}/Notes Adds a Note to a Contact
ContactsApi addTag POST /Contacts/{id}/Tags Adds a Tag to a Contact
ContactsApi deleteEntity DELETE /Contacts/{id} Deletes a Contact
ContactsApi deleteFollow DELETE /Contacts/{id}/Follow Stop following a Contact
ContactsApi deleteImage DELETE /Contacts/{id}/Image Deletes a Contact's Image
ContactsApi deleteImageField DELETE /Contacts/{id}/ImageField/{fieldName} Deletes a Contact's Custom Image Field
ContactsApi deleteLink DELETE /Contacts/{id}/Links/{linkId} Deletes a Link
ContactsApi deleteTag DELETE /Contacts/{id}/Tags Deletes a Tag from a Contact
ContactsApi getDates GET /Contacts/{id}/Dates Gets a Contact's Dates
ContactsApi getEmails GET /Contacts/{id}/Emails Gets a list of a Contact's Emails
ContactsApi getEntities GET /Contacts Gets a list of Contacts
ContactsApi getEntitiesBySearch GET /Contacts/Search Gets a filtered list of Contacts
ContactsApi getEntitiesByTag GET /Contacts/SearchByTag Gets a list of Contacts filtered by tags
ContactsApi getEntity GET /Contacts/{id} Gets a Contact
ContactsApi getEvents GET /Contacts/{id}/Events Gets a Contact's Events
ContactsApi getFileAttachments GET /Contacts/{id}/FileAttachments Gets a Contact's File Attachments
ContactsApi getFollow GET /Contacts/{id}/Follow Gets a Follow state for a Contact
ContactsApi getImage GET /Contacts/{id}/Image Gets a Contact's Image
ContactsApi getImageField GET /Contacts/{id}/ImageField/{fieldName} Gets a Contact's Custom Image Field
ContactsApi getLinks GET /Contacts/{id}/Links Gets a Contact's Links
ContactsApi getNotes GET /Contacts/{id}/Notes Gets a Contact's Notes
ContactsApi getTags GET /Contacts/{id}/Tags Gets a Contact's Tags
ContactsApi getTasks GET /Contacts/{id}/Tasks Gets a list of a Contact's Tasks
ContactsApi updateDates PUT /Contacts/{id}/Dates Updates a Contact's Dates
ContactsApi updateEntity PUT /Contacts Updates a Contact
ContactsApi updateImage PUT /Contacts/{id}/Image/{filename} Updates a Contact's Image
ContactsApi updateImageField PUT /Contacts/{id}/ImageField/{fieldName}/{fileName} Updates a Contact's Custom Image Field
ContactsApi updateLink PUT /Contacts/{id}/Links Updates a Link
ContactsApi updateNotes PUT /Contacts/{id}/Notes Updates a note of a Contact
ContactsApi updateTags PUT /Contacts/{id}/Tags Updates a Contact's Tags
CountriesApi getCountries GET /Countries Gets a list of Countries used by Insightly
CurrenciesApi getCurrencies GET /Currencies Gets a list of Currencies used by Insightly
CustomFieldsApi getCustomFields GET /CustomFields/{objectName} Gets a list of Custom Fields
CustomFieldsApi getCustomfieldBySearch GET /CustomFields/{objectName}/Search Gets a Custom Field by name
CustomObjectsApi getCustomObjects GET /CustomObjects Gets a list of custom objects
CustomObjectsApi getCustomObjects_0 GET /CustomObjects/{customObjectName} Gets a custom object by object name
CustomObjectsRecordsApi addEntity POST /{objectName} Adds a record
CustomObjectsRecordsApi addTranslation POST /{objectName}/{id}/Translations/{language} Adds a Translation for a record in a specific language
CustomObjectsRecordsApi deleteEntity DELETE /{objectName}/{id} Deletes a Record
CustomObjectsRecordsApi getEntities GET /{objectName} Gets a list of records
CustomObjectsRecordsApi getEntitiesBySearch GET /{objectName}/Search Gets a filtered list of records
CustomObjectsRecordsApi getEntity GET /{objectName}/{id} Gets a record
CustomObjectsRecordsApi getTranslation GET /{objectName}/{id}/Translations/{language} Gets a record's translation in a specific language
CustomObjectsRecordsApi updateEntity PUT /{objectName} Updates a record
CustomObjectsRecordsApi updateTranslation PUT /{objectName}/{id}/Translations/{language} Updates a record's translation in a specific language
EmailsApi addComment POST /Emails/{id}/Comments Adds a Comment to an Email
EmailsApi addFollow POST /Emails/{id}/Follow Start following an Email
EmailsApi addLink POST /Emails/{id}/Links Adds a Link
EmailsApi addTag POST /Emails/{id}/Tags Adds a Tag to an Email
EmailsApi deleteEntity DELETE /Emails/{id} Deletes an Email
EmailsApi deleteFollow DELETE /Emails/{id}/Follow Stop following an Email
EmailsApi deleteLink DELETE /Emails/{id}/Links/{linkId} Deletes a Link
EmailsApi deleteTag DELETE /Emails/{id}/Tags Deletes a Tag from an Email
EmailsApi getComments GET /Emails/{id}/Comments Gets an Email's Comments
EmailsApi getEntities GET /Emails Gets a list of Emails
EmailsApi getEntitiesBySearch GET /Emails/Search Gets a filtered list of Emails
EmailsApi getEntitiesByTag GET /Emails/SearchByTag Gets a list of Emails filtered by tags
EmailsApi getEntity GET /Emails/{id} Gets an Email
EmailsApi getFileAttachments GET /Emails/{id}/FileAttachments Gets an Email's File Attachments
EmailsApi getFollow GET /Emails/{id}/Follow Gets a Follow state for an Email
EmailsApi getLinks GET /Emails/{id}/Links Gets an Email's Links
EmailsApi getTags GET /Emails/{id}/Tags Gets an Email's Tags
EmailsApi updateTags PUT /Emails/{id}/Tags Updates an Email's Tags
EventsApi addEntity POST /Events Adds an Event
EventsApi addLink POST /Events/{id}/Links Adds a Link
EventsApi deleteEntity DELETE /Events/{id} Deletes an Event
EventsApi deleteImageField DELETE /Events/{id}/ImageField/{fieldName} Deletes an Event's Custom Image Field
EventsApi deleteLink DELETE /Events/{id}/Links/{linkId} Deletes a Link
EventsApi getEntities GET /Events Gets a list of Events
EventsApi getEntitiesBySearch GET /Events/Search Gets a filtered list of Events
EventsApi getEntity GET /Events/{id} Gets an Event
EventsApi getImageField GET /Events/{id}/ImageField/{fieldName} Gets an Event's Custom Image Field
EventsApi getLinks GET /Events/{id}/Links Gets an Event's Links
EventsApi updateEntity PUT /Events Updates an Event
EventsApi updateImageField PUT /Events/{id}/ImageField/{fieldName}/{fileName} Updates an Event's Custom Image Field
FileAttachmentsApi deleteFileAttachment DELETE /FileAttachments/{id} Deletes a File Attachment
FileAttachmentsApi getFileAttachment GET /FileAttachments/{id} Gets a File Attachment
FileCategoriesApi addFileCategory POST /FileCategories Adds a File Category
FileCategoriesApi deleteFileCategory DELETE /FileCategories/{id} Deactivates a File Category
FileCategoriesApi getFileCategories GET /FileCategories Gets a list of File Categories
FileCategoriesApi getFileCategory GET /FileCategories/{id} Gets a File Category
FileCategoriesApi updateFileCategory PUT /FileCategories Updates a File Category
FollowsApi getFollows GET /Follows Gets a list of followed records for the user
InstanceApi getInstance GET /Instance Gets the Instance
KnowledgeArticleCategoriesApi addEntity POST /KnowledgeArticleCategory Adds a Knowledge Article Category
KnowledgeArticleCategoriesApi getEntities GET /KnowledgeArticleCategory Gets a list of Knowledge Article Categories
KnowledgeArticleCategoriesApi getEntitiesBySearch GET /KnowledgeArticleCategory/Search Gets a filtered list of Knowledge Article Categories
KnowledgeArticleCategoriesApi getEntity GET /KnowledgeArticleCategory/{id} Gets a Knowledge Article Category
KnowledgeArticleCategoriesApi updateEntity PUT /KnowledgeArticleCategory Updates a Knowledge Article Category
KnowledgeArticleFoldersApi addEntity POST /KnowledgeArticleFolder Adds a Knowledge Article Folder
KnowledgeArticleFoldersApi getEntities GET /KnowledgeArticleFolder Gets a list of Knowledge Article Folders
KnowledgeArticleFoldersApi getEntitiesBySearch GET /KnowledgeArticleFolder/Search Gets a filtered list of Knowledge Article Folders
KnowledgeArticleFoldersApi getEntity GET /KnowledgeArticleFolder/{id} Gets a Knowledge Article Folder
KnowledgeArticleFoldersApi updateEntity PUT /KnowledgeArticleFolder Updates a Knowledge Article Folder
KnowledgeArticlesApi addEntity POST /KnowledgeArticle Adds a Knowledge Article
KnowledgeArticlesApi addFollow POST /KnowledgeArticle/{id}/Follow Start following a Knowledge Article
KnowledgeArticlesApi addTag POST /KnowledgeArticle/{id}/Tags Adds a Tag to a Knowledge Article
KnowledgeArticlesApi addTranslation POST /KnowledgeArticle/{id}/Translations/{language} Adds a Translation for a Knowledge Article in a specific language
KnowledgeArticlesApi deleteEntity DELETE /KnowledgeArticle/{id} Deletes a Knowledge Article
KnowledgeArticlesApi deleteFollow DELETE /KnowledgeArticle/{id}/Follow Stop following a Knowledge Article
KnowledgeArticlesApi deleteImageField DELETE /KnowledgeArticle/{id}/ImageField/{fieldName} Deletes a Knowledge Article's Custom Image Field
KnowledgeArticlesApi deleteTag DELETE /KnowledgeArticle/{id}/Tags Deletes a Tag from a Knowledge Article
KnowledgeArticlesApi getEntities GET /KnowledgeArticle Gets a list of Knowledge Articles
KnowledgeArticlesApi getEntitiesBySearch GET /KnowledgeArticle/Search Gets a filtered list of Knowledge Articles
KnowledgeArticlesApi getEntitiesByTag GET /KnowledgeArticle/SearchByTag Gets a list of Knowledge Articles filtered by tags
KnowledgeArticlesApi getEntity GET /KnowledgeArticle/{id} Gets a Knowledge Article
KnowledgeArticlesApi getFollow GET /KnowledgeArticle/{id}/Follow Gets a Follow state for a Knowledge Article
KnowledgeArticlesApi getImageField GET /KnowledgeArticle/{id}/ImageField/{fieldName} Gets a Knowledge Article's Custom Image Field
KnowledgeArticlesApi getTags GET /KnowledgeArticle/{id}/Tags Gets a Knowledge Article's Tags
KnowledgeArticlesApi getTranslation GET /KnowledgeArticle/{id}/Translations/{language} Gets a Knowledge Article's translation in a specific language
KnowledgeArticlesApi updateEntity PUT /KnowledgeArticle Updates a Knowledge Article
KnowledgeArticlesApi updateImageField PUT /KnowledgeArticle/{id}/ImageField/{fieldName}/{fileName} Updates a Knowledge Article's Custom Image Field
KnowledgeArticlesApi updateTags PUT /KnowledgeArticle/{id}/Tags Updates a Knowledge Article's Tags
KnowledgeArticlesApi updateTranslation PUT /KnowledgeArticle/{id}/Translations/{language} Updates a Knowledge Article's translation in a specific language
LeadSourcesApi addLeadSource POST /LeadSources Adds a Lead Source
LeadSourcesApi deleteLeadSource DELETE /LeadSources Deletes a Lead Source
LeadSourcesApi getLeadSources GET /LeadSources Gets a list of Lead Sources
LeadSourcesApi updateLeadSource PUT /LeadSources Updates a Lead Source
LeadStatusesApi addLeadStatus POST /LeadStatuses Adds a Lead Status
LeadStatusesApi deleteLeadStatus DELETE /LeadStatuses Deletes a Lead Status
LeadStatusesApi getLeadStatuses GET /LeadStatuses Gets a list of Lead Statuses
LeadStatusesApi updateLeadStatus PUT /LeadStatuses Updates a Lead Status
LeadsApi addActivitySetAssignment POST /Leads/{id}/ActivitySetAssignment Adds an Activity Set to a Lead
LeadsApi addEntity POST /Leads Adds a Lead
LeadsApi addFileAttachment POST /Leads/{id}/FileAttachments Adds a File Attachment to a Lead
LeadsApi addFollow POST /Leads/{id}/Follow Start following a Lead
LeadsApi addLink POST /Leads/{id}/Links Adds a Link
LeadsApi addNotes POST /Leads/{id}/Notes Adds a Note to a Lead
LeadsApi addTag POST /Leads/{id}/Tags Adds a Tag to a Lead
LeadsApi deleteEntity DELETE /Leads/{id} Deletes a Lead
LeadsApi deleteFollow DELETE /Leads/{id}/Follow Stop following a Lead
LeadsApi deleteImage DELETE /Leads/{id}/Image Deletes a Lead's Image
LeadsApi deleteImageField DELETE /Leads/{id}/ImageField/{fieldName} Deletes a Lead's Custom Image Field
LeadsApi deleteLink DELETE /Leads/{id}/Links/{linkId} Deletes a Link
LeadsApi deleteTag DELETE /Leads/{id}/Tags Deletes a Tag from a Lead
LeadsApi getEmails GET /Leads/{id}/Emails Gets a list of a Lead's Emails
LeadsApi getEntities GET /Leads Gets a list of Leads
LeadsApi getEntitiesBySearch GET /Leads/Search Gets a filtered list of Leads
LeadsApi getEntitiesByTag GET /Leads/SearchByTag Gets a list of Leads filtered by tags
LeadsApi getEntity GET /Leads/{id} Gets a Lead
LeadsApi getEvents GET /Leads/{id}/Events Gets a Lead's Events
LeadsApi getFileAttachments GET /Leads/{id}/FileAttachments Gets a Lead's File Attachments
LeadsApi getFollow GET /Leads/{id}/Follow Gets a Follow state for a Lead
LeadsApi getImage GET /Leads/{id}/Image Gets a Lead's Image
LeadsApi getImageField GET /Leads/{id}/ImageField/{fieldName} Gets a Lead's Custom Image Field
LeadsApi getLinkEmailAddress GET /Leads/{id}/LinkEmailAddress Gets the email address to use for linking with the Lead
LeadsApi getLinks GET /Leads/{id}/Links Gets a Lead's Links
LeadsApi getNotes GET /Leads/{id}/Notes Gets a Lead's Notes
LeadsApi getTags GET /Leads/{id}/Tags Gets a Lead's Tags
LeadsApi getTasks GET /Leads/{id}/Tasks Gets a list of a Lead's Tasks
LeadsApi updateEntity PUT /Leads Updates a Lead
LeadsApi updateImage PUT /Leads/{id}/Image/{filename} Updates a Lead's Image
LeadsApi updateImageField PUT /Leads/{id}/ImageField/{fieldName}/{fileName} Updates a Lead's Custom Image Field
LeadsApi updateLink PUT /Leads/{id}/Links Updates a Link
LeadsApi updateNotes PUT /Leads/{id}/Notes Updates a note of a Lead
LeadsApi updateTags PUT /Leads/{id}/Tags Updates a Lead's Tags
MilestonesApi getEntities GET /Milestones Gets a list of Milestones
MilestonesApi getEntitiesBySearch GET /Milestones/Search Gets a filtered list of Milestones
MilestonesApi getEntity GET /Milestones/{id} Gets a Milestone
NotesApi addComment POST /Notes/{id}/Comments Adds a Comment to a Note
NotesApi addFileAttachment POST /Notes/{id}/FileAttachments Adds a File Attachment to a Note
NotesApi addFollow POST /Notes/{id}/Follow Start following a Note
NotesApi addLink POST /Notes/{id}/Links Adds a Link
NotesApi deleteEntity DELETE /Notes/{id} Deletes a Note
NotesApi deleteFollow DELETE /Notes/{id}/Follow Stop following a Note
NotesApi deleteLink DELETE /Notes/{id}/Links/{linkId} Deletes a Link
NotesApi getComments GET /Notes/{id}/Comments Gets a Note's Comments
NotesApi getEntities GET /Notes Gets a list of Notes
NotesApi getEntitiesBySearch GET /Notes/Search Gets a filtered list of Notes
NotesApi getEntity GET /Notes/{id} Gets a Note
NotesApi getFileAttachments GET /Notes/{id}/FileAttachments Gets a Note's File Attachments
NotesApi getFollow GET /Notes/{id}/Follow Gets a Follow state for a Note
NotesApi getLinks GET /Notes/{id}/Links Gets a Note's Links
NotesApi updateEntity PUT /Notes Updates a Note
OpportunitiesApi addActivitySetAssignment POST /Opportunities/{id}/ActivitySetAssignment Adds an Activity Set to an Opportunity
OpportunitiesApi addChildEntity POST /Opportunities/{id}/OpportunityLineItem Adds an Opportunity Product to an Opportunity
OpportunitiesApi addEntity POST /Opportunities Adds an Opportunity
OpportunitiesApi addFileAttachment POST /Opportunities/{id}/FileAttachments Adds a File Attachment to an Opportunity
OpportunitiesApi addFollow POST /Opportunities/{id}/Follow Start following an Opportunity
OpportunitiesApi addLink POST /Opportunities/{id}/Links Adds a Link
OpportunitiesApi addNotes POST /Opportunities/{id}/Notes Adds a Note to an Opportunity
OpportunitiesApi addTag POST /Opportunities/{id}/Tags Adds a Tag to an Opportunity
OpportunitiesApi deleteChildEntity DELETE /Opportunities/{id}/OpportunityLineItem/{childEntityId} Deletes an Opportunity Product of an Opportunity
OpportunitiesApi deleteEntity DELETE /Opportunities/{id} Deletes an Opportunity
OpportunitiesApi deleteFollow DELETE /Opportunities/{id}/Follow Stop following an Opportunity
OpportunitiesApi deleteImage DELETE /Opportunities/{id}/Image Deletes an Opportunity's Image
OpportunitiesApi deleteImageField DELETE /Opportunities/{id}/ImageField/{fieldName} Deletes an Opportunity's Custom Image Field
OpportunitiesApi deleteLink DELETE /Opportunities/{id}/Links/{linkId} Deletes a Link
OpportunitiesApi deletePipeline DELETE /Opportunities/{id}/Pipeline Clears pipeline for the Opportunity
OpportunitiesApi deleteTag DELETE /Opportunities/{id}/Tags Deletes a Tag from an Opportunity
OpportunitiesApi getChildEntities GET /Opportunities/{id}/OpportunityLineItem Gets a list of Opportunity Products of an Opportunity
OpportunitiesApi getEmails GET /Opportunities/{id}/Emails Gets a list of an Opportunity's Emails
OpportunitiesApi getEntities GET /Opportunities Gets a list of Opportunities
OpportunitiesApi getEntitiesBySearch GET /Opportunities/Search Gets a filtered list of Opportunities
OpportunitiesApi getEntitiesByTag GET /Opportunities/SearchByTag Gets a list of Opportunities filtered by tags
OpportunitiesApi getEntity GET /Opportunities/{id} Gets an Opportunity
OpportunitiesApi getEvents GET /Opportunities/{id}/Events Gets an Opportunity's Events
OpportunitiesApi getFileAttachments GET /Opportunities/{id}/FileAttachments Gets an Opportunity's File Attachments
OpportunitiesApi getFollow GET /Opportunities/{id}/Follow Gets a Follow state for an Opportunity
OpportunitiesApi getImage GET /Opportunities/{id}/Image Gets an Opportunity's Image
OpportunitiesApi getImageField GET /Opportunities/{id}/ImageField/{fieldName} Gets an Opportunity's Custom Image Field
OpportunitiesApi getLinkEmailAddress GET /Opportunities/{id}/LinkEmailAddress Gets the email address to use for linking with the Opportunity
OpportunitiesApi getLinks GET /Opportunities/{id}/Links Gets an Opportunity's Links
OpportunitiesApi getNotes GET /Opportunities/{id}/Notes Gets an Opportunity's Notes
OpportunitiesApi getStateHistory GET /Opportunities/{id}/StateHistory Gets the history of States and Reasons for an Opportunity.
OpportunitiesApi getTags GET /Opportunities/{id}/Tags Gets an Opportunity's Tags
OpportunitiesApi getTasks GET /Opportunities/{id}/Tasks Gets a list of an Opportunity's Tasks
OpportunitiesApi updateChildEntity PUT /Opportunities/{id}/OpportunityLineItem Updates an Opportunity Product of an Opportunity
OpportunitiesApi updateEntity PUT /Opportunities Updates an Opportunity
OpportunitiesApi updateImage PUT /Opportunities/{id}/Image/{filename} Updates an Opportunity's Image
OpportunitiesApi updateImageField PUT /Opportunities/{id}/ImageField/{fieldName}/{fileName} Updates an Opportunity's Custom Image Field
OpportunitiesApi updateLink PUT /Opportunities/{id}/Links Updates a Link
OpportunitiesApi updateNotes PUT /Opportunities/{id}/Notes Updates a note of an Opportunity
OpportunitiesApi updateOpportunityState PUT /Opportunities/{id}/StateChange Updates an Opportunity State
OpportunitiesApi updatePipeline PUT /Opportunities/{id}/Pipeline Changes current pipeline for the Opportunity
OpportunitiesApi updatePipelineStage PUT /Opportunities/{id}/PipelineStage Changes current pipeline stage for the Opportunity
OpportunitiesApi updatePricebook PUT /Opportunities/{id}/Pricebook Changes current Price Book for the Opportunity
OpportunitiesApi updateTags PUT /Opportunities/{id}/Tags Updates an Opportunity's Tags
OpportunityCategoriesApi addOpportunityCategory POST /OpportunityCategories Adds an Opportunity Category
OpportunityCategoriesApi deleteOpportunityCategory DELETE /OpportunityCategories/{id} Deactivates an Opportunity Category
OpportunityCategoriesApi getOpportunityCategories GET /OpportunityCategories Gets a list of Opportunity Categories
OpportunityCategoriesApi getOpportunityCategory GET /OpportunityCategories/{id} Gets an Opportunity Category
OpportunityCategoriesApi updateOpportunityCategory PUT /OpportunityCategories Updates an Opportunity Category
OpportunityProductsApi deleteImageField DELETE /OpportunityLineItem/{id}/ImageField/{fieldName} Deletes an Opportunity Product's Custom Image Field
OpportunityProductsApi getEntities GET /OpportunityLineItem Gets a list of Opportunity Products
OpportunityProductsApi getEntitiesBySearch GET /OpportunityLineItem/Search Gets a filtered list of Opportunity Products
OpportunityProductsApi getEntity GET /OpportunityLineItem/{id} Gets an Opportunity Product
OpportunityProductsApi getImageField GET /OpportunityLineItem/{id}/ImageField/{fieldName} Gets an Opportunity Product's Custom Image Field
OpportunityProductsApi updateImageField PUT /OpportunityLineItem/{id}/ImageField/{fieldName}/{fileName} Updates an Opportunity Product's Custom Image Field
OpportunityStateReasonsApi getOpportunityStateReasons GET /OpportunityStateReasons Gets a list of Opportunity State Reasons
OrganisationsApi addActivitySetAssignment POST /Organisations/{id}/ActivitySetAssignment Adds an Activity Set to an Organisation
OrganisationsApi addEntity POST /Organisations Adds an Organisation
OrganisationsApi addFileAttachment POST /Organisations/{id}/FileAttachments Adds a File Attachment to an Organisation
OrganisationsApi addFollow POST /Organisations/{id}/Follow Start following an Organisation
OrganisationsApi addLink POST /Organisations/{id}/Links Adds a Link
OrganisationsApi addNotes POST /Organisations/{id}/Notes Adds a Note to an Organisation
OrganisationsApi addTag POST /Organisations/{id}/Tags Adds a Tag to an Organisation
OrganisationsApi deleteEntity DELETE /Organisations/{id} Deletes an Organisation
OrganisationsApi deleteFollow DELETE /Organisations/{id}/Follow Stop following an Organisation
OrganisationsApi deleteImage DELETE /Organisations/{id}/Image Deletes an Organisation's Image
OrganisationsApi deleteImageField DELETE /Organisations/{id}/ImageField/{fieldName} Deletes an Organisation's Custom Image Field
OrganisationsApi deleteLink DELETE /Organisations/{id}/Links/{linkId} Deletes a Link
OrganisationsApi deleteTag DELETE /Organisations/{id}/Tags Deletes a Tag from an Organisation
OrganisationsApi getDates GET /Organisations/{id}/Dates Gets an Organisation's Dates
OrganisationsApi getEmailDomains GET /Organisations/{id}/EmailDomains Gets an Organisation's Email Domains
OrganisationsApi getEmails GET /Organisations/{id}/Emails Gets a list of an Organisation's Emails
OrganisationsApi getEntities GET /Organisations Gets a list of Organisations
OrganisationsApi getEntitiesBySearch GET /Organisations/Search Gets a filtered list of Organisations
OrganisationsApi getEntitiesByTag GET /Organisations/SearchByTag Gets a list of Organisations filtered by tags
OrganisationsApi getEntity GET /Organisations/{id} Gets an Organisation
OrganisationsApi getEvents GET /Organisations/{id}/Events Gets an Organisation's Events
OrganisationsApi getFileAttachments GET /Organisations/{id}/FileAttachments Gets an Organisation's File Attachments
OrganisationsApi getFollow GET /Organisations/{id}/Follow Gets a Follow state for an Organisation
OrganisationsApi getImage GET /Organisations/{id}/Image Gets an Organisation's Image
OrganisationsApi getImageField GET /Organisations/{id}/ImageField/{fieldName} Gets an Organisation's Custom Image Field
OrganisationsApi getLinks GET /Organisations/{id}/Links Gets an Organisation's Links
OrganisationsApi getNotes GET /Organisations/{id}/Notes Gets an Organisation's Notes
OrganisationsApi getTags GET /Organisations/{id}/Tags Gets an Organisation's Tags
OrganisationsApi getTasks GET /Organisations/{id}/Tasks Gets a list of an Organisation's Tasks
OrganisationsApi updateDates PUT /Organisations/{id}/Dates Updates an Organisation's Dates
OrganisationsApi updateEmailDomains PUT /Organisations/{id}/EmailDomains Updates an Organisation's Email Domains
OrganisationsApi updateEntity PUT /Organisations Updates an Organisation
OrganisationsApi updateImage PUT /Organisations/{id}/Image/{filename} Updates an Organisation's Image
OrganisationsApi updateImageField PUT /Organisations/{id}/ImageField/{fieldName}/{fileName} Updates an Organisation's Custom Image Field
OrganisationsApi updateLink PUT /Organisations/{id}/Links Updates a Link
OrganisationsApi updateNotes PUT /Organisations/{id}/Notes Updates a note of an Organisation
OrganisationsApi updateTags PUT /Organisations/{id}/Tags Updates an Organisation's Tags
PermissionsApi getPermissions GET /Permissions Gets the Permissions for a User
PipelineStagesApi getPipelineStage GET /PipelineStages/{id} Gets a Pipeline Stage
PipelineStagesApi getPipelineStages GET /PipelineStages Gets a list of Pipeline Stages
PipelinesApi getPipeline GET /Pipelines/{id} Gets a Pipeline
PipelinesApi getPipelines GET /Pipelines Gets a list of Pipelines
PriceBookEntriesApi deleteImageField DELETE /PricebookEntry/{id}/ImageField/{fieldName} Deletes a Price Book Entry's Custom Image Field
PriceBookEntriesApi getEntities GET /PricebookEntry Gets a list of Price Book Entries
PriceBookEntriesApi getEntitiesBySearch GET /PricebookEntry/Search Gets a filtered list of Price Book Entries
PriceBookEntriesApi getEntity GET /PricebookEntry/{id} Gets a Price Book Entry
PriceBookEntriesApi getImageField GET /PricebookEntry/{id}/ImageField/{fieldName} Gets a Price Book Entry's Custom Image Field
PriceBookEntriesApi updateImageField PUT /PricebookEntry/{id}/ImageField/{fieldName}/{fileName} Updates a Price Book Entry's Custom Image Field
PriceBooksApi addChildEntity POST /Pricebook/{id}/PricebookEntry Adds a Price Book Entry to a Price Book
PriceBooksApi addEntity POST /Pricebook Adds a Price Book
PriceBooksApi addFollow POST /Pricebook/{id}/Follow Start following a Price Book
PriceBooksApi deleteChildEntity DELETE /Pricebook/{id}/PricebookEntry/{childEntityId} Deletes a Price Book Entry of a Price Book
PriceBooksApi deleteFollow DELETE /Pricebook/{id}/Follow Stop following a Price Book
PriceBooksApi getChildEntities GET /Pricebook/{id}/PricebookEntry Gets a list of Price Book Entries of a Price Book
PriceBooksApi getEntities GET /Pricebook Gets a list of Price Books
PriceBooksApi getEntitiesBySearch GET /Pricebook/Search Gets a filtered list of Price Books
PriceBooksApi getEntity GET /Pricebook/{id} Gets a Price Book
PriceBooksApi getFollow GET /Pricebook/{id}/Follow Gets a Follow state for a Price Book
PriceBooksApi updateChildEntity PUT /Pricebook/{id}/PricebookEntry Updates a Price Book Entry of a Price Book
PriceBooksApi updateEntity PUT /Pricebook Updates a Price Book
ProductsApi addChildEntity POST /Product/{id}/PricebookEntry Adds a Price Book Entry to a Product
ProductsApi addEntity POST /Product Adds a Product
ProductsApi addFollow POST /Product/{id}/Follow Start following a Product
ProductsApi deleteChildEntity DELETE /Product/{id}/PricebookEntry/{childEntityId} Deletes a Price Book Entry of a Product
ProductsApi deleteEntity DELETE /Product/{id} Deletes a Product
ProductsApi deleteFollow DELETE /Product/{id}/Follow Stop following a Product
ProductsApi deleteImage DELETE /Product/{id}/Image Deletes a Product's Image
ProductsApi deleteImageField DELETE /Product/{id}/ImageField/{fieldName} Deletes a Product's Custom Image Field
ProductsApi getChildEntities GET /Product/{id}/PricebookEntry Gets a list of Price Book Entries of a Product
ProductsApi getEntities GET /Product Gets a list of Products
ProductsApi getEntitiesBySearch GET /Product/Search Gets a filtered list of Products
ProductsApi getEntity GET /Product/{id} Gets a Product
ProductsApi getFollow GET /Product/{id}/Follow Gets a Follow state for a Product
ProductsApi getImage GET /Product/{id}/Image Gets a Product's Image
ProductsApi getImageField GET /Product/{id}/ImageField/{fieldName} Gets a Product's Custom Image Field
ProductsApi updateChildEntity PUT /Product/{id}/PricebookEntry Updates a Price Book Entry of a Product
ProductsApi updateEntity PUT /Product Updates a Product
ProductsApi updateImage PUT /Product/{id}/Image/{filename} Updates a Product's Image
ProductsApi updateImageField PUT /Product/{id}/ImageField/{fieldName}/{fileName} Updates a Product's Custom Image Field
ProjectCategoriesApi addProjectCategory POST /ProjectCategories Adds a Project Category
ProjectCategoriesApi deleteProjectCategory DELETE /ProjectCategories/{id} Deactivates a Project Category
ProjectCategoriesApi getProjectCategories GET /ProjectCategories Gets a list of Project Categories
ProjectCategoriesApi getProjectCategory GET /ProjectCategories/{id} Gets a Project Category
ProjectCategoriesApi updateProjectCategory PUT /ProjectCategories Updates a Project Category
ProjectsApi addActivitySetAssignment POST /Projects/{id}/ActivitySetAssignment Adds an Activity Set to a Project
ProjectsApi addEntity POST /Projects Adds a Project
ProjectsApi addFileAttachment POST /Projects/{id}/FileAttachments Adds a File Attachment to a Project
ProjectsApi addFollow POST /Projects/{id}/Follow Start following a Project
ProjectsApi addLink POST /Projects/{id}/Links Adds a Link
ProjectsApi addMilestone POST /Projects/{id}/Milestones Adds a Milestone
ProjectsApi addNotes POST /Projects/{id}/Notes Adds a Note to a Project
ProjectsApi addTag POST /Projects/{id}/Tags Adds a Tag to a Project
ProjectsApi deleteEntity DELETE /Projects/{id} Deletes a Project
ProjectsApi deleteFollow DELETE /Projects/{id}/Follow Stop following a Project
ProjectsApi deleteImage DELETE /Projects/{id}/Image Deletes a Project's Image
ProjectsApi deleteImageField DELETE /Projects/{id}/ImageField/{fieldName} Deletes a Project's Custom Image Field
ProjectsApi deleteLink DELETE /Projects/{id}/Links/{linkId} Deletes a Link
ProjectsApi deleteMilestone DELETE /Projects/{id}/Milestones/{milestoneId} Deletes a Milestone
ProjectsApi deletePipeline DELETE /Projects/{id}/Pipeline Clears pipeline for the Project
ProjectsApi deleteTag DELETE /Projects/{id}/Tags Deletes a Tag from a Project
ProjectsApi getEmails GET /Projects/{id}/Emails Gets a list of a Project's Emails
ProjectsApi getEntities GET /Projects Gets a list of Projects
ProjectsApi getEntitiesBySearch GET /Projects/Search Gets a filtered list of Projects
ProjectsApi getEntitiesByTag GET /Projects/SearchByTag Gets a list of Projects filtered by tags
ProjectsApi getEntity GET /Projects/{id} Gets a Project
ProjectsApi getEvents GET /Projects/{id}/Events Gets a Project's Events
ProjectsApi getFileAttachments GET /Projects/{id}/FileAttachments Gets a Project's File Attachments
ProjectsApi getFollow GET /Projects/{id}/Follow Gets a Follow state for a Project
ProjectsApi getImage GET /Projects/{id}/Image Gets a Project's Image
ProjectsApi getImageField GET /Projects/{id}/ImageField/{fieldName} Gets a Project's Custom Image Field
ProjectsApi getLinkEmailAddress GET /Projects/{id}/LinkEmailAddress Gets the email address to use for linking with the Project
ProjectsApi getLinks GET /Projects/{id}/Links Gets a Project's Links
ProjectsApi getMilestones GET /Projects/{id}/Milestones Gets a list of a Project's Milestones
ProjectsApi getNotes GET /Projects/{id}/Notes Gets a Project's Notes
ProjectsApi getTags GET /Projects/{id}/Tags Gets a Project's Tags
ProjectsApi getTasks GET /Projects/{id}/Tasks Gets a list of a Project's Tasks
ProjectsApi updateEntity PUT /Projects Updates a Project
ProjectsApi updateImage PUT /Projects/{id}/Image/{filename} Updates a Project's Image
ProjectsApi updateImageField PUT /Projects/{id}/ImageField/{fieldName}/{fileName} Updates a Project's Custom Image Field
ProjectsApi updateLink PUT /Projects/{id}/Links Updates a Link
ProjectsApi updateMilestone PUT /Projects/{id}/Milestones Updates a Milestone
ProjectsApi updateNotes PUT /Projects/{id}/Notes Updates a note of a Project
ProjectsApi updatePipeline PUT /Projects/{id}/Pipeline Changes current pipeline for the Project
ProjectsApi updatePipelineStage PUT /Projects/{id}/PipelineStage Changes current pipeline stage for the Project
ProjectsApi updateTags PUT /Projects/{id}/Tags Updates a Project's Tags
ProspectsApi addEntity POST /Prospect Adds a Prospect
ProspectsApi addFollow POST /Prospect/{id}/Follow Start following a Prospect
ProspectsApi addTag POST /Prospect/{id}/Tags Adds a Tag to a Prospect
ProspectsApi deleteEntity DELETE /Prospect/{id} Deletes a Prospect
ProspectsApi deleteFollow DELETE /Prospect/{id}/Follow Stop following a Prospect
ProspectsApi deleteImageField DELETE /Prospect/{id}/ImageField/{fieldName} Deletes a Prospect's Custom Image Field
ProspectsApi deleteTag DELETE /Prospect/{id}/Tags Deletes a Tag from a Prospect
ProspectsApi getEntities GET /Prospect Gets a list of Prospects
ProspectsApi getEntitiesBySearch GET /Prospect/Search Gets a filtered list of Prospects
ProspectsApi getEntitiesByTag GET /Prospect/SearchByTag Gets a list of Prospects filtered by tags
ProspectsApi getEntity GET /Prospect/{id} Gets a Prospect
ProspectsApi getFollow GET /Prospect/{id}/Follow Gets a Follow state for a Prospect
ProspectsApi getImageField GET /Prospect/{id}/ImageField/{fieldName} Gets a Prospect's Custom Image Field
ProspectsApi getTags GET /Prospect/{id}/Tags Gets a Prospect's Tags
ProspectsApi updateEntity PUT /Prospect Updates a Prospect
ProspectsApi updateImageField PUT /Prospect/{id}/ImageField/{fieldName}/{fileName} Updates a Prospect's Custom Image Field
ProspectsApi updateTags PUT /Prospect/{id}/Tags Updates a Prospect's Tags
QuoteProductsApi deleteImageField DELETE /QuotationLineItem/{id}/ImageField/{fieldName} Deletes a Quote Product's Custom Image Field
QuoteProductsApi getEntities GET /QuotationLineItem Gets a list of Quote Products
QuoteProductsApi getEntitiesBySearch GET /QuotationLineItem/Search Gets a filtered list of Quote Products
QuoteProductsApi getEntity GET /QuotationLineItem/{id} Gets a Quote Product
QuoteProductsApi getImageField GET /QuotationLineItem/{id}/ImageField/{fieldName} Gets a Quote Product's Custom Image Field
QuoteProductsApi updateImageField PUT /QuotationLineItem/{id}/ImageField/{fieldName}/{fileName} Updates a Quote Product's Custom Image Field
QuotesApi addChildEntity POST /Quotation/{id}/QuotationLineItem Adds a Quote Product to a Quote
QuotesApi addEntity POST /Quotation Adds a Quote
QuotesApi addFollow POST /Quotation/{id}/Follow Start following a Quote
QuotesApi deleteChildEntity DELETE /Quotation/{id}/QuotationDocument/{childEntityId} Deletes a Quote Document of a Quote
QuotesApi deleteChildEntity_0 DELETE /Quotation/{id}/QuotationLineItem/{childEntityId} Deletes a Quote Product of a Quote
QuotesApi deleteEntity DELETE /Quotation/{id} Deletes a Quote
QuotesApi deleteFollow DELETE /Quotation/{id}/Follow Stop following a Quote
QuotesApi deleteImageField DELETE /Quotation/{id}/ImageField/{fieldName} Deletes a Quote's Custom Image Field
QuotesApi getChildEntities GET /Quotation/{id}/QuotationDocument Gets a list of Quote Documents of a Quote
QuotesApi getChildEntities_0 GET /Quotation/{id}/QuotationLineItem Gets a list of Quote Products of a Quote
QuotesApi getEntities GET /Quotation Gets a list of Quotes
QuotesApi getEntitiesBySearch GET /Quotation/Search Gets a filtered list of Quotes
QuotesApi getEntity GET /Quotation/{id} Gets a Quote
QuotesApi getFollow GET /Quotation/{id}/Follow Gets a Follow state for a Quote
QuotesApi getImageField GET /Quotation/{id}/ImageField/{fieldName} Gets a Quote's Custom Image Field
QuotesApi updateChildEntity PUT /Quotation/{id}/QuotationLineItem Updates a Quote Product of a Quote
QuotesApi updateEntity PUT /Quotation Updates a Quote
QuotesApi updateImageField PUT /Quotation/{id}/ImageField/{fieldName}/{fileName} Updates a Quote's Custom Image Field
RelationshipsApi getRelationships GET /Relationships Gets a list of Relationships
TagsApi getTags GET /Tags Gets a list of Tags used for a record type
TaskCategoriesApi addTaskCategory POST /TaskCategories Adds a Task Category
TaskCategoriesApi deleteTaskCategory DELETE /TaskCategories/{id} Deactivates a Task Category
TaskCategoriesApi getTaskCategories GET /TaskCategories Gets a list of Task Categories
TaskCategoriesApi getTaskCategory GET /TaskCategories/{id} Gets a Task Category
TaskCategoriesApi updateTaskCategory PUT /TaskCategories Updates a Task Category
TasksApi addComment POST /Tasks/{id}/Comments Adds a Comment to a Task
TasksApi addEntity POST /Tasks Adds a Task
TasksApi addFollow POST /Tasks/{id}/Follow Start following a Task
TasksApi addLink POST /Tasks/{id}/Links Adds a Link
TasksApi deleteEntity DELETE /Tasks/{id} Deletes a Task
TasksApi deleteFollow DELETE /Tasks/{id}/Follow Stop following a Task
TasksApi deleteImageField DELETE /Tasks/{id}/ImageField/{fieldName} Deletes a Task's Custom Image Field
TasksApi deleteLink DELETE /Tasks/{id}/Links/{linkId} Deletes a Link
TasksApi getComments GET /Tasks/{id}/Comments Gets a Task's Comments
TasksApi getEntities GET /Tasks Gets a list of Tasks
TasksApi getEntitiesBySearch GET /Tasks/Search Gets a filtered list of Tasks
TasksApi getEntity GET /Tasks/{id} Gets a Task
TasksApi getFollow GET /Tasks/{id}/Follow Gets a Follow state for a Task
TasksApi getImageField GET /Tasks/{id}/ImageField/{fieldName} Gets a Task's Custom Image Field
TasksApi getLinks GET /Tasks/{id}/Links Gets a Task's Links
TasksApi updateEntity PUT /Tasks Updates a Task
TasksApi updateImageField PUT /Tasks/{id}/ImageField/{fieldName}/{fileName} Updates a Task's Custom Image Field
TeamMembersApi addTeamMember POST /TeamMembers Adds a new Team Member
TeamMembersApi deleteTeamMember DELETE /TeamMembers/{id} Deletes a Team Member
TeamMembersApi getTeamMember GET /TeamMembers/{id} Gets a Team Member
TeamMembersApi getTeamMembers GET /TeamMembers Gets a list of Team Members
TeamsApi addTeam POST /Teams Adds a Team
TeamsApi addTeamMember POST /Teams/{id}/TeamMembers Adds a Team Member
TeamsApi deleteTeam DELETE /Teams/{id} Deletes a Team
TeamsApi deleteTeamMember DELETE /Teams/{id}/TeamMembers/{permissionId} Deletes a Team Member
TeamsApi getTeam GET /Teams/{id} Gets a Team
TeamsApi getTeams GET /Teams Gets a list of Teams.
TeamsApi updateTeam PUT /Teams Updates a Team
TicketsApi addComment POST /Ticket/{id}/Comments Adds a Comment to a Ticket
TicketsApi addEntity POST /Ticket Adds a Ticket
TicketsApi addFollow POST /Ticket/{id}/Follow Start following a Ticket
TicketsApi addMerge POST /Ticket/{id}/Merge Merges the Ticket into another Ticket
TicketsApi addTag POST /Ticket/{id}/Tags Adds a Tag to a Ticket
TicketsApi deleteEntity DELETE /Ticket/{id} Deletes a Ticket
TicketsApi deleteFollow DELETE /Ticket/{id}/Follow Stop following a Ticket
TicketsApi deleteImageField DELETE /Ticket/{id}/ImageField/{fieldName} Deletes a Ticket's Custom Image Field
TicketsApi deleteTag DELETE /Ticket/{id}/Tags Deletes a Tag from a Ticket
TicketsApi getComments GET /Ticket/{id}/Comments Gets a Ticket's Comments
TicketsApi getEntities GET /Ticket Gets a list of Tickets
TicketsApi getEntitiesBySearch GET /Ticket/Search Gets a filtered list of Tickets
TicketsApi getEntitiesByTag GET /Ticket/SearchByTag Gets a list of Tickets filtered by tags
TicketsApi getEntity GET /Ticket/{id} Gets a Ticket
TicketsApi getFollow GET /Ticket/{id}/Follow Gets a Follow state for a Ticket
TicketsApi getImageField GET /Ticket/{id}/ImageField/{fieldName} Gets a Ticket's Custom Image Field
TicketsApi getTags GET /Ticket/{id}/Tags Gets a Ticket's Tags
TicketsApi updateEntity PUT /Ticket Updates a Ticket
TicketsApi updateImageField PUT /Ticket/{id}/ImageField/{fieldName}/{fileName} Updates a Ticket's Custom Image Field
TicketsApi updateTags PUT /Ticket/{id}/Tags Updates a Ticket's Tags
UsersApi getUser GET /Users/{id} Gets a User
UsersApi getUserMe GET /Users/Me Gets the User object for the calling user.
UsersApi getUsers GET /Users Gets a list of Users
UsersApi getUsersBySearch GET /Users/Search Gets a filtered list of Users

Documentation For Models

Documentation For Authorization

Basic authentication required. Format:

Basic {{ API_KEY }}

where {{ API_KEY }} is a base64-encoded API key.

Author

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages