Download the PHP package keap/keap-sdk without Composer

On this page you can find all versions of the php package keap/keap-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package keap-sdk

core-v2-client

Keap Public API Documentation

For more information, please visit https://developer.keap.com/get-support.

Installation & Usage

Requirements

PHP 8.3 and later.

Composer

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

Then run composer install

Manual Installation

Download the files and include autoload.php:

Getting Started

Please follow the installation procedure and then run the following:

API Endpoints

All URIs are relative to https://api.keap.com/crm

Class Method HTTP request Description
AffiliateApi addAffiliate POST /rest/v2/affiliates Create an Affiliate
AffiliateApi addAffiliateToProgram POST /rest/v2/affiliates/{id}:assignToProgram Assign Affiliate to Commission program
AffiliateApi addCommissionProgram POST /rest/v2/affiliates/commissionPrograms Create an Affiliate Commission Program
AffiliateApi addCommissionProgramResource POST /rest/v2/affiliates/commissionPrograms/resources Create Commission Program Resource
AffiliateApi assignProductCommissionProgram POST /rest/v2/affiliates/commissionPrograms/productCommissionPrograms/{commission_program_id} Assign a Product Commission Program
AffiliateApi assignSubscriptionCommissionProgram POST /rest/v2/affiliates/commissionPrograms/subscriptionCommissionPrograms/{commission_program_id} Assign a Subscription Commission Program
AffiliateApi createAffiliateCustomField POST /rest/v2/affiliates/model/customFields Create an Affiliate Custom Field
AffiliateApi createAffiliateCustomFieldGroup POST /rest/v2/affiliates/model/customFields/groups Create an Affiliate Custom Field Group
AffiliateApi createAffiliateCustomFieldTab POST /rest/v2/affiliates/model/customFields/tabs Create an Affiliate Custom Field Tab
AffiliateApi createDefaultCommissionProgram POST /rest/v2/affiliates/commissionPrograms/defaultCommissionPrograms/{commission_program_id} Create a Default Commission Program
AffiliateApi createRedirectLink POST /rest/v2/affiliates/redirects Create an Affiliate Link
AffiliateApi deleteAffiliate DELETE /rest/v2/affiliates/{id} Delete Affiliate
AffiliateApi deleteAffiliateCommissionProgram DELETE /rest/v2/affiliates/commissionPrograms/{commission_program_id} Delete a Commission Program
AffiliateApi deleteAffiliateCustomField DELETE /rest/v2/affiliates/model/customFields/{custom_field_id} Delete a Custom Field
AffiliateApi deleteAffiliateCustomFieldGroup DELETE /rest/v2/affiliates/model/customFields/groups/{group_id} Delete an Affiliate Custom Field Group
AffiliateApi deleteAffiliateCustomFieldTab DELETE /rest/v2/affiliates/model/customFields/tabs/{tab_id} Delete an Affiliate Custom Field Tab
AffiliateApi deleteCommissionProgramResource DELETE /rest/v2/affiliates/commissionPrograms/resources/{resource_id} Remove Commission Program Resource
AffiliateApi deleteRedirectLink DELETE /rest/v2/affiliates/redirects/{redirect_id} Delete an Affiliate Link
AffiliateApi getAffiliate GET /rest/v2/affiliates/{id} Retrieve an Affiliate
AffiliateApi getAffiliateCommissionTotal GET /rest/v2/affiliates/{affiliate_id}/commissionTotal Retrieve Affiliate Commission Earned and View LedgerURl for portal
AffiliateApi getAffiliateCommissions GET /rest/v2/affiliates/{affiliate_id}:commissions Retrieve Affiliate Commissions
AffiliateApi getAffiliateCustomFieldGroup GET /rest/v2/affiliates/model/customFields/groups/{group_id} Retrieve an Affiliate Custom Field Group
AffiliateApi getAffiliateCustomFieldTab GET /rest/v2/affiliates/model/customFields/tabs/{tab_id} Retrieve an Affiliate Custom Field Tab
AffiliateApi getAffiliateCustomFields GET /rest/v2/affiliates/model Retrieve Affiliate Model
AffiliateApi getCommissionProgram GET /rest/v2/affiliates/commissionPrograms/{commission_program_id} Retrieve a Commission Program
AffiliateApi getRedirectLink GET /rest/v2/affiliates/redirects/{redirect_id} Retrieve an Affiliate Link
AffiliateApi getReferralsByAffiliateId GET /rest/v2/affiliates/{affiliate_id}/referrals Retrieve Affiliate Referrals
AffiliateApi listAffiliate GET /rest/v2/affiliates List Affiliates
AffiliateApi listAffiliateCommissionPrograms GET /rest/v2/affiliates/commissionPrograms List Affiliate Commission Programs
AffiliateApi listAffiliateCustomFieldGroups GET /rest/v2/affiliates/model/customFields/groups List Affiliate Custom Field Groups
AffiliateApi listAffiliateCustomFieldTabs GET /rest/v2/affiliates/model/customFields/tabs List Affiliate Custom Field Tabs
AffiliateApi listAffiliateLinks GET /rest/v2/affiliates/redirects List Affiliate Links
AffiliateApi listAffiliatePayments GET /rest/v2/affiliates/{affiliate_id}/payments List Affiliate Payments
AffiliateApi listCommissionProgramResources GET /rest/v2/affiliates/commissionPrograms/{commission_program_id}/resources Retrieve Commission Program Resources
AffiliateApi listSummaries GET /rest/v2/affiliates/summaries List Affiliate Summaries
AffiliateApi removeAffiliateFromProgram POST /rest/v2/affiliates/{id}:removeFromProgram Remove an Affiliate from a Commission Program
AffiliateApi removeProductCommissionFromCommissions POST /rest/v2/affiliates/commissionPrograms/{commission_id}:removeProductCommission Remove a Product from a Commission Program
AffiliateApi removeSubscriptionPlanCommissionFromCommissions POST /rest/v2/affiliates/commissionPrograms/{commission_id}:removeSubscriptionCommission Remove a Subscription from a Commission Program
AffiliateApi updateAffiliate PATCH /rest/v2/affiliates/{id} Update an Affiliate
AffiliateApi updateAffiliateCustomField PATCH /rest/v2/affiliates/model/customFields/{custom_field_id} Update a Custom Field
AffiliateApi updateAffiliateCustomFieldGroup PATCH /rest/v2/affiliates/model/customFields/groups/{group_id} Update an Affiliate Custom Field Group
AffiliateApi updateAffiliateCustomFieldTab PATCH /rest/v2/affiliates/model/customFields/tabs/{tab_id} Update an Affiliate Custom Field Tab
AffiliateApi updateCommissionProgram PATCH /rest/v2/affiliates/commissionPrograms/{commission_program_id} Update an Affiliate Commission Program
AffiliateApi updateCommissionProgramResource PATCH /rest/v2/affiliates/commissionPrograms/resources/{resource_id} Update Commission Program Resource
AffiliateApi updateDefaultCommissionProgram PATCH /rest/v2/affiliates/commissionPrograms/defaultCommissionPrograms/{commission_program_id} Update a Default Commission Program
AffiliateApi updateProductCommissionProgram PATCH /rest/v2/affiliates/commissionPrograms/productCommissionPrograms/{commission_program_id} Update a Product Commission Program
AffiliateApi updateRedirectLink PATCH /rest/v2/affiliates/redirects/{redirect_id} Update an Affiliate Link
AffiliateApi updateSubscriptionCommissionProgram PATCH /rest/v2/affiliates/commissionPrograms/subscriptionCommissionPrograms/{commission_program_id} Update a Subscription Commission Program
AutomationApi achieveGoal POST /rest/v2/automations/goals/achieve Achieve an Automation Goal
AutomationApi addContactsToAutomationSequence POST /rest/v2/automations/{automation_id}/sequences/{sequence_id}:addContacts Add Contacts to an Automation Sequence
AutomationApi bulkAssignmentAutomationsCategories POST /rest/v2/automations/categories/batchAssign Bulk update for Automations Categories
AutomationApi bulkUnpublishAutomations POST /rest/v2/automations/batch-unpublish Bulk unpublish Automations
AutomationApi deleteAutomation DELETE /rest/v2/automations Delete an Automation
AutomationApi getAutomation GET /rest/v2/automations/{automation_id} Retrieve an Automation
AutomationApi listAllAutomationIds GET /rest/v2/automations/ids List Automations Ids
AutomationApi listAutomations GET /rest/v2/automations List Automations
AutomationApi unpublishAutomation PUT /rest/v2/automations/{automation_id}/unpublish Unpublish an Automation
AutomationCategoryApi createCategory POST /rest/v2/automationCategory Create automation category
AutomationCategoryApi deleteCategories DELETE /rest/v2/automationCategory Delete automation category
AutomationCategoryApi listCategories GET /rest/v2/automationCategory List automation categories
AutomationCategoryApi patchCategory PATCH /rest/v2/automationCategory/{id} Update automation category
BusinessProfileApi getBusinessProfile GET /rest/v2/businessProfile Retrieve Business Profile
BusinessProfileApi updateBusinessProfile PATCH /rest/v2/businessProfile Update Business Profile
CampaignApi addContactsToCampaignSequence POST /rest/v2/campaigns/{campaign_id}/sequences/{sequence_id}:addContacts Add Contacts to Campaign Sequence
CampaignApi getCampaign GET /rest/v2/campaigns/{campaign_id} Retrieve a Campaign
CampaignApi getCampaignGoals GET /rest/v2/campaigns/{campaign_id}/goals Retrieve a list of Goals for a Campaign
CampaignApi getCampaignSequences GET /rest/v2/campaigns/{campaign_id}/sequences Retrieve a list of Sequences for a Campaign
CampaignApi listCampaigns GET /rest/v2/campaigns List Campaigns
CampaignApi removeContactsFromCampaignSequence POST /rest/v2/campaigns/{campaign_id}/sequences/{sequence_id}:removeContacts Remove Contacts from Campaign Sequence
CategoryDiscountsApi createCategoryDiscount POST /rest/v2/discounts/productCategories Create a Category Discount
CategoryDiscountsApi createCategoryDiscountCriteria POST /rest/v2/discounts/productCategories/{discount_id}/criteria Create a Category Discount Criteria
CategoryDiscountsApi deleteCategoryDiscount DELETE /rest/v2/discounts/productCategories/{discount_id} Delete a Category Discount
CategoryDiscountsApi deleteCategoryDiscountCriteria DELETE /rest/v2/discounts/productCategories/{discount_id}/criteria/{criteria_id} Delete a Category Discount Criteria
CategoryDiscountsApi getCategoryDiscount GET /rest/v2/discounts/productCategories/{discount_id} Retrieve a Category Discount
CategoryDiscountsApi listCategoryDiscounts GET /rest/v2/discounts/productCategories List Category Discounts
CategoryDiscountsApi updateCategoryDiscount PATCH /rest/v2/discounts/productCategories/{discount_id} Update a Category Discount
CompanyApi addTagToCompany POST /rest/v2/companies/{company_id}/tags/{tag_id} Add Tag to Company
CompanyApi createCompany POST /rest/v2/companies Create a Company
CompanyApi createCompanyCustomField POST /rest/v2/companies/model/customFields Create a Company Custom Field
CompanyApi createCompanyCustomFieldGroup POST /rest/v2/companies/model/customFields/groups Create a Company Custom Field Group
CompanyApi createCompanyCustomFieldTab POST /rest/v2/companies/model/customFields/tabs Create a Company Custom Field Tab
CompanyApi deleteCompany DELETE /rest/v2/companies/{company_id} Delete a Company
CompanyApi deleteCompanyCustomField DELETE /rest/v2/companies/model/customFields/{custom_field_id} Delete a Company Custom Field
CompanyApi deleteCompanyCustomFieldGroup DELETE /rest/v2/companies/model/customFields/groups/{group_id} Delete a Company Custom Field Group
CompanyApi deleteCompanyCustomFieldTab DELETE /rest/v2/companies/model/customFields/tabs/{tab_id} Delete a Company Custom Field Tab
CompanyApi getCompany GET /rest/v2/companies/{company_id} Retrieve a Company
CompanyApi getCompanyCustomFieldGroup GET /rest/v2/companies/model/customFields/groups/{group_id} Retrieve a Company Custom Field Group
CompanyApi getCompanyCustomFieldTab GET /rest/v2/companies/model/customFields/tabs/{tab_id} Retrieve a Company Custom Field Tab
CompanyApi listCompanies GET /rest/v2/companies List Companies
CompanyApi listCompanyCustomFieldGroups GET /rest/v2/companies/model/customFields/groups List Company Custom Field Groups
CompanyApi listCompanyCustomFieldTabs GET /rest/v2/companies/model/customFields/tabs List Company Custom Field Tabs
CompanyApi listTagsForCompany GET /rest/v2/companies/{company_id}/tags List Applied Tags
CompanyApi removeTagFromCompany DELETE /rest/v2/companies/{company_id}/tags/{tag_id} Remove Tag
CompanyApi retrieveCompanyCustomFieldModel GET /rest/v2/companies/model Retrieve Company Custom Field Model
CompanyApi updateCompany PATCH /rest/v2/companies/{company_id} Update a Company
CompanyApi updateCompanyCustomField PATCH /rest/v2/companies/model/customFields/{custom_field_id} Update a Company Custom Field
CompanyApi updateCompanyCustomFieldGroup PATCH /rest/v2/companies/model/customFields/groups/{group_id} Update a Company Custom Field Group
CompanyApi updateCompanyCustomFieldTab PATCH /rest/v2/companies/model/customFields/tabs/{tab_id} Update a Company Custom Field Tab
ContactApi createContact POST /rest/v2/contacts Create a Contact
ContactApi createContactCustomField POST /rest/v2/contacts/model/customFields Create a Contact Custom Field
ContactApi createContactCustomFieldGroup POST /rest/v2/contacts/model/customFields/groups Create a Contact Custom Field Group
ContactApi createContactCustomFieldTab POST /rest/v2/contacts/model/customFields/tabs Create a Contact Custom Field Tab
ContactApi createContactLinkType POST /rest/v2/contacts/links/types Create a Contact Link type
ContactApi deleteContact DELETE /rest/v2/contacts/{contact_id} Delete a Contact
ContactApi deleteContactCustomField DELETE /rest/v2/contacts/model/customFields/{custom_field_id} Delete a Contact Custom Field
ContactApi deleteContactCustomFieldGroup DELETE /rest/v2/contacts/model/customFields/groups/{group_id} Delete a Contact Custom Field Group
ContactApi deleteContactCustomFieldTab DELETE /rest/v2/contacts/model/customFields/tabs/{tab_id} Delete a Contact Custom Field Tab
ContactApi deleteContactLinkType DELETE /rest/v2/contacts/links/types/{link_type_id} Delete a Contact Link type
ContactApi getContact GET /rest/v2/contacts/{contact_id} Retrieve a Contact
ContactApi getContactCustomFieldGroup GET /rest/v2/contacts/model/customFields/groups/{group_id} Retrieve a Contact Custom Field Group
ContactApi getContactCustomFieldTab GET /rest/v2/contacts/model/customFields/tabs/{tab_id} Retrieve a Contact Custom Field Tab
ContactApi linkContacts POST /rest/v2/contacts:link Link Contacts
ContactApi listContactCustomFieldGroups GET /rest/v2/contacts/model/customFields/groups List Contact Custom Field Groups
ContactApi listContactCustomFieldTabs GET /rest/v2/contacts/model/customFields/tabs List Contact Custom Field Tabs
ContactApi listContactLinkTypes GET /rest/v2/contacts/links/types List Contact Link types
ContactApi listContactLinks GET /rest/v2/contacts/{contact_id}/links List Linked Contacts
ContactApi listContacts GET /rest/v2/contacts List Contacts
ContactApi listTagsAcrossContacts GET /rest/v2/contacts/-/tags List Contact's Tags
ContactApi listTagsForContact GET /rest/v2/contacts/{contact_id}/tags List Applied Tags
ContactApi mergeContacts POST /rest/v2/contacts:merge Merge two Contacts
ContactApi retrieveContactModel GET /rest/v2/contacts/model Retrieve Contact Model
ContactApi unlinkContacts POST /rest/v2/contacts:unlink Delete Link between two Contacts
ContactApi updateContact PATCH /rest/v2/contacts/{contact_id} Update a Contact
ContactApi updateContactCustomFieldGroup PATCH /rest/v2/contacts/model/customFields/groups/{group_id} Update a Contact Custom Field Group
ContactApi updateContactCustomFieldTab PATCH /rest/v2/contacts/model/customFields/tabs/{tab_id} Update a Contact Custom Field Tab
ContactApi updateContactLinkType PATCH /rest/v2/contacts/links/types/{link_type_id} Update a Contact Link type
EmailApi createEmail POST /rest/v2/emails Create an Email Record
EmailApi createEmails POST /rest/v2/emails:batchAdd Create a set of Email Records
EmailApi deleteEmail DELETE /rest/v2/emails/{id} Delete an Email Record
EmailApi deleteEmails POST /rest/v2/emails:batchRemove Remove a set of Email Records
EmailApi getEmail GET /rest/v2/emails/{id} Retrieve an Email
EmailApi getEmailTemplate GET /rest/v2/emails/templates/{email_template_id} Retrieve an email template
EmailApi listEmailTemplates GET /rest/v2/emails/templates List email templates
EmailApi listEmails GET /rest/v2/emails List Emails
EmailApi sendEmail POST /rest/v2/emails:send Send an Email
EmailApi sendEmailTemplate POST /rest/v2/emails/templates:send Send an email based on a template
EmailAddressApi getEmailAddressStatus GET /rest/v2/emailAddresses/{email}/status Retrieve an Email Address status
EmailAddressApi listEmailAddressStatuses GET /rest/v2/emailAddresses List Email Address Statuses
EmailAddressApi updateEmailAddressOptStatus PATCH /rest/v2/emailAddresses/{email}/status Update an Email Address opt-in status
FilesApi createFile POST /rest/v2/files Create a file
FilesApi deleteFile DELETE /rest/v2/files/{file_id} Delete a file
FilesApi getFile GET /rest/v2/files/{file_id} Retrieve a file
FilesApi getFileData1 GET /rest/v2/files/{file_id}:data Retrieve a file's data
FilesApi listFiles GET /rest/v2/files List all files
FilesApi updateFile POST /rest/v2/files/{file_id} Update a file
FreeTrialDiscountsApi createFreeTrialDiscount POST /rest/v2/discounts/freeTrials Create a Subscription Free Trial Discount
FreeTrialDiscountsApi createFreeTrialDiscountCriteria POST /rest/v2/discounts/freeTrials/{discount_id}/criteria Create a Subscription Free Trial Discount Criteria
FreeTrialDiscountsApi deleteFreeTrialDiscount DELETE /rest/v2/discounts/freeTrials/{discount_id} Delete a Subscription Free Trial Discount
FreeTrialDiscountsApi deleteFreeTrialDiscountCriteria DELETE /rest/v2/discounts/freeTrials/{discount_id}/criteria/{criteria_id} Delete a Subscription Free Trial Discount Criteria
FreeTrialDiscountsApi getFreeTrialDiscount GET /rest/v2/discounts/freeTrials/{discount_id} Retrieve a Subscription Free Trial Discount
FreeTrialDiscountsApi listFreeTrialDiscounts GET /rest/v2/discounts/freeTrials List all Subscription Free Trial Discounts
FreeTrialDiscountsApi updateFreeTrialDiscount PATCH /rest/v2/discounts/freeTrials/{discount_id} Update a Subscription Free Trial Discount
IntegrationsApi achieveIntegrationsWordPressOptInGoal POST /rest/v2/integrations/wordpress/options/{option_key}:achieve Achieve a WordPress Opt-In Goal
IntegrationsApi addIntegrationsWordPressOptIn POST /rest/v2/integrations/wordpress/options Add a WordPress Opt-In Option
IntegrationsApi deleteIntegrationsWordPressOptIn DELETE /rest/v2/integrations/wordpress/options/{option_key} Delete a WordPress Opt-In Option
IntegrationsApi listIntegrationsWordPressOptInOptions GET /rest/v2/integrations/wordpress/options List WordPress Opt-In Options
LeadScoreApi getLeadScoreDetails GET /rest/v2/contacts/{contact_id}/leadScore Retrieve Lead Score of a Contact
LeadSourceCategoriesApi createLeadSourceCategory POST /rest/v2/leadSourceCategories Create a Lead Source Category
LeadSourceCategoriesApi deleteLeadSourceCategory DELETE /rest/v2/leadSourceCategories/{lead_source_category_id} Delete a Lead Source Category
LeadSourceCategoriesApi getLeadSourceCategory GET /rest/v2/leadSourceCategories/{lead_source_category_id} Retrieve a Lead Source Category
LeadSourceCategoriesApi listLeadSourceCategories GET /rest/v2/leadSourceCategories List Lead Source Categories
LeadSourceCategoriesApi updateLeadSourceCategory PATCH /rest/v2/leadSourceCategories/{lead_source_category_id} Update a Lead Source Category
LeadSourceExpensesApi createLeadSourceExpense POST /rest/v2/leadSources/{lead_source_id}/expenses Create a Lead Source Expense
LeadSourceExpensesApi deleteLeadSourceExpense DELETE /rest/v2/leadSources/{lead_source_id}/expenses/{lead_source_expense_id} Delete a lead source expense
LeadSourceExpensesApi getLeadSourceExpense GET /rest/v2/leadSources/{lead_source_id}/expenses/{lead_source_expense_id} Retrieve a Lead Source Expense
LeadSourceExpensesApi listLeadSourceExpenses GET /rest/v2/leadSources/{lead_source_id}/expenses List Lead Source Expenses
LeadSourceExpensesApi updateLeadSourceExpense PATCH /rest/v2/leadSources/{lead_source_id}/expenses/{lead_source_expense_id} Update a Lead Source Expense
LeadSourceRecurringExpensesApi createLeadSourceRecurringExpense POST /rest/v2/leadSources/{lead_source_id}/recurringExpenses Create a Lead Source Recurring Expense
LeadSourceRecurringExpensesApi deleteLeadSourceRecurringExpense DELETE /rest/v2/leadSources/{lead_source_id}/recurringExpenses/{lead_source_recurring_expense_id} Delete a Lead Source Recurring Expense
LeadSourceRecurringExpensesApi getLeadSourceRecurringExpense GET /rest/v2/leadSources/{lead_source_id}/recurringExpenses/{lead_source_recurring_expense_id} Retrieve a Lead Source Recurring Expense
LeadSourceRecurringExpensesApi listExpensesIncurredFromLeadSourceRecurringExpense GET /rest/v2/leadSources/{lead_source_id}/recurringExpenses/{lead_source_recurring_expense_id}/expenses Retrieves a list of expenses incurred from a recurring expense
LeadSourceRecurringExpensesApi listLeadSourceRecurringExpenses GET /rest/v2/leadSources/{lead_source_id}/recurringExpenses Retrieves a list of lead source recurring expenses
LeadSourceRecurringExpensesApi updateLeadSourceRecurringExpense PATCH /rest/v2/leadSources/{lead_source_id}/recurringExpenses/{lead_source_recurring_expense_id} Update a Lead Source Recurring Expense
LeadSourcesApi createLeadSource POST /rest/v2/leadSources Create a Lead Source
LeadSourcesApi deleteLeadSource DELETE /rest/v2/leadSources/{lead_source_id} Delete a Lead Source
LeadSourcesApi getLeadSource GET /rest/v2/leadSources/{lead_source_id} Retrieve a Lead Source
LeadSourcesApi listLeadSources GET /rest/v2/leadSources List Lead Sources
LeadSourcesApi updateLeadSource PATCH /rest/v2/leadSources/{lead_source_id} Update a Lead Source
LocaleApi getCountryByCode GET /rest/v2/locales/countries/{country_code} Get Country
LocaleApi getProvinceByCode GET /rest/v2/locales/countries/{country_code}/provinces/{province_code} Get Province
LocaleApi listCountries GET /rest/v2/locales/countries List Countries
LocaleApi listProvincesForCountry GET /rest/v2/locales/countries/{country_code}/provinces List a Country's Provinces
MerchantsApi listMerchants GET /rest/v2/merchants List Merchant accounts
NoteApi createNote POST /rest/v2/contacts/{contact_id}/notes Create a Note
NoteApi createNoteCustomField POST /rest/v2/notes/model/customFields Create a Custom Field
NoteApi createNoteCustomFieldGroup POST /rest/v2/notes/model/customFields/groups Create a Note Custom Field Group
NoteApi createNoteCustomFieldTab POST /rest/v2/notes/model/customFields/tabs Create a Note Custom Field Tab
NoteApi deleteNote DELETE /rest/v2/contacts/{contact_id}/notes/{note_id} Delete a Note
NoteApi deleteNoteCustomFieldGroup DELETE /rest/v2/notes/model/customFields/groups/{group_id} Delete a Note Custom Field Group
NoteApi deleteNoteCustomFieldTab DELETE /rest/v2/notes/model/customFields/tabs/{tab_id} Delete a Note Custom Field Tab
NoteApi deleteNotesCustomField DELETE /rest/v2/notes/model/customFields/{custom_field_id} Delete a Note Custom Field
NoteApi getNote GET /rest/v2/contacts/{contact_id}/notes/{note_id} Retrieve a Note
NoteApi getNoteCustomFieldGroup GET /rest/v2/notes/model/customFields/groups/{group_id} Retrieve a Note Custom Field Group
NoteApi getNoteCustomFieldTab GET /rest/v2/notes/model/customFields/tabs/{tab_id} Retrieve a Note Custom Field Tab
NoteApi listAllNotes GET /rest/v2/notes List All Notes
NoteApi listNoteCustomFieldGroups GET /rest/v2/notes/model/customFields/groups List Note Custom Field Groups
NoteApi listNoteCustomFieldTabs GET /rest/v2/notes/model/customFields/tabs List Note Custom Field Tabs
NoteApi listNoteTemplates GET /rest/v2/notes/templates Retrieve Note Templates
NoteApi listNotes GET /rest/v2/contacts/{contact_id}/notes List Notes
NoteApi retrieveNoteModel GET /rest/v2/notes/model Retrieve Note Model
NoteApi updateNote PATCH /rest/v2/contacts/{contact_id}/notes/{note_id} Update a Note
NoteApi updateNoteCustomFieldGroup PATCH /rest/v2/notes/model/customFields/groups/{group_id} Update a Note Custom Field Group
NoteApi updateNoteCustomFieldTab PATCH /rest/v2/notes/model/customFields/tabs/{tab_id} Update a Note Custom Field Tab
NoteApi updateNotesCustomField PATCH /rest/v2/notes/model/customFields/{custom_field_id} Update a Custom Field
OpportunityApi createOpportunity POST /rest/v2/opportunities Create an Opportunity
OpportunityApi createOpportunityCustomFieldGroup POST /rest/v2/opportunities/model/customFields/groups Create an Opportunity Custom Field Group
OpportunityApi createOpportunityCustomFieldTab POST /rest/v2/opportunities/model/customFields/tabs Create an Opportunity Custom Field Tab
OpportunityApi createOpportunityCustomFields POST /rest/v2/opportunities/model/customFields Create an Opportunity Custom Field
OpportunityApi createOpportunityStage POST /rest/v2/opportunities/stages Create an Opportunity Stage
OpportunityApi deleteOpportunitiesCustomField DELETE /rest/v2/opportunities/model/customFields/{custom_field_id} Delete an Opportunity Custom Field
OpportunityApi deleteOpportunity DELETE /rest/v2/opportunities/{opportunity_id} Delete an Opportunity
OpportunityApi deleteOpportunityCustomFieldGroup DELETE /rest/v2/opportunities/model/customFields/groups/{group_id} Delete an Opportunity Custom Field Group
OpportunityApi deleteOpportunityCustomFieldTab DELETE /rest/v2/opportunities/model/customFields/tabs/{tab_id} Delete an Opportunity Custom Field Tab
OpportunityApi deleteOpportunityStage DELETE /rest/v2/opportunities/stages/{stage_id} Delete an Opportunity Stage
OpportunityApi getOpportunity GET /rest/v2/opportunities/{opportunity_id} Retrieve a Opportunity
OpportunityApi getOpportunityCustomFieldGroup GET /rest/v2/opportunities/model/customFields/groups/{group_id} Retrieve an Opportunity Custom Field Group
OpportunityApi getOpportunityCustomFieldTab GET /rest/v2/opportunities/model/customFields/tabs/{tab_id} Retrieve an Opportunity Custom Field Tab
OpportunityApi getOpportunityStage GET /rest/v2/opportunities/stages/{stage_id} Retrieve an Opportunity Stage
OpportunityApi getOpportunityStageMove GET /rest/v2/opportunities/stageMoves/{stage_move_id} Retrieve an Opportunity Stage Move
OpportunityApi listOpportunities GET /rest/v2/opportunities List Opportunities
OpportunityApi listOpportunityCustomFieldGroups GET /rest/v2/opportunities/model/customFields/groups List Opportunity Custom Field Groups
OpportunityApi listOpportunityCustomFieldTabs GET /rest/v2/opportunities/model/customFields/tabs List Opportunity Custom Field Tabs
OpportunityApi listOpportunityStageMoves GET /rest/v2/opportunities/stageMoves List Opportunity Stage Moves
OpportunityApi listOpportunityStages GET /rest/v2/opportunities/stages List of Opportunity Stages
OpportunityApi retrieveOpportunityCustomFieldModel GET /rest/v2/opportunities/model Retrieve Opportunity Custom Field Model
OpportunityApi updateOpportunity PATCH /rest/v2/opportunities/{opportunity_id} Update an opportunity
OpportunityApi updateOpportunityCustomField PATCH /rest/v2/opportunities/model/customFields/{custom_field_id} Update a Opportunity's Custom Field
OpportunityApi updateOpportunityCustomFieldGroup PATCH /rest/v2/opportunities/model/customFields/groups/{group_id} Update an Opportunity Custom Field Group
OpportunityApi updateOpportunityCustomFieldTab PATCH /rest/v2/opportunities/model/customFields/tabs/{tab_id} Update an Opportunity Custom Field Tab
OpportunityApi updateOpportunityStage PATCH /rest/v2/opportunities/stages/{stage_id} Update an Opportunity Stage
OrderTotalDiscountsApi createOrderTotalDiscount POST /rest/v2/discounts/orderTotals Create an Order Total Discount
OrderTotalDiscountsApi createOrderTotalDiscountCriteria POST /rest/v2/discounts/orderTotals/{discount_id}/criteria Create an Order Total Discount Criteria
OrderTotalDiscountsApi deleteOrderTotalDiscount DELETE /rest/v2/discounts/orderTotals/{discount_id} Delete an Order Total Discount
OrderTotalDiscountsApi deleteOrderTotalDiscountCriteria DELETE /rest/v2/discounts/orderTotals/{discount_id}/criteria/{criteria_id} Delete an Order Total Discount Criteria
OrderTotalDiscountsApi getOrderTotalDiscount GET /rest/v2/discounts/orderTotals/{discount_id} Retrieve an Order Total Discount
OrderTotalDiscountsApi listOrderTotalDiscounts GET /rest/v2/discounts/orderTotals List all Order Total Discounts
OrderTotalDiscountsApi updateOrderTotalDiscount PATCH /rest/v2/discounts/orderTotals/{discount_id} Update an Order Total Discount
OrdersApi applyCommissionOnOrderItems POST /rest/v2/orders/{order_id}/items/{order_item_id}:applyCommission Apply Commission to an Order Item
OrdersApi applyTax POST /rest/v2/orders/{order_id}:applyTax Apply Taxes on an Order
OrdersApi attachFileToOrder POST /rest/v2/orders/{order_id}:attachFile Attach a File to an Order Invoice
OrdersApi createOrder POST /rest/v2/orders Create an Order
OrdersApi createOrderCustomField POST /rest/v2/orders/model/customFields Create an Order Custom Field
OrdersApi createOrderCustomFieldGroup POST /rest/v2/orders/model/customFields/groups Create an Order Custom Field Group
OrdersApi createOrderCustomFieldTab POST /rest/v2/orders/model/customFields/tabs Create an Order Custom Field Tab
OrdersApi createOrderItem POST /rest/v2/orders/{order_id}/items Create an Order Item
OrdersApi createPaymentForAnOrder POST /rest/v2/orders/{order_id}/payments Create a Payment
OrdersApi deleteOrder DELETE /rest/v2/orders/{order_id} Delete an Order
OrdersApi deleteOrderCustomField DELETE /rest/v2/orders/model/customFields/{custom_field_id} Delete an Order Custom Field
OrdersApi deleteOrderCustomFieldGroup DELETE /rest/v2/orders/model/customFields/groups/{group_id} Delete an Order Custom Field Group
OrdersApi deleteOrderCustomFieldTab DELETE /rest/v2/orders/model/customFields/tabs/{tab_id} Delete an Order Custom Field Tab
OrdersApi deleteOrderItem DELETE /rest/v2/orders/{order_id}/items/{order_item_id} Delete an Order Item
OrdersApi detachFileFromOrder POST /rest/v2/orders/{order_id}:detachFile Detach a File from an Order Invoice
OrdersApi getOrder GET /rest/v2/orders/{order_id} Retrieve an Order
OrdersApi getOrderCustomFieldGroup GET /rest/v2/orders/model/customFields/groups/{group_id} Retrieve an Order Custom Field Group
OrdersApi getOrderCustomFieldTab GET /rest/v2/orders/model/customFields/tabs/{tab_id} Retrieve an Order Custom Field Tab
OrdersApi getOrderItem GET /rest/v2/orders/{order_id}/items/{order_item_id} Retrieve an Order Item
OrdersApi listOrderCustomFieldGroups GET /rest/v2/orders/model/customFields/groups List Order Custom Field Groups
OrdersApi listOrderCustomFieldTabs GET /rest/v2/orders/model/customFields/tabs List Order Custom Field Tabs
OrdersApi listOrderPayments GET /rest/v2/orders/{order_id}/payments Retrieve Order Payments
OrdersApi listOrders GET /rest/v2/orders List orders
OrdersApi retrieveOrderCustomFieldModel GET /rest/v2/orders/model Retrieve Order Custom Field Model
OrdersApi updateOrder PATCH /rest/v2/orders/{order_id} Update an Order
OrdersApi updateOrderCustomField PATCH /rest/v2/orders/model/customFields/{custom_field_id} Update an Order Custom Field
OrdersApi updateOrderCustomFieldGroup PATCH /rest/v2/orders/model/customFields/groups/{group_id} Update an Order Custom Field Group
OrdersApi updateOrderCustomFieldTab PATCH /rest/v2/orders/model/customFields/tabs/{tab_id} Update an Order Custom Field Tab
OrdersApi updateOrderItem PATCH /rest/v2/orders/{order_id}/items/{order_item_id} Update an Order Item
OrdersApi updatePayment PATCH /rest/v2/orders/{order_id}/payments/{payment_id} Update a Payment
PaymentMethodConfigsApi createPaymentMethodConfig POST /rest/v2/paymentMethodConfigs Create Payment Method Configuration
PaymentMethodsApi deactivatePaymentMethod POST /rest/v2/contacts/{contact_id}/paymentMethods/{payment_method_id}:deactivate Deactivate a Contact Payment Method
PaymentMethodsApi deletePaymentMethod DELETE /rest/v2/contacts/{contact_id}/paymentMethods/{payment_method_id} Delete a Contact Payment Method
PaymentMethodsApi listPaymentMethods GET /rest/v2/paymentMethods List of Payment Methods
PaymentMethodsApi listPaymentMethods1 GET /rest/v2/contacts/{contact_id}/paymentMethods List of Contact Payment Methods
ProductCategoriesApi assignProductsToCategory POST /rest/v2/productCategories/{category_id}:assignProducts Assign Products to a Product Category
ProductCategoriesApi createImageFile POST /rest/v2/productCategories/{category_id}/images Create the product category image file
ProductCategoriesApi createProductCategory POST /rest/v2/productCategories Create a Product Category
ProductCategoriesApi deleteImageFile DELETE /rest/v2/productCategories/{category_id}/images Delete the image from a product category
ProductCategoriesApi deleteProductCategory DELETE /rest/v2/productCategories/{category_id} Delete a Product Category
ProductCategoriesApi getProductCategory GET /rest/v2/productCategories/{category_id} Get a Product Category
ProductCategoriesApi listAssignedProducts GET /rest/v2/productCategories/assignedProducts List Assigned Products to Categories
ProductCategoriesApi listProductCategories GET /rest/v2/productCategories List all Product Categories
ProductCategoriesApi updateProductCategory PATCH /rest/v2/productCategories/{category_id} Update a Product Category
ProductDiscountsApi createProductDiscount POST /rest/v2/discounts/products Create a Product Discount
ProductDiscountsApi createProductDiscountCriteria POST /rest/v2/discounts/products/{discount_id}/criteria Create a Product Discount Criteria
ProductDiscountsApi deleteProductDiscount DELETE /rest/v2/discounts/products/{discount_id} Delete a Product Discount
ProductDiscountsApi deleteProductDiscountCriteria DELETE /rest/v2/discounts/products/{discount_id}/criteria/{criteria_id} Delete a Product Discount Criteria
ProductDiscountsApi getProductDiscount GET /rest/v2/discounts/products/{discount_id} Retrieve a Product Discount
ProductDiscountsApi listProductDiscounts GET /rest/v2/discounts/products List all Product Discounts
ProductDiscountsApi updateProductDiscount PATCH /rest/v2/discounts/products/{discount_id} Update a Product Discount
ProductInterestBundlesApi addProductInterest POST /rest/v2/productInterestBundles/{id}/interests Create a Product Interest in an existing Bundle
ProductInterestBundlesApi createProductInterestBundle POST /rest/v2/productInterestBundles Create a Product Interest Bundle
ProductInterestBundlesApi deleteProductInterestBundle DELETE /rest/v2/productInterestBundles/{id} Delete a Product Interest Bundle
ProductInterestBundlesApi getProductInterestBundle GET /rest/v2/productInterestBundles/{id} Get a Product Interest Bundle
ProductInterestBundlesApi listProductInterestBundles GET /rest/v2/productInterestBundles List Product Interest Bundles
ProductInterestBundlesApi removeProductInterest DELETE /rest/v2/productInterestBundles/{id}/interests/{interest_id} Delete a Product Interest from an existing Bundle
ProductInterestBundlesApi updateProductInterest PATCH /rest/v2/productInterestBundles/{id}/interests/{interest_id} Update a Product Interest in an existing Bundle
ProductInterestBundlesApi updateProductInterestBundle PATCH /rest/v2/productInterestBundles/{id} Update a Product Interest Bundle
ProductsApi addProductOptionListOptionValue POST /rest/v2/products/{product_id}/options/{product_option_id}/listItems Add a Product Option List Option Value
ProductsApi adjustInventory POST /rest/v2/products/{product_id}:adjustInventory Adjust Inventory of a Product
ProductsApi createProduct POST /rest/v2/products Create a Product
ProductsApi createProductImage POST /rest/v2/products/{product_id}/images Create the Product Image
ProductsApi createProductOption POST /rest/v2/products/{product_id}/options Create a Product Option
ProductsApi deleteProduct DELETE /rest/v2/products/{product_id} Delete a Product
ProductsApi deleteProductImage DELETE /rest/v2/products/{product_id}/images Delete the Product Image
ProductsApi deleteProductOption DELETE /rest/v2/products/{product_id}/options/{product_option_id} Delete a Product Option
ProductsApi deleteProductOptionListOptionValue DELETE /rest/v2/products/{product_id}/options/{product_option_id}/listItems/{item_id} Delete a Product Option List Item
ProductsApi getFileData GET /rest/v2/products/{product_id}/images/legacyImageData Retrieve Product Legacy Image Data
ProductsApi getProduct GET /rest/v2/products/{product_id} Get a Product
ProductsApi getProductOption GET /rest/v2/products/{product_id}/options/{product_option_id} Get Product Option
ProductsApi listProductOptions GET /rest/v2/products/{product_id}/options List Product Options
ProductsApi listProducts GET /rest/v2/products List Products
ProductsApi updateProduct PATCH /rest/v2/products/{product_id} Update a Product
ProductsApi updateProductOption PATCH /rest/v2/products/{product_id}/options/{product_option_id} Updates a Product Option
ProductsApi updateProductOptionListOptionValue PATCH /rest/v2/products/{product_id}/options/{product_option_id}/listItems/{item_id} Updates a Product Option List Option Value
ReferralApi createReferral POST /rest/v2/referrals Create a Referral
ReferralApi listReferrals GET /rest/v2/referrals List Referrals
ReportingApi listReports GET /rest/v2/reporting/reports List Reports
ReportingApi retrieveReport GET /rest/v2/reporting/reports/{report_id} Retrieve Report
ReportingApi retrieveReportModel GET /rest/v2/reporting/reports/{report_id}/model Retrieve Report Model
ReportingApi runReport POST /rest/v2/reporting/reports/{report_id}:run Run a Report
SalesApi listPayments GET /rest/v2/sales/payments List Payments
SalesApi listTransactions GET /rest/v2/sales/transactions List Transactions
SalesApi setMerchantGatewayAsDefault POST /rest/v2/sales/merchants/{id}:setDefault Set default Merchant Account
SettingsApi getApplicationConfigurations GET /rest/v2/settings/applications:getConfiguration Get Application Configuration
SettingsApi getContactOptionTypes GET /rest/v2/settings/contactOptionTypes Get Contact Option types
SettingsApi isApplicationEnabled GET /rest/v2/settings/applications:isEnabled Get Application Status
ShippingApi listShippingMethods GET /rest/v2/shipping List Shipping methods
ShippingDiscountsApi createShippingDiscount POST /rest/v2/discounts/shipping Create a Shipping Discount
ShippingDiscountsApi createShippingDiscountCriteria POST /rest/v2/discounts/shipping/{discount_id}/criteria Create a Shipping Discount Criteria
ShippingDiscountsApi deleteShippingDiscount DELETE /rest/v2/discounts/shipping/{discount_id} Delete a Shipping Discount
ShippingDiscountsApi deleteShippingDiscountCriteria DELETE /rest/v2/discounts/shipping/{discount_id}/criteria/{criteria_id} Delete a Shipping Discount Criteria
ShippingDiscountsApi getShippingDiscount GET /rest/v2/discounts/shipping/{discount_id} Retrieve a Shipping Discount
ShippingDiscountsApi listShippingDiscounts GET /rest/v2/discounts/shipping List all Shipping Discounts
ShippingDiscountsApi updateShippingDiscount PATCH /rest/v2/discounts/shipping/{discount_id} Update a Shipping Discount
SubscriptionPlansApi createSubscriptionPlans POST /rest/v2/products/{product_id}/subscriptions Create Subscription Plan
SubscriptionPlansApi deleteSubscriptionPlan DELETE /rest/v2/products/{product_id}/subscriptions/{subscription_plan_id} Delete Subscription Plan
SubscriptionPlansApi fetchSubscriptionPlan GET /rest/v2/products/{product_id}/subscriptions/{subscription_plan_id} Get Subscription Plan
SubscriptionPlansApi listSubscriptionPlans GET /rest/v2/products/{product_id}/subscriptions List Subscription Plans
SubscriptionPlansApi updateSubscriptionPlan PATCH /rest/v2/products/{product_id}/subscriptions/{subscription_plan_id} Update Subscription Plan
SubscriptionsApi cancelSubscription POST /rest/v2/subscriptions/{subscription_id}:deactivate Cancel Subscription
SubscriptionsApi createSubscription POST /rest/v2/subscriptions Create Subscription
SubscriptionsApi createSubscriptionCustomField POST /rest/v2/subscriptions/model/customFields Create a Subscription Custom Field
SubscriptionsApi createSubscriptionCustomFieldGroup POST /rest/v2/subscriptions/model/customFields/groups Create a Subscription Custom Field Group
SubscriptionsApi createSubscriptionCustomFieldTab POST /rest/v2/subscriptions/model/customFields/tabs Create a Subscription Custom Field Tab
SubscriptionsApi deleteSubscriptionCustomField DELETE /rest/v2/subscriptions/model/customFields/{custom_field_id} Delete a Subscription Custom Field
SubscriptionsApi deleteSubscriptionCustomFieldGroup DELETE /rest/v2/subscriptions/model/customFields/groups/{group_id} Delete a Subscription Custom Field Group
SubscriptionsApi deleteSubscriptionCustomFieldTab DELETE /rest/v2/subscriptions/model/customFields/tabs/{tab_id} Delete a Subscription Custom Field Tab
SubscriptionsApi getSubscription GET /rest/v2/subscriptions/{subscription_id} Retrieve a Subscription
SubscriptionsApi getSubscriptionCustomFieldGroup GET /rest/v2/subscriptions/model/customFields/groups/{group_id} Retrieve a Subscription Custom Field Group
SubscriptionsApi getSubscriptionCustomFieldTab GET /rest/v2/subscriptions/model/customFields/tabs/{tab_id} Retrieve a Subscription Custom Field Tab
SubscriptionsApi invoiceSubscription POST /rest/v2/subscriptions/{subscription_id}:invoice Invoice a Subscription
SubscriptionsApi listSubscriptionCustomFieldGroups GET /rest/v2/subscriptions/model/customFields/groups List Subscription Custom Field Groups
SubscriptionsApi listSubscriptionCustomFieldTabs GET /rest/v2/subscriptions/model/customFields/tabs List Subscription Custom Field Tabs
SubscriptionsApi listSubscriptions GET /rest/v2/subscriptions List Subscriptions
SubscriptionsApi retrieveSubscriptionCustomFieldModel GET /rest/v2/subscriptions/model Retrieve Subscription Custom Field Model
SubscriptionsApi updateSubscription PATCH /rest/v2/subscriptions/{subscription_id} Update a Subscription
SubscriptionsApi updateSubscriptionCustomField PATCH /rest/v2/subscriptions/model/customFields/{custom_field_id} Update a Subscription Custom Field
SubscriptionsApi updateSubscriptionCustomFieldGroup PATCH /rest/v2/subscriptions/model/customFields/groups/{group_id} Update a Subscription Custom Field Group
SubscriptionsApi updateSubscriptionCustomFieldTab PATCH /rest/v2/subscriptions/model/customFields/tabs/{tab_id} Update a Subscription Custom Field Tab
TagsApi applyTags POST /rest/v2/tags/{tag_id}/contacts:applyTags Apply Tag
TagsApi countContactsForTag GET /rest/v2/tags/{tag_id}/contacts/count Tag Contact Count
TagsApi createTag POST /rest/v2/tags Create Tag
TagsApi createTagCategory POST /rest/v2/tags/categories Create Tag Category
TagsApi deleteTag DELETE /rest/v2/tags/{tag_id} Delete Tag
TagsApi deleteTagCategory DELETE /rest/v2/tags/categories/{tag_category_id} Delete Tag Category
TagsApi getCategory GET /rest/v2/tags/categories/{tag_category_id} Retrieve a Tag Category
TagsApi getTag GET /rest/v2/tags/{tag_id} Retrieve a Tag
TagsApi listCompaniesForTagId GET /rest/v2/tags/{tag_id}/companies List Tagged Companies
TagsApi listContactsAcrossTags GET /rest/v2/tags/-/contacts List Tag's Contacts
TagsApi listContactsWithTagId GET /rest/v2/tags/{tag_id}/contacts List Tagged Contacts
TagsApi listTagCategories GET /rest/v2/tags/categories List Tag Categories
TagsApi listTags GET /rest/v2/tags List Tags
TagsApi removeTags POST /rest/v2/tags/{tag_id}/contacts:removeTags Remove Tags
TagsApi updateTag PATCH /rest/v2/tags/{tag_id} Update a Tag
TagsApi updateTagCategory PATCH /rest/v2/tags/categories/{tag_category_id} Update a Tag Category
TaskApi createTask POST /rest/v2/tasks Create a Task
TaskApi createTaskCustomField POST /rest/v2/tasks/model/customFields Create a Custom Field
TaskApi createTaskCustomFieldGroup POST /rest/v2/tasks/model/customFields/groups Create a Task Custom Field Group
TaskApi createTaskCustomFieldTab POST /rest/v2/tasks/model/customFields/tabs Create a Task Custom Field Tab
TaskApi deleteTask DELETE /rest/v2/tasks/{task_id} Delete a Task
TaskApi deleteTaskCustomField DELETE /rest/v2/tasks/model/customFields/{custom_field_id} Delete a Custom Field
TaskApi deleteTaskCustomFieldGroup DELETE /rest/v2/tasks/model/customFields/groups/{group_id} Delete a Task Custom Field Group
TaskApi deleteTaskCustomFieldTab DELETE /rest/v2/tasks/model/customFields/tabs/{tab_id} Delete a Task Custom Field Tab
TaskApi getTask GET /rest/v2/tasks/{task_id} Retrieve a Task
TaskApi getTaskCustomFieldGroup GET /rest/v2/tasks/model/customFields/groups/{group_id} Retrieve a Task Custom Field Group
TaskApi getTaskCustomFieldTab GET /rest/v2/tasks/model/customFields/tabs/{tab_id} Retrieve a Task Custom Field Tab
TaskApi listTaskCustomFieldGroups GET /rest/v2/tasks/model/customFields/groups List Task Custom Field Groups
TaskApi listTaskCustomFieldTabs GET /rest/v2/tasks/model/customFields/tabs List Task Custom Field Tabs
TaskApi listTasks GET /rest/v2/tasks List Tasks
TaskApi retrieveTaskModel GET /rest/v2/tasks/model Retrieve Task Model
TaskApi updateTask PATCH /rest/v2/tasks/{task_id} Update a Task
TaskApi updateTaskCustomField PATCH /rest/v2/tasks/model/customFields/{custom_field_id} Update a Task's Custom Field
TaskApi updateTaskCustomFieldGroup PATCH /rest/v2/tasks/model/customFields/groups/{group_id} Update a Task Custom Field Group
TaskApi updateTaskCustomFieldTab PATCH /rest/v2/tasks/model/customFields/tabs/{tab_id} Update a Task Custom Field Tab
UserGroupsApi getUserGroup GET /rest/v2/userGroups/{user_group_id} Retrieve a User Group
UserGroupsApi listUserGroups GET /rest/v2/userGroups List User Groups
UsersApi getUserById GET /rest/v2/users/{user_id} Get User
UsersApi getUserInfo GET /rest/v2/oauth/connect/userinfo Retrieve User Info
UsersApi getUserSignature GET /rest/v2/users/{user_id}/signature Get User email signature
UsersApi listPaginatedUsers GET /rest/v2/users List Users
UsersApi updateUser PATCH /rest/v2/users/{user_id} Update User
WebformsApi getHtml GET /rest/v2/webforms/{webform_id}:data Get Webform HTML
WebformsApi listWebforms GET /rest/v2/webforms List Webforms with filter

Models

Authorization

Authentication schemes defined for the API:

oauth2

Tests

To run the tests, use:

Author

[email protected]

About this package

This PHP package is automatically generated by the OpenAPI Generator project:


All versions of keap-sdk with dependencies

PHP Build Version
Package Version
Requires php Version >=8.3
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package keap/keap-sdk contains the following files

Loading the files please wait ...