How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Infusionsoft (Keap)

Keap REST API v2

The default Keap REST API: 237 paths and 399 operations covering contacts, companies, tags, opportunities and stages, orders and order items, products, subscriptions and plans, notes, tasks, emails, automations, affiliates, lead sources, users and settings. Pages with opaque page_token cursors, filters with a filter expression parameter, and uses colon-suffixed custom verbs such as :merge, :applyTags and :achieve. Every major entity carries a per-tenant custom-field model. Authentication is a bearer token - OAuth 2.0 authorization code, a Personal Access Token, or a Service Account Key.

Documentation Provider Profile APIs.io OpenAPI GitHub

Keap REST API v2 is one of 4 APIs that Infusionsoft (Keap) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include CRM, Contacts, Opportunities, Order, and Subscription. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 399 operations across 237 paths, organized into 43 resource areas, and defines 384 schemas. It is described by OpenAPI 3.1.0, at version v2.

Requests are made against a single base URL, https://api.infusionsoft.com/crm.

399 operations 237 paths 384 schemas 69 DELETE160 GET63 PATCH106 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Base URL
https://api.infusionsoft.com/crm/rest/v2
Authentication
OAuth 2.0
Contact
Keap
License
Apache 2.0
Terms of Service
View terms
Resource Areas
43

Authentication & Security 1

Keap REST API v2 declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. By default, every request must be authenticated.

Paths & Operations 399

Across 237 paths, the API surfaces 399 operations — 69 DELETE, 160 GET, 63 PATCH, 106 POST, 1 PUT. They span 43 resource areas, including Automation, Task, Tags, Subscriptions, Sales, Reporting, Referral, Products, and 35 more. Each is listed below with its method, path, parameters, and response codes.

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

Schemas 384

The contract defines 384 schemas that model the data the API accepts and returns. The most detailed are Contact (40 properties), OrderV2 (35 properties), Company (31 properties), CreateUpdateContactRequest (30 properties). Each schema is shown below with its type and property counts.

Error
object
4 properties
ErrorDetails
object
2 properties
UnpublishAutomationRequest
object
Request to unpublish a single automation
1 property
CreateTaskRequest
object
task
13 properties 1 required
CustomFieldValueObject
object
2 properties
Task
object
18 properties
CreateCustomFieldOptionRequest
object
1 property
CreateCustomFieldRequest
object
5 properties 2 required
CreateCustomFieldResponse
object
1 property
CustomFieldMetaData
object
Metadata describing a custom field, including its type and options
9 properties
CustomFieldOption
object
2 properties
CreateCustomFieldTabRequest
object
1 property
CustomFieldTab
object
4 properties
CreateCustomFieldGroupRequest
object
2 properties
CustomFieldGroup
object
5 properties
CategoryReference
object
1 property 1 required
CreateUpdateTagRequest
object
tag
3 properties
Tag
object
6 properties
ApplyRemoveTagRequest
object
1 property 1 required
ApplyTagsResponse
object
1 property
CreateUpdateTagCategoryRequest
object
tagCategory
2 properties
TagCategory
object
5 properties
AddressRequest
object
7 properties
CreateSubscriptionRequest
object
19 properties 2 required
CustomFieldValue
object
2 properties
Address
object
11 properties
Subscription
object
27 properties
BasicContact
object
4 properties
CurrencyValue
object
3 properties
Discount
object
3 properties
InvoiceFile
object
1 property
OrderItem
object
13 properties
OrderItemProduct
object
6 properties
OrderV2
object
35 properties
PaymentPlan
object
11 properties 3 required
PaymentPlanItem
object
4 properties
ShippingInformation
object
7 properties
SubscriptionPlan
object
8 properties
CancelSubscriptionRequest
object
1 property
RunReportRequest
object
4 properties
ReportEntryRecord
object
1 property
ReportEntryValue
object
2 properties
ReportExecutionResult
object
2 properties
CreateReferralRequest
object
8 properties 1 required
Referral
object
9 properties
CreateProductRequest_Detail
object
20 properties 3 required
ProductInventory_Detail
object
4 properties
CurrencyValue_Detail
object
3 properties
ProductFixedOption_Detail
object
3 properties
ProductOptions_Detail
object
5 properties
ProductVariableSetting_Detail
object
7 properties
RestV2Product_Detail
object
27 properties
SubscriptionPlan_Detail
object
8 properties
UpdateProductInventoryRequest_Detail
object
2 properties
CreateSubscriptionPlanRequest
object
7 properties 2 required
CreateProductOptionListOption
object
4 properties
CreateProductOptionRequest
object
6 properties 1 required
CreateProductOptionTextOption
object
7 properties
ListOption
object
5 properties
ProductOption
object
8 properties
TextOption
object
7 properties
CreateProductInterestBundleRequest
object
2 properties 2 required
ProductInterest
object
6 properties
ProductInterestBundle
object
5 properties
AddProductInterestRequest
object
5 properties 3 required
CreateProductCategoryRequest
object
productCategory
3 properties 1 required
ProductCategory
object
4 properties
AssignProductsRequest
object
1 property 1 required
CreatePaymentMethodConfigRequest
object
1 property
PaymentMethodConfig
object
1 property
AddressInformation
object
13 properties
CreateOrderItemRequest
object
10 properties 1 required
RestCreateOrderRequest
object
19 properties 4 required
FileOperationRequest
object
File name
1 property 1 required
RestCreatePaymentRequest
object
12 properties 2 required
PaymentResult
object
5 properties
ApplyCommissionRequest
object
RestApplyCommissionRequest
6 properties 2 required
CreateOpportunityRequest
object
opportunity
13 properties 3 required
CustomField
object
2 properties
CheckListItemDetails
object
6 properties
OpportunityContact
object
9 properties 1 required
OpportunityStage
object
4 properties 1 required
RestV2Opportunity
object
25 properties 3 required
RestV2User
object
3 properties
StageDetails
object
4 properties
CreateOpportunityStageChecklistItem
object
3 properties 3 required
CreateOpportunityStageRequest
object
opportunity
5 properties 4 required
ChecklistItem
object
4 properties
RestOpportunityStage
object
8 properties
CreateLeadSourceRequest
object
9 properties
LeadSource
object
12 properties
CreateLeadSourceRecurringExpenseRequest
object
5 properties 1 required
LeadSourceRecurringExpense
object
10 properties
CreateLeadSourceExpenseRequest
object
4 properties 1 required
LeadSourceExpense
object
9 properties
CreateUpdateLeadSourceCategoryRequest
object
2 properties
LeadSourceCategory
object
5 properties
CreateIntegrationsWordPressOptInOption
object
2 properties
WordPressOptInOption
object
2 properties
AchieveIntegrationsWordPressOptInOptionGoalRequest
object
1 property
AchieveWordPressOptInGoalResult
object
1 property
FileMetadata
object
11 properties
CreateEmailSentRequest
object
Request to create an email record
17 properties 1 required
EmailSentWithContent
object
A sent email record with full content
18 properties
EmailSendRequest
object
Request to send an email to contacts
8 properties 2 required
EmailSendRequestAttachment
object
An attachment for an email
2 properties 2 required
DeleteEmailsRequest
object
Request to delete multiple email records
1 property 1 required
DeleteEmailsResponse
object
Response from deleting email records
1 property
CreateEmailsSentRequest
object
Email records to persist, with content.
1 property 1 required
EmailSentCreateError
object
Error that occurred when creating an email record
2 properties
EmailsSentList
object
Response containing created emails and any errors
2 properties
EmailSendTemplateRequest
object
Use a template to send an email to a list of contacts
4 properties 3 required
CreateShippingDiscountCriteria
object
11 properties
CreateShippingDiscountRequest
object
5 properties 3 required
DiscountCriteria
object
12 properties
ShippingDiscount
object
6 properties
CreateProductDiscountCriteria
object
11 properties
CreateProductDiscountRequest
object
7 properties 4 required
ProductDiscount
object
8 properties
CategoryDiscountCriteriaRequest
object
4 properties
CreateCategoryDiscountRequest
object
6 properties 4 required
CategoryDiscount
object
7 properties
CategoryDiscountCriteriaResponse
object
5 properties
CreateCategoryDiscountCriteria
object
4 properties
CreateOrderTotalDiscountCriteria
object
11 properties
CreateOrderTotalDiscountRequest
object
7 properties 3 required
OrderTotalDiscount
object
8 properties
CreateFreeTrialDiscountCriteria
object
11 properties
CreateFreeTrialDiscountRequest
object
6 properties 2 required
FreeTrialDiscount
object
7 properties
FreeTrialDiscountCriteriaResponse
object
12 properties
BasicCompany
object
2 properties
CreateContactUtmPropertiesRequest
object
6 properties 1 required
CreateUpdateContactRequest
object
contact
30 properties
EmailAddressRequest
object
3 properties
FaxNumber
object
3 properties
OriginRequest
object
1 property
PhoneNumber
object
5 properties
SocialAccount
object
2 properties 1 required
Contact
object
40 properties
ContactUtmResponse
object
10 properties
EmailAddress
object
5 properties
Link
object
4 properties
Origin
object
2 properties
LinkContactsRequest
object
3 properties
MergeContactRequest
object
2 properties 2 required
ContactLink
object
4 properties
CreateNoteRequest
object
6 properties 1 required
BasicUser
object
4 properties
Note
object
12 properties
CreateContactLinkTypeRequest
object
2 properties
ContactLinkType
object
4 properties
CreateCompanyRequest
object
company
24 properties
Company
object
31 properties
RemoveContactsFromSequenceRequest
object
1 property 1 required
RemoveContactsFromSequenceResponse
object
1 property
AddContactsToSequenceRequest
object
1 property 1 required
AddContactsToSequenceResponse
object
1 property
AddToAutomationSequenceRequest
object
1 property 1 required
AddToAutomationSequenceResponse
object
1 property
AchieveGoalRequest
object
Request to achieve a goal in an automation. You must provide EITHER (integration + callname) OR (automationid + goalid), along with contactid.
5 properties 1 required
AchieveGoalResponse
object
Response containing the results of achieving a goal
1 property
FlowEventResultDTO
object
Result of a flow being started or stopped
3 properties
GoalEventResultDTO
object
Result of achieving a specific goal
6 properties
AssignAutomationCategoryRequest
object
Request to assign categories to automations
3 properties
BatchUnpublishAutomationRequest
object
Request to unpublish multiple automations at once
2 properties 1 required
CreateAutomationCategoryRequest
object
Request to create an automation category
1 property 1 required
AutomationCategory
object
An automation category
3 properties
CreateAffiliateRequest
object
10 properties 2 required
RestAffiliate
object
12 properties
AffiliateRemoveFromProgramRequest
object
1 property
AffiliateAddToProgramRequest
object
1 property
CreateOrUpdateAffiliateLinkRequest
object
5 properties 3 required
AffiliateLink
object
9 properties
CreateCommissionProgramRequest
object
3 properties 2 required
AffiliateCommissionProgramResponse
object
4 properties
DeleteSubscriptionPlanCommissionRequest
object
2 properties
DeleteProgramCommissionRequest
object
1 property
CommissionItemRequest
object
4 properties
CreateSubscriptionCommissionProgramRequest
object
7 properties
CommissionItem
object
4 properties
DefaultCommission
object
6 properties
GetRestCommissionProgram
object
9 properties
ProductCommission
object
9 properties
SubscriptionCommission
object
9 properties
CreateProgramResourceRequest
object
9 properties 3 required
AffiliateProgramResource
object
10 properties
ResourceCommissionProgram
object
1 property
CreateProductCommissionProgramRequest
object
7 properties
CreateDefaultCommissionProgramRequest
object
6 properties
UpdateUserRequest
object
user
10 properties
User
object
A user in the system
24 properties
CreateUpdateTaskRequest
object
task
13 properties
UpdateTaskResponse
object
18 properties
UpdateCustomFieldMetaDataRequest
object
3 properties 1 required
UpdateCustomFieldTabRequest
object
2 properties
UpdateCustomFieldGroupRequest
object
3 properties
UpdateTagResponse
object
6 properties
UpdateTagCategoryResponse
object
5 properties
UpdateSubscriptionRequest
object
21 properties
UpdateProductRequest_Detail
object
22 properties
UpdateSubscriptionPlanRequest
object
7 properties 2 required
UpdateProductOptionRequest
object
10 properties
UpdateProductOptionListOption
object
4 properties
UpdateProductInterestBundleRequest
object
2 properties
UpdateProductInterestRequest
object
3 properties
UpdateProductCategoryRequest
object
3 properties
UpdateOrderRequest
object
order
19 properties
UpdatedPaymentPlan
object
9 properties
UpdateOrderItemRequest
object
order
9 properties
UpdateOpportunityRequestV2
object
13 properties
UpdateOpportunityStageChecklistItem
object
4 properties 3 required
UpdateOpportunityStageRequest
object
5 properties
LeadSourceRecurringExpenseUpdateRequest
object
5 properties
UpdateLeadSourceExpenseRequest
object
4 properties
UpdateEmailAddress
object
Request to update email address opt-in status
2 properties 2 required
RestEmailAddressStatus
object
Email address opt-in status information
7 properties 4 required
RenameEasyAutomationCommand
object
An object used to rename an automation.
1 property 1 required
UpdateShippingDiscountCriteria
object
11 properties 1 required
UpdateShippingDiscountRequest
object
5 properties
UpdateProductDiscountCriteria
object
11 properties 1 required
UpdateProductDiscountRequest
object
7 properties
UpdateCategoryDiscountRequest
object
6 properties
UpdateOrderTotalDiscountCriteria
object
11 properties 1 required
UpdateOrderTotalDiscountRequest
object
7 properties
UpdateFreeTrialDiscountCriteria
object
12 properties 1 required
UpdateFreeTrialDiscountRequest
object
6 properties
UpdateNoteRequest
object
7 properties 1 required
UpdateNoteResponse
object
12 properties
UpdateContactLinkTypeRequest
object
2 properties
UpdateCompanyRequest
object
company
24 properties
BusinessProfileAddressRequest
object
6 properties 6 required
UpdateBusinessProfileRequest
object
businessProfile
9 properties
BusinessProfileAddressResponse
object
6 properties
GetBusinessProfileResponse
object
Profile information about the business that owns/uses this account
13 properties
PatchAutomationCategoryRequest
object
1 property
UpdateAffiliateRequest
object
10 properties
UpdateCommissionProgramRequest
object
3 properties
UpdateSubscriptionCommissionProgramRequest
object
7 properties
UpdateProgramResourceRequest
object
8 properties
UpdateProductCommissionProgramRequest
object
7 properties 1 required
UpdateDefaultCommissionProgramRequest
object
6 properties
ListWebformsResponse
object
2 properties
Webform
object
13 properties
ListUsersPaginatedResponse
object
Paginated response containing a list of users
2 properties
ListUserGroupsResponse
object
Response containing a list of user groups
2 properties
UserGroup
object
A user group in the application
2 properties
ListTasksResponse
object
2 properties
ObjectModel
object
2 properties
ListCustomFieldTabsResponse
object
1 property
ListCustomFieldGroupsResponse
object
1 property
ListTagsResponse
object
2 properties
ListTaggedContactsResponse
object
2 properties
TaggedContact
object
5 properties
ListTaggedCompaniesResponse
object
2 properties
TaggedCompany
object
2 properties
ListTagCategoriesResponse
object
2 properties
GetTagCategoryResponse
object
5 properties
ListSubscriptionsResponse
object
2 properties
ListRestShippingMethodsResponse
object
1 property
ShippingMethod
object
7 properties
ShippingMethodSettings
GetContactOptionTypesResponse
object
1 property
GetApplicationEnabledStatusResponse
object
1 property
ApplicationCompany
object
13 properties
ApplicationConfigurationModuleAffiliate
object
7 properties
ApplicationConfigurationModuleAffiliateCommission
object
3 properties
ApplicationConfigurationModuleApplication
object
4 properties
ApplicationConfigurationModuleAppointment
object
2 properties
ApplicationConfigurationModuleContact
object
8 properties
ApplicationConfigurationModuleContactAddressLabels
object
3 properties
ApplicationConfigurationModuleEcommerce
object
13 properties
ApplicationConfigurationModuleEmail
object
5 properties
ApplicationConfigurationModuleForms
object
1 property
ApplicationConfigurationModuleFulfillment
object
2 properties
ApplicationConfigurationModuleInvoice
object
1 property
ApplicationConfigurationModuleNote
object
2 properties
ApplicationConfigurationModuleOpportunity
object
2 properties
ApplicationConfigurationModuleOpportunityStates
object
3 properties
ApplicationConfigurationModuleOpportunityStatesActive
object
1 property
ApplicationConfigurationModuleOpportunityStatesLoss
object
2 properties
ApplicationConfigurationModuleOpportunityStatesWin
object
2 properties
ApplicationConfigurationModuleTask
object
2 properties
ApplicationConfigurationModuleTemplate
object
2 properties
ApplicationFeaturesEnabled
object
1 property
GetSettingsResponse
object
13 properties
CardInfo
object
6 properties
ListTransactions
object
2 properties
PaymentMethod
object
9 properties
TransactionV2
object
16 properties
ListPayments
object
2 properties
Payment
object
16 properties
ListReportsResponse
object
2 properties
Report
object
5 properties
ReportField
object
2 properties
ReportModel
object
1 property
ListReferralsResponse
object
2 properties
CurrencyValue_List
object
3 properties
ListProductsResponse_List
object
2 properties
ProductFixedOption_List
object
3 properties
ProductInventory_List
object
3 properties
ProductOptions_List
object
5 properties
ProductVariableSetting_List
object
7 properties
RestV2Product_List
object
27 properties
SubscriptionPlan_List
object
8 properties
ListSubscriptionPlansResponse
object
2 properties
ListProductOptionsResponse
object
1 property
ListProductInterestBundleResponse
object
2 properties
ListProductCategoriesResponse
object
2 properties
AssignedProducts
object
2 properties
ListAssignedProductsResponse
object
2 properties
ListPaymentMethodsResponse
object
2 properties
ListOrders
object
2 properties
InvoiceOrderPayment
object
10 properties
ListOrderPaymentsResponse
object
2 properties
ListOpportunitiesResponse
object
2 properties
ListOpportunityStagesResponse
object
2 properties
ListOpportunityStageMoveResponse
object
2 properties
OpportunityStageMove
object
Historical record of an opportunity moving from one pipeline stage to another
9 properties
GetUserInfoResponse
object
User information response
10 properties
ListNotesResponse
object
2 properties
ListNoteTemplateResponse
object
2 properties
NoteTemplate
object
6 properties
ListMerchantAccountResponse
object
4 properties
ListMerchantsResponse
object
3 properties
Country
object
2 properties
CountryCodes
object
2 properties
ListCountriesResponse
object
2 properties 1 required
ListProvincesResponse
object
2 properties 1 required
Province
object
3 properties
ListLeadSourcesResponse
object
2 properties
ListLeadSourceRecurringExpensesResponse
object
2 properties
ListLeadSourceExpensesResponse
object
2 properties
ListLeadSourceCategoriesResponse
object
2 properties
ListWordPressOptInOptionsResponse
object
2 properties
ListFilesResponse
object
2 properties
EmailSent
object
A sent email record
16 properties
ListEmailsSentResponse
object
Response containing a list of sent emails
2 properties
EmailTemplateSummary
object
Email template metadata returned by the list endpoint. Does not include body content; use GET /v2/emails/templates/{id} for full detail.
10 properties
ListEmailTemplatesResponse
object
2 properties
EmailTemplate
object
An email template
12 properties
ListEmailAddressStatusResponse
object
2 properties
ListShippingDiscountsResponse
object
2 properties
ListProductDiscountsResponse
object
2 properties
ListCategoryDiscountsResponse
object
2 properties
ListOrderTotalDiscountsResponse
object
2 properties
ListFreeTrialDiscountsResponse
object
2 properties
ListContactsResponse
object
2 properties
AppliedTag
object
Tag with application timestamp
2 properties
ListContactTagsResponse
object
List of tags applied to a contact
2 properties
ListContactPaymentMethodsResponse
object
2 properties
GetNoteResponse
object
12 properties
ListContactLinksResponse
object
2 properties
LeadScore
object
2 properties
ListContactLinkTypesResponse
object
2 properties
ListCompaniesResponse
object
2 properties
ListCompanyTagsResponse
object
List of tags applied to a company
2 properties
Campaign
object
12 properties
ListCampaignsResponse
object
2 properties
HistoricalCounts
object
2 properties
Item
object
5 properties
ListCampaignSequenceResponse
object
3 properties
Sequence
object
6 properties
SequencePath
object
2 properties
Goal
object
6 properties
ListCampaignGoalsResponse
object
3 properties
Automation
object
11 properties
AutomationLockStatus
object
4 properties
ListAutomationResponse
object
3 properties
ListAutomationIdsResponse
object
Response containing a list of automation IDs
3 properties
ListAutomationCategoryResponse
object
Response containing a list of automation categories
2 properties
ListAffiliatesResponse
object
2 properties
AffiliateCommission
object
10 properties
ListAffiliateCommissionsResponse
object
5 properties
ListAffiliateReferralsResponse
object
2 properties
ListAffiliatePaymentsResponse
object
2 properties
RestAffiliatePayment
object
6 properties
AffiliateCommissionEarned
object
2 properties
AffiliateSummaryRecord
object
4 properties
ListAffiliateSummariesResponse
object
2 properties
ListAffiliateLinksResponse
object
2 properties
AffiliateProgramV2
object
6 properties
ListAffiliateCommissionProgramsResponse
object
2 properties
ListProgramResourcesResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

infusionsoft-rest-v2-openapi.json Raw ↑

Other APIs Infusionsoft (Keap) publishes across the network.

Keap REST API v1
AE Profile APIs.io
Keap Pipelines API
AE Profile APIs.io
Infusionsoft XML-RPC API
AE Profile APIs.io
#CRM#Contacts#Opportunities#Order#Subscription#Tags#Authentication
← Back to K APIs
API Details
ID
infusionsoft:rest-v2
Base URL
https://api.infusionsoft.com/crm/rest/v2
Docs
https://developer.keap.com/docs/restv2/
Provider
Infusionsoft (Keap)
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=rest-v2&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/rest-v2"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Keap REST API v2, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.