Account API Collections

Account Info API-Usage

Get the daily API usage of Private Apps and limits for a HubSpot account.

Account Info API-Details

Get account details for a HubSpot account.

Account Activity API-Activity

Get login activity for a HubSpot account.get-/account-info/v3/activity/audit-logs Get security activity for a HubSpot account

Auth - OAuth Collection

oauth-v1-access-tokens-{token}

get-/oauth/v1/access-tokens/{token} get

oauth-v1-refresh-tokens-{token}

get-/oauth/v1/refresh-tokens/{token} get delete-/oauth/v1/refresh-tokens/{token} archive

post-/oauth/v1/token create

Automation API Collections

Custom Workflow Actions API-Callbacks

Completes a single callback Completes a batch of callbacks

Custom Workflow Actions API-Definitions

Get paged extension definitions Create a new extension definition Get extension definition by Id Archive an extension definition Patch an existing extension definition

Custom Workflow Actions API-Functions

Get all functions for a given definition Get all functions by a type for a given definition Insert a function for a definition Delete a function for a definition Get a function for a given definition Insert a function for a definition Archive a function for a definition

Custom Workflow Actions API-Revisions

Gets a revision for a given definition by revision id Get all revisions for a given definition

CMS API Collections

Schedule a Blog Post to be Published Retrieve a batch of Blog Posts Update languages of multi-language group Retrieves a previous version of a blog post Update a batch of Blog Posts Retrieve the full draft version of the Blog Post Update a Blog Post draft Create a batch of Blog Posts Restore a previous version of a blog post, to the draft version of the blog post Create a new language variation Clone a Blog Post Get all Blog Posts Create a new Blog Post Restore a previous version of a blog post Detach a Blog Post from a multi-language group Push Blog Post draft edits live Delete a batch of Blog Posts Reset the Blog Post draft to the live version Attach a Blog Post to a multi-language group Retrieves all the previous versions of a blog post Set a new primary language Retrieve a Blog Post Delete a Blog Post Update a Blog Post

Blog Settings API

Update languages of multi-language group Retrieves all the previous versions of a Blog Retrieves a previous version of a Blog Retrieve a Blog Create a new language variation Get all Blogs Set a new primary language Detach a blog from a multi-language group Attach a blog to a multi-language group

Blog Tags API-Blog Tags

Update a batch of Blog Tags Update languages of multi-language group Detach a Blog Tag from a multi-language group Create a batch of Blog Tags Delete a batch of Blog Tags Set a new primary language Retrieve a batch of Blog Tags Get all Blog Tags Create a new Blog Tag Attach a Blog Tag to a multi-language group Retrieve a Blog Tag Delete a Blog Tag Update a Blog Tag Create a new language variation

Update a batch of Blog Authors Schedule a Blog Post to be Published Update languages of multi-language group Create a batch of Blog Posts Update a batch of Blog Posts Retrieve the full draft version of the Blog Post Update a Blog Post draft Retrieves a previous version of a blog post Restore a previous version of a blog post, to the draft version of the blog post Attach a Blog Author to a multi-language group Create a new language variation Restore a previous version of a blog post Detach a Blog Post from a multi-language group Create a batch of Blog Authors Push Blog Post draft edits live Get all Blog Authors Create a new Blog Author Reset the Blog Post draft to the live version Retrieve a Blog Post Delete a Blog Post Update a Blog Post Retrieve a Blog Author Delete a Blog Author Update a Blog Author Detach a Blog Author from a multi-language group Retrieve a batch of Blog Posts Delete a batch of Blog Authors Retrieve a batch of Blog Authors Get all Blog Posts Create a new Blog Post Clone a Blog Post Update languages of multi-language group Set a new primary language Delete a batch of Blog Posts Create a new language variation Attach a Blog Post to a multi-language group Set a new primary language Retrieves all the previous versions of a blog post

HubDb API-Tables

Export a draft table Return all draft tables Reset a draft table Export a published version of a table Clone a table Import data into draft table Get details of a published table Archive a table Get all published tables Create a new table Unpublish a table Get details for a draft table Update an existing table Publish a table from draft

Get rows from draft table Get a table row Clone a row Get a row from the draft table Replaces an existing row Permanently deletes a row Updates an existing row Get rows for a table Add a new row to a table

HubDb API-Rows Batch

Replace rows in batch in draft table Permanently deletes rows Get a set of rows Create rows in batch Get a set of rows from draft table Clone rows in batch Update rows in batch in draft table

Pages API-Site Pages

Retrieves a previous version of a Site Page Update a batch of Site Pages Restore a previous version of a Site Page Schedule a Site Page to be Published Attach a site page to a multi-language group Detach a site page from a multi-language group Retrieves all the previous versions of a Site Page Restore a previous version of a Site Page, to the draft version of the Site Page End an active A/B test Retrieve the full draft version of the Site Page Update a Site Page draft Retrieve a batch of Site Pages Get all Site Pages Create a new Site Page Create a new language variation Create a new A/B test variation Update languages of multi-language group Create a batch of Site Pages Delete a batch of Site Pages Clone a Site Page Set a new primary language Push Site Page draft edits live Rerun a previous A/B test Reset the Site Page draft to the live version Retrieve a Site Page Delete a Site Page Update a Site Page

Pages API-Landing Pages

Retrieves all the previous versions of a Landing Page Retrieves all the previous versions of a Folder Get all Landing Page Folders Create a new Folder Create a batch of Folders Retrieve the full draft version of the Landing Page Update a Landing Page draft Get all Landing Pages Create a new Landing Page Create a batch of Landing Pages Update a batch of Landing Pages Retrieve a batch of Landing Pages Clone a Landing Page Restore a previous version of a Folder Set a new primary language Restore a previous version of a Landing Page Retrieve a Folder Delete a Folder Update a Folder Create a new A/B test variation Attach a landing page to a multi-language group Retrieves a previous version of a Landing Page End an active A/B test Push Landing Page draft edits live Detach a landing page from a multi-language group Schedule a Landing Page to be Published Update languages of multi-language group Rerun a previous A/B test Delete a batch of Folders Update a batch of Folders Retrieves a previous version of a Folder Reset the Landing Page draft to the live version Retrieve a Landing Page Delete a Landing Page Update a Landing Page Create a new language variation Delete a batch of Landing Pages Restore a previous version of a Landing Page, to the draft version of the Landing Page Retrieve a batch of Folders

Blog Authors API-Blog Authors

Retrieve a Blog Author Delete a Blog Author Update a Blog Author Detach a Blog Author from a multi-language group Update a batch of Blog Authors Set a new primary language Delete a batch of Blog Authors Create a batch of Blog Authors Retrieve a batch of Blog Authors Get all Blog Authors Create a new Blog Author Create a new language variation Attach a Blog Author to a multi-language group Update languages of multi-language group

Blog Authors API

Schedule a Blog Post to be Published Create a batch of Blog Tags Delete a batch of Blog Tags Update languages of multi-language group Create a batch of Blog Posts Update a batch of Blog Posts Retrieve the full draft version of the Blog Post Update a Blog Post draft Retrieves a previous version of a blog post Restore a previous version of a blog post, to the draft version of the blog post Create a new language variation Restore a previous version of a blog post Detach a Blog Post from a multi-language group Push Blog Post draft edits live Reset the Blog Post draft to the live version Retrieve a batch of Blog Tags Retrieve a Blog Tag Delete a Blog Tag Update a Blog Tag Retrieve a Blog Post Delete a Blog Post Update a Blog Post Retrieve a batch of Blog Posts Get all Blog Posts Create a new Blog Post Clone a Blog Post Update a batch of Blog Tags Update languages of multi-language group Detach a Blog Tag from a multi-language group Set a new primary language Delete a batch of Blog Posts Get all Blog Tags Create a new Blog Tag Attach a Blog Post to a multi-language group Attach a Blog Tag to a multi-language group Set a new primary language Retrieves all the previous versions of a blog post Create a new language variation

CMS Source Code API-Content

Download a file Create or update a file Create a file Delete a file

CMS Source Code API-Metadata

Get the metadata for a file

CMS Source Code API-Validation

Validate the contents of a file

CMS Source Code API-Extract

Extracts a zip file

CMS Source Code API-Source_Code_Extract

post-/cms/v3/source-code/extract/async do Async get-/cms/v3/source-code/extract/async/tasks/{task Id}/status get Async Status

CRM API Collections

Associations V3 API-Batch

Create a batch of associations Read a batch of associations Archive a batch of associations

Associations V3 Schema API-Types

List association types

Associations V4 API-Batch

Delete Specific Labels Read Create Delete Create Default Associations

Associations V4 API-Basic

Create Delete Create Default List

Associations V4 Schema API-Definitions

Read Update Create Delete

Flexible Associations V4 API-Batch

Delete Specific Labels Read Create Delete Create Default Associations

Flexible Associations V4 API-Associations

Create Delete Create Default List

Carts API-Batch

Read a batch of carts by internal ID, or unique property values Archive a batch of carts by ID Create a batch of carts Update a batch of carts

Carts API-Basic

Read Archive Update List Create

Carts API-Search

post-/crm/v3/objects/carts/search

Commerce Payments API-Batch

Read a batch of commerce payments by internal ID, or unique property values Archive a batch of commerce payments by ID Create a batch of commerce payments Update a batch of commerce payments

Commerce Payments API-Basic

Read Archive Update List Create

Commerce Payments API-Search

post-/crm/v3/objects/commerce payments/search

Commerce Subscriptions API-Batch

Read a batch of subscriptions by internal ID, or unique property values

Commerce Subscriptions API-Basic

Commerce Subscriptions API-Search

post-/crm/v3/objects/subscriptions/search

Companies API-Batch

Read a batch of companies by internal ID, or unique property values Create a batch of companies Update a batch of companies by internal ID, or unique property values Archive a batch of companies by ID

Companies API-Basic

List Create Read Archive Update

Companies API-Search

post-/crm/v3/objects/companies/search do Search

Contacts API-Batch

Archive a batch of contacts by ID Update a batch of contacts by internal ID, or unique property values Create a batch of contacts Read a batch of contacts by internal ID, or unique property values

Contacts API-Basic

List Create Read Archive Update

Contacts API-Search

post-/crm/v3/objects/contacts/search do Search

CRM Cards API-Cards

Get all cards Create a new card Get a card.Delete a card Update a card

CRM Cards API-SampleResponse

Get sample card detail response

Custom Objects API-Batch

Read a batch of objects by internal ID, or unique property values Archive a batch of objects by ID Create a batch of objects Update a batch of objects

Custom Objects API-Basic

Read Archive Update List Create

Custom Objects API-Search

post-/crm/v3/objects/{object Type}/search

Deals API-Batch

Update a batch of deals by internal ID, or unique property values Archive a batch of deals by ID Create a batch of deals Read a batch of deals by internal ID, or unique property values

Deals API-Basic

List Create Read Archive Update

Deals API-Search

post-/crm/v3/objects/deals/search do Search

Deal Splits API-Batch

Create or replace deal splits for deals with the provided IDs. Deal split percentages for each deal must sum up to 1.0 (100%) and may have up to 8 decimal places Read a batch of deal split objects by their associated deal object internal ID Read a batch of deal split objects by their associated deal object internal ID

Discounts API-Batch

Update a batch of discounts Create a batch of discounts Archive a batch of discounts by ID Read a batch of discounts by internal ID, or unique property values Create a batch of discounts Read a batch of discounts by internal ID, or unique property values Archive a batch of discounts by ID

Discounts API-Basic

Read Archive Update List Create Update Create Archive List

Discounts API-Search

post-/crm/v3/objects/discounts/search

Exports API-Public_Exports

get-/crm/v3/exports/export/async/tasks/{task Id}/status

Exports API-Core

Start an export

Feedback Submissions API-Batch

Update a batch of feedback submissions by internal ID, or unique property values

Feedback Submissions API-Batch

Update a batch of feedback submissions by internal ID, or unique property values Create a batch of feedback submissions Archive a batch of feedback submissions by ID Read a batch of feedback submissions by internal ID, or unique property values Create a batch of feedback submissions Archive a batch of feedback submissions by ID Read a batch of feedback submissions by internal ID, or unique property values

Feedback Submissions API-Basic

Read Archive Update List Create Archive Update List Create

Feedback Submissions API-Search

post-/crm/v3/objects/feedback submissions/search do Search

Create a batch of fees Update a batch of fees Archive a batch of fees by ID Read a batch of fees by internal ID, or unique property values Update a batch of fees Create a batch of fees Archive a batch of fees by ID

Read Archive Update List Create Archive List Update

Fees API-Public_Object

Merge two fees with same type

Fees API-Search

post-/crm/v3/objects/fees/search

Goals API-Batch

Read a batch of goal targets by internal ID, or unique property values

Goals API-Basic

Read List Read List

Goals API-Search

post-/crm/v3/objects/goal targets/search do Search post-/crm/v3/objects/goal targets/search do Search

Imports API-Core

Get the information on any import

Imports API-Core

Get the information on any import Cancel an active import Get active imports Start a new import Get active imports Start a new import Cancel an active import

Imports API-Public_Imports

get-/crm/v3/imports/{import Id}/errors get Errors

Leads API-Batch

Read a batch of leads by internal ID, or unique property values Archive a batch of leads by ID Create a batch of leads Update a batch of leads Create a batch of leads Read a batch of leads by internal ID, or unique property values Update a batch of leads Archive a batch of leads by ID

Leads API-Basic

Leads API-Basic

Read Archive Update List Create Archive Update Create List

Leads API-Search

post-/crm/v3/objects/leads/search post-/crm/v3/objects/leads/search

Line Items API-Batch

Create a batch of line items

Line Items API-Batch

Create a batch of line items Update a batch of line items by internal ID, or unique property values Archive a batch of line items by ID Read a batch of line items by internal ID, or unique property values Read a batch of line items by internal ID, or unique property values Update a batch of line items by internal ID, or unique property values

Line Items API-Basic

Line Items API-Basic

List Create Read Archive Update Create Read Update

Line Items API-Search

post-/crm/v3/objects/line items/search do Search

Lists API-Memberships

Add and/or Remove Records from a List Add Records to a List Add All Records from a Source List to a Destination List Fetch List Memberships Ordered by ID Delete All Records from a List Remove Records from a List Remove Records from a List Add All Records from a Source List to a Destination List Add Records to a List

Lists API-Lists

Update List Name

Update List Name Fetch List by ID Delete a List Update List Filter Definition Fetch List by Name Fetch Multiple Lists Create List Restore a List Moves a list to a given folder Moves a folder Rename a folder Get lists record is member of Retrieves a folder.Creates a folder Deletes a folder Translate Legacy List Id to Modern List Id Translate Legacy List Id to Modern List Id in Batch Fetch List Memberships Ordered by Added to List Date Delete a List Update List Filter Definition Rename a folder Retrieves a folder.Fetch List by ID Create List Translate Legacy List Id to Modern List Id in Batch Fetch Multiple Lists Deletes a folder Get lists record is member of Restore a List Fetch List Memberships Ordered by Added to List Date Translate Legacy List Id to Modern List Id Fetch List by Name Moves a list to a given folder

Objects API-Batch

Read a batch of objects by internal ID, or unique property values

Objects API-Batch

Read a batch of objects by internal ID, or unique property values Archive a batch of objects by ID Create a batch of objects Update a batch of objects by internal ID, or unique property values Archive a batch of objects by ID Update a batch of objects by internal ID, or unique property values Create a batch of objects

Objects API-Basic

Read Archive Update List Create List Create Update Archive

Objects API-Public_Object

Merge two objects with same type

Objects API-Search

post-/crm/v3/objects/{object Type}/search do Search

Orders API-Batch

Read a batch of orders by internal ID, or unique property values

Orders API-Batch

Read a batch of orders by internal ID, or unique property values Archive a batch of orders by ID Create a batch of orders Update a batch of orders Update a batch of orders Create a batch of orders Archive a batch of orders by ID

Orders API-Basic

Orders API-Basic

Read Archive Update List Create Update List Create Archive

Orders API-Search

post-/crm/v3/objects/orders/search

Owners API-Owners

Get a page of owners Read an owner by given `id` or `userId`Get a page of owners Read an owner by given `id` or `userId`

Payments API-Batch

Read a batch of payments by internal ID, or unique property values

Payments API-Basic

Payments API-Basic

Payments API-Search

post-/crm/v3/objects/payments/search

Pipelines API-Pipelines

Return a pipeline by ID Replace a pipeline Delete a pipeline Update a pipeline Retrieve all pipelines Create a pipeline Create a pipeline Replace a pipeline Retrieve all pipelines Delete a pipeline Update a pipeline

Pipelines API-Pipeline Audits

Return an audit of all changes to the pipeline

Pipelines API-Pipeline Stages

Return all stages of a pipeline

Pipelines API-Pipeline Stages

Return all stages of a pipeline Create a pipeline stage Return a pipeline stage by ID Replace a pipeline stage Delete a pipeline stage Update a pipeline stage Delete a pipeline stage Return a pipeline stage by ID Create a pipeline stage Replace a pipeline stage

Return an audit of all changes to the pipeline stage

Products API-Batch

Archive a batch of products by ID Read a batch of products by internal ID, or unique property values Create a batch of products Update a batch of products by internal ID, or unique property values Update a batch of products by internal ID, or unique property values Read a batch of products by internal ID, or unique property values Archive a batch of products by ID

Products API-Basic

List Create Read Archive Update Update

Products API-Search

post-/crm/v3/objects/products/search do Search

Quotes API-Batch

Archive a batch of quotes by ID

Quotes API-Batch

Archive a batch of quotes by ID Update a batch of quotes by internal ID, or unique property values Create a batch of quotes Read a batch of quotes by internal ID, or unique property values Read a batch of quotes by internal ID, or unique property values Update a batch of quotes by internal ID, or unique property values Create a batch of quotes

Quotes API-Basic

List Create Read Archive Update Create List Update Read Archive

Quotes API-Search

post-/crm/v3/objects/quotes/search do Search

Taxes API-Batch

Update a batch of taxes

Taxes API-Batch

Update a batch of taxes Create a batch of taxes Read a batch of taxes by internal ID, or unique property values Archive a batch of taxes by ID Archive a batch of taxes by ID Read a batch of taxes by internal ID, or unique property values Create a batch of taxes

Taxes API-Basic

List Create Read Archive Update List Update Read Create

Taxes API-Public_Object

Merge two taxes with same type

Taxes API-Search

post-/crm/v3/objects/taxes/search

Tickets API-Batch

Archive a batch of tickets by ID Read a batch of tickets by internal ID, or unique property values Create a batch of tickets Update a batch of tickets by internal ID, or unique property values Read a batch of tickets by internal ID, or unique property values Create a batch of tickets Update a batch of tickets by internal ID, or unique property values

Tickets API-Basic

Read Archive Update List Create Archive

Tickets API-Search

post-/crm/v3/objects/tickets/search do Search

Invoices API-Batch

Read a batch of invoices by internal ID, or unique property values

Invoices API-Basic

Invoices API-Search

post-/crm/v3/objects/invoices/search

Discounts API-Search

post-/crm/v3/objects/discounts/search

Line Items API-Search

post-/crm/v3/objects/line items/search do Search

Discounts API-Basic

Objects API-Public_Object

Merge two objects with same type

Objects API-Basic

Payments API-Batch

Read a batch of payments by internal ID, or unique property values

Objects API-Search

post-/crm/v3/objects/{object Type}/search do Search

Imports API-Public_Imports

get-/crm/v3/imports/{import Id}/errors get Errors

Lists API-Memberships

Add and/or Remove Records from a List

Tickets API-Basic

Feedback Submissions API-Search

post-/crm/v3/objects/feedback submissions/search do Search

Taxes API-Public_Object

Merge two taxes with same type

Pipelines API-Pipelines

Return a pipeline by ID

Pipelines API-Pipeline Audits

Return an audit of all changes to the pipeline

Lists API-Lists

Tickets API-Batch

Archive a batch of tickets by ID

Taxes API-Search

post-/crm/v3/objects/taxes/search

Payments API-Search

post-/crm/v3/objects/payments/search

Orders API-Search

post-/crm/v3/objects/orders/search

Discounts API-Batch

Update a batch of discounts

Goals API-Batch

Read a batch of goal targets by internal ID, or unique property values

Return an audit of all changes to the pipeline stage

Feedback Submissions API-Basic

Products API-Search

post-/crm/v3/objects/products/search do Search

Quotes API-Search

post-/crm/v3/objects/quotes/search do Search

Conversations API Collections

Conversations Inbox & Messages API-Conversations

Get conversations inboxes.Get a single thread.Archives a thread.Update a thread.Get the original content of a single message.Get message history for a thread.Send a message to a thread.Get actors Get channel accounts.Get a single channel.Get a single message.Get channels.Get a single actor.Get threads.Get a single channel account.Get a single conversations inbox.Get the original content of a single message.Get actors Archives a thread.Get a single message.Update a thread.Get a single channel.Get channels.Get a single conversations inbox.Get threads.Send a message to a thread.Get a single channel account.Get channel accounts.Get message history for a thread.Get a single thread.

Conversations Visitor Identification API

Generate a token

Conversations Visitor Identification API

Generate a token

Engagements API Collections

Calls API-Batch

Create a batch of calls Read a batch of calls by internal ID, or unique property values Update a batch of calls by internal ID, or unique property values Archive a batch of calls by ID Update a batch of calls by internal ID, or unique property values Archive a batch of calls by ID

Calls API-Basic

List Create Read Archive Update Archive Read Create Update

Calls API-Search

post-/crm/v3/objects/calls/search do Search post-/crm/v3/objects/calls/search do Search

Email API-Batch

Create a batch of emails

Email API-Batch

Create a batch of emails Read a batch of emails by internal ID, or unique property values Archive a batch of emails by ID Update a batch of emails by internal ID, or unique property values Read a batch of emails by internal ID, or unique property values Archive a batch of emails by ID Update a batch of emails by internal ID, or unique property values

Email API-Basic

List Create Read Archive Update List Create Update Read Archive

Email API-Search

post-/crm/v3/objects/emails/search do Search post-/crm/v3/objects/emails/search do Search

Meetings API-Batch

Update a batch of meetings by internal ID, or unique property values Archive a batch of meetings by ID Read a batch of meetings by internal ID, or unique property values Create a batch of meetings Read a batch of meetings by internal ID, or unique property values Archive a batch of meetings by ID Create a batch of meetings

Meetings API-Basic

Meetings API-Basic

Read Archive Update List Create Archive List Update

Meetings API-Search

post-/crm/v3/objects/meetings/search do Search

Notes API-Batch

Read a batch of notes by internal ID, or unique property values Archive a batch of notes by ID Update a batch of notes by internal ID, or unique property values Create a batch of notes Update a batch of notes by internal ID, or unique property values Create a batch of notes

Notes API-Basic

Notes API-Basic

List Create Read Archive Update Update Archive Read Create

Notes API-Search

post-/crm/v3/objects/notes/search do Search post-/crm/v3/objects/notes/search do Search

Postal Mail API-Batch

Read a batch of postal mail by internal ID, or unique property values

Postal Mail API-Batch

Read a batch of postal mail by internal ID, or unique property values Archive a batch of postal mail by ID Create a batch of postal mail Update a batch of postal mail by internal ID, or unique property values Create a batch of postal mail Update a batch of postal mail by internal ID, or unique property values Archive a batch of postal mail by ID

Postal Mail API-Basic

Postal Mail API-Basic

List Create Read Archive Update Create

Postal Mail API-Search

post-/crm/v3/objects/postal mail/search do Search

Tasks API-Batch

Archive a batch of tasks by ID Create a batch of tasks Update a batch of tasks by internal ID, or unique property values Read a batch of tasks by internal ID, or unique property values Update a batch of tasks by internal ID, or unique property values Read a batch of tasks by internal ID, or unique property values

Tasks API-Basic

Read Archive Update List Create Archive Update

Tasks API-Search

post-/crm/v3/objects/tasks/search do Search

Communications API-Batch

Update a batch of communications by internal ID, or unique property values Archive a batch of communications by ID Create a batch of communications Read a batch of communications by internal ID, or unique property values Read a batch of communications by internal ID, or unique property values Create a batch of communications

Communications API-Basic

List Create Read Archive Update List Read Create Archive

Communications API-Search

post-/crm/v3/objects/communications/search do Search

Meetings API-Batch

Update a batch of meetings by internal ID, or unique property values

Tasks API-Basic

Calls API-Basic

Events API Collections

Custom Behavioral Events API-Custom Behavioral Events API

Send custom event completion

Custom Behavioral Events API

Query Custom Behavioral Event Definitions Create Custom Behavioral Event Definition Fetch Single Custom Behavioral Event Definition delete-/events/v3/event-definitions/{event Name}Modify Single Custom Behavioral Event Definition Create Property for Custom Behavioral Event Definition delete-/events/v3/event-definitions/{event Name}/property/{property Name}Modify Property for Custom Behavioral Event Definition Fetch Single Custom Behavioral Event Definition Query Custom Behavioral Event Definitions delete-/events/v3/event-definitions/{event Name}Create Custom Behavioral Event Definition delete-/events/v3/event-definitions/{event Name}/property/{property Name}Modify Single Custom Behavioral Event Definition Modify Property for Custom Behavioral Event Definition

Custom Event Definitions API-Event definition

Query custom event definitions Create custom event definition Fetch a specific custom event definition delete-/events/v3/event-definitions/{event Name}Update a custom event definition Create a new property for a custom event definition.Delete a property from a custom event definition Update an existing custom event property Fetch a specific custom event definition Update an existing custom event property Create a new property for a custom event definition.Create custom event definition Update a custom event definition Delete a property from a custom event definition delete-/events/v3/event-definitions/{event Name}

Custom Event Definitions API-Event tracking

Send custom event completion data

Custom Event Definitions API-Event tracking

Send custom event completion data

Custom Event Definitions API-Event definition

Query custom event definitions

Custom Behavioral Events API-Custom Behavioral Events API

Send custom event completion

Extend CRM API Collections

Callings Extensions API-Recording_Settings

get-/crm/v3/extensions/calling/{app Id}/settings/recording get Url Format post-/crm/v3/extensions/calling/{app Id}/settings/recording register Url Format patch-/crm/v3/extensions/calling/{app Id}/settings/recording update Url Format post-/crm/v3/extensions/calling/{app Id}/settings/recording register Url Format patch-/crm/v3/extensions/calling/{app Id}/settings/recording update Url Format get-/crm/v3/extensions/calling/{app Id}/settings/recording get Url Format

Callings Extensions API-Settings

Get calling settings Configure a calling extension Delete calling settings Update settings Update settings Configure a calling extension Delete calling settings

Video Conference Ext API-Settings

Video Conference Ext API-Settings

Get settings Update settings Delete settings Update settings Delete settings

Callings Extensions API-Settings

Get calling settings

GraphQL Collector Collection

Execute a GraphQL operation

Marketing API Collections

Transactional Email API-Public_Smtp_Tokens

Query a single token by ID.Delete a single token by ID.Query SMTP API tokens by campaign name or an emailCampaignId.Create a SMTP API token.Reset the password of an existing token.Query SMTP API tokens by campaign name or an emailCampaignId.Reset the password of an existing token.Create a SMTP API token.

Transactional Email API-Single_Send

Send a single transactional email asynchronously.Send a single transactional email asynchronously.

Subscription Preferences API-Status

Subscribe a contact Unsubscribe a contact Get subscription statuses for a contact Get subscription statuses for a contact Subscribe a contact Unsubscribe a contact

Subscription Preferences API-Definition

Get subscription definitions Get subscription definitions

Marketing Emails API-Statistics

Get aggregated statistics.Get aggregated statistic intervals.Get aggregated statistic intervals.

Marketing Emails API-Marketing Emails

Get the variation of a an A/B marketing email Reset Draft Restore a revision of a marketing email to DRAFT state Get draft version of a marketing email Create or update draft version Get revisions of a marketing email Get a revision of a marketing email.Get all marketing emails for a HubSpot account.Create a new marketing email.Restore a revision of a marketing email Get the details of a specified marketing email.Delete a marketing email.Update a marketing email.Create or update draft version Get revisions of a marketing email Delete a marketing email.Restore a revision of a marketing email Create a new marketing email.Restore a revision of a marketing email to DRAFT state Get a revision of a marketing email.Get all marketing emails for a HubSpot account.Get the details of a specified marketing email.Update a marketing email.Reset Draft Get draft version of a marketing email

Marketing Emails API

Publish or send a marketing email.Create an A/B test variation of a marketing email.Unpublish or cancel a marketing email.Clone a marketing email.Clone a marketing email.Create an A/B test variation of a marketing email.Unpublish or cancel a marketing email.Publish or send a marketing email.

Marketing Events API-Batch

Create or update multiple marketing events Delete multiple marketing events Delete multiple marketing events Create or update multiple marketing events

Marketing Events API-Attendance Subscriber State Changes

Record a subscriber state by contact ids Record a subscriber state by contact email Record a subscriber state by contact email

Marketing Events API-Subscriber State Changes

Record a subscriber state by contact email

Marketing Events API-Subscriber State Changes

Record a subscriber state by contact email Record a subscriber state by contact id Record a subscriber state by contact id

Marketing Events API-Marketing_Events_External

Mark a marketing event as completed

Marketing Events API-Basic

Create a marketing event Mark a marketing event as cancelled Get a marketing event Create or update a marketing event Delete a marketing event Update a marketing event Delete a marketing event Create or update a marketing event Mark a marketing event as cancelled Update a marketing event Get a marketing event

Marketing Events API-Settings

Retrieve the application settings Update the application settings Update the application settings Retrieve the application settings

Marketing Events API-Search

Search for marketing events

Marketing Events API

Read participations breakdown by Marketing Event internal identifier

Marketing Events API

Read participations breakdown by Marketing Event internal identifier Read participations counters by Marketing Event external identifier Read participations counters by Marketing Event internal identifier Read participations breakdown by Marketing Event external identifier Read participations breakdown by Contact identifier Read participations counters by Marketing Event internal identifier Read participations breakdown by Contact identifier Read participations counters by Marketing Event external identifier Read participations breakdown by Marketing Event external identifier

Single-Send API-Single_Send

post-/marketing/v4/email/single-send post-/marketing/v4/email/single-send

Marketing Events API-Marketing_Events_External

Mark a marketing event as completed

Marketing Events API-Attendance Subscriber State Changes

Record a subscriber state by contact ids

Marketing Emails API-Statistics

Get aggregated statistics.

Marketing Events API-Basic

Create a marketing event

Marketing Events API-Search

Search for marketing events

Marketing Emails API-Marketing Emails

Get the variation of a an A/B marketing email

Settings API Collections

Business Unit API-Business Unit

Get Business Units for a user

User Provisioning API-Teams

See details about this account's teams

User Provisioning API-Roles

Retrieves the roles on an account

User Provisioning API-Users

Retrieves a list of users from an account Adds a user Retrieves a user Modifies a user Removes a user Removes a user Modifies a user Adds a user Retrieves a user

Users API-Batch

Read a batch of users by internal ID, or unique property values Read a batch of users by internal ID, or unique property values

Users API-Basic

Read List List Read

Users API-Search

post-/crm/v3/objects/users/search

Currencies API-Currency

get-/settings/v3/currencies/exchange-rates

Currencies API-Currency

get-/settings/v3/currencies/exchange-rates post-/settings/v3/currencies/exchange-rates get-/settings/v3/currencies/codes get-/settings/v3/currencies/company-currency put-/settings/v3/currencies/company-currency post-/settings/v3/currencies/exchange-rates/batch/update get-/settings/v3/currencies/exchange-rates/current post-/settings/v3/currencies/exchange-rates/update-visibility get-/settings/v3/currencies/exchange-rates/{exchange Rate Id}patch-/settings/v3/currencies/exchange-rates/{exchange Rate Id}post-/settings/v3/currencies/exchange-rates/batch/create post-/settings/v3/currencies/exchange-rates/batch/read post-/settings/v3/currencies/exchange-rates/update-visibility post-/settings/v3/currencies/exchange-rates/batch/update post-/settings/v3/currencies/exchange-rates/batch/read post-/settings/v3/currencies/exchange-rates/batch/create patch-/settings/v3/currencies/exchange-rates/{exchange Rate Id}put-/settings/v3/currencies/company-currency get-/settings/v3/currencies/exchange-rates/current get-/settings/v3/currencies/company-currency post-/settings/v3/currencies/exchange-rates get-/settings/v3/currencies/codes

Users API-Search

post-/crm/v3/objects/users/search

User Provisioning API-Roles

Retrieves the roles on an account

User Provisioning API-Teams

See details about this account's teams

User Provisioning API-Users

Retrieves a list of users from an account

Webhooks API Collections

Webhooks API-Settings

get-/webhooks/v3/{app Id}/settings get All

Webhooks API-Settings

get-/webhooks/v3/{app Id}/settings get All put-/webhooks/v3/{app Id}/settings configure delete-/webhooks/v3/{app Id}/settings clear delete-/webhooks/v3/{app Id}/settings clear put-/webhooks/v3/{app Id}/settings configure

Webhooks API-Subscriptions

get-/webhooks/v3/{app Id}/subscriptions/{subscription Id} get By Id

Webhooks API-Subscriptions

get-/webhooks/v3/{app Id}/subscriptions/{subscription Id} get By Id delete-/webhooks/v3/{app Id}/subscriptions/{subscription Id} archive patch-/webhooks/v3/{app Id}/subscriptions/{subscription Id} update get-/webhooks/v3/{app Id}/subscriptions get All post-/webhooks/v3/{app Id}/subscriptions create post-/webhooks/v3/{app Id}/subscriptions/batch/update update Batch get-/webhooks/v3/{app Id}/subscriptions get All patch-/webhooks/v3/{app Id}/subscriptions/{subscription Id} update post-/webhooks/v3/{app Id}/subscriptions create delete-/webhooks/v3/{app Id}/subscriptions/{subscription Id} archive post-/webhooks/v3/{app Id}/subscriptions/batch/update update Batch

GraphQL Collector Collection

Execute a GraphQL operation

Account API Collections

Account Info API-Usage

Get the daily API usage of Private Apps and limits for a HubSpot account.

Account Info API-Details

Get account details for a HubSpot account.

Account Activity API-Activity

Get login activity for a HubSpot account.get-/account-info/v3/activity/audit-logs Get security activity for a HubSpot account

Auth - OAuth Collection

oauth-v1-access-tokens-{token}

get-/oauth/v1/access-tokens/{token} get

oauth-v1-refresh-tokens-{token}

get-/oauth/v1/refresh-tokens/{token} get delete-/oauth/v1/refresh-tokens/{token} archive

post-/oauth/v1/token create

Automation API Collections

Custom Workflow Actions API-Callbacks

Completes a single callback Completes a batch of callbacks

Custom Workflow Actions API-Definitions

Get paged extension definitions Create a new extension definition Get extension definition by Id Archive an extension definition Patch an existing extension definition

Custom Workflow Actions API-Functions

Get all functions for a given definition Get all functions by a type for a given definition Insert a function for a definition Delete a function for a definition Get a function for a given definition Insert a function for a definition Archive a function for a definition

Custom Workflow Actions API-Revisions

Gets a revision for a given definition by revision id Get all revisions for a given definition

CMS API Collections

Schedule a Blog Post to be Published Retrieve a batch of Blog Posts Update languages of multi-language group Retrieves a previous version of a blog post Update a batch of Blog Posts Retrieve the full draft version of the Blog Post Update a Blog Post draft Create a batch of Blog Posts Restore a previous version of a blog post, to the draft version of the blog post Create a new language variation Clone a Blog Post Get all Blog Posts Create a new Blog Post Restore a previous version of a blog post Detach a Blog Post from a multi-language group Push Blog Post draft edits live Delete a batch of Blog Posts Reset the Blog Post draft to the live version Attach a Blog Post to a multi-language group Retrieves all the previous versions of a blog post Set a new primary language Retrieve a Blog Post Delete a Blog Post Update a Blog Post

Blog Settings API

Update languages of multi-language group Retrieves all the previous versions of a Blog Retrieves a previous version of a Blog Retrieve a Blog Create a new language variation Get all Blogs Set a new primary language Detach a blog from a multi-language group Attach a blog to a multi-language group

Blog Tags API-Blog Tags

Update a batch of Blog Tags Update languages of multi-language group Detach a Blog Tag from a multi-language group Create a batch of Blog Tags Delete a batch of Blog Tags Set a new primary language Retrieve a batch of Blog Tags Get all Blog Tags Create a new Blog Tag Attach a Blog Tag to a multi-language group Retrieve a Blog Tag Delete a Blog Tag Update a Blog Tag Create a new language variation

Update a batch of Blog Authors Schedule a Blog Post to be Published Update languages of multi-language group Create a batch of Blog Posts Update a batch of Blog Posts Retrieve the full draft version of the Blog Post Update a Blog Post draft Retrieves a previous version of a blog post Restore a previous version of a blog post, to the draft version of the blog post Attach a Blog Author to a multi-language group Create a new language variation Restore a previous version of a blog post Detach a Blog Post from a multi-language group Create a batch of Blog Authors Push Blog Post draft edits live Get all Blog Authors Create a new Blog Author Reset the Blog Post draft to the live version Retrieve a Blog Post Delete a Blog Post Update a Blog Post Retrieve a Blog Author Delete a Blog Author Update a Blog Author Detach a Blog Author from a multi-language group Retrieve a batch of Blog Posts Delete a batch of Blog Authors Retrieve a batch of Blog Authors Get all Blog Posts Create a new Blog Post Clone a Blog Post Update languages of multi-language group Set a new primary language Delete a batch of Blog Posts Create a new language variation Attach a Blog Post to a multi-language group Set a new primary language Retrieves all the previous versions of a blog post

HubDb API-Tables

Export a draft table Return all draft tables Reset a draft table Export a published version of a table Clone a table Import data into draft table Get details of a published table Archive a table Get all published tables Create a new table Unpublish a table Get details for a draft table Update an existing table Publish a table from draft

Get rows from draft table Get a table row Clone a row Get a row from the draft table Replaces an existing row Permanently deletes a row Updates an existing row Get rows for a table Add a new row to a table

HubDb API-Rows Batch

Replace rows in batch in draft table Permanently deletes rows Get a set of rows Create rows in batch Get a set of rows from draft table Clone rows in batch Update rows in batch in draft table

Pages API-Site Pages

Retrieves a previous version of a Site Page Update a batch of Site Pages Restore a previous version of a Site Page Schedule a Site Page to be Published Attach a site page to a multi-language group Detach a site page from a multi-language group Retrieves all the previous versions of a Site Page Restore a previous version of a Site Page, to the draft version of the Site Page End an active A/B test Retrieve the full draft version of the Site Page Update a Site Page draft Retrieve a batch of Site Pages Get all Site Pages Create a new Site Page Create a new language variation Create a new A/B test variation Update languages of multi-language group Create a batch of Site Pages Delete a batch of Site Pages Clone a Site Page Set a new primary language Push Site Page draft edits live Rerun a previous A/B test Reset the Site Page draft to the live version Retrieve a Site Page Delete a Site Page Update a Site Page

Pages API-Landing Pages

Retrieves all the previous versions of a Landing Page Retrieves all the previous versions of a Folder Get all Landing Page Folders Create a new Folder Create a batch of Folders Retrieve the full draft version of the Landing Page Update a Landing Page draft Get all Landing Pages Create a new Landing Page Create a batch of Landing Pages Update a batch of Landing Pages Retrieve a batch of Landing Pages Clone a Landing Page Restore a previous version of a Folder Set a new primary language Restore a previous version of a Landing Page Retrieve a Folder Delete a Folder Update a Folder Create a new A/B test variation Attach a landing page to a multi-language group Retrieves a previous version of a Landing Page End an active A/B test Push Landing Page draft edits live Detach a landing page from a multi-language group Schedule a Landing Page to be Published Update languages of multi-language group Rerun a previous A/B test Delete a batch of Folders Update a batch of Folders Retrieves a previous version of a Folder Reset the Landing Page draft to the live version Retrieve a Landing Page Delete a Landing Page Update a Landing Page Create a new language variation Delete a batch of Landing Pages Restore a previous version of a Landing Page, to the draft version of the Landing Page Retrieve a batch of Folders

Blog Authors API-Blog Authors

Retrieve a Blog Author Delete a Blog Author Update a Blog Author Detach a Blog Author from a multi-language group Update a batch of Blog Authors Set a new primary language Delete a batch of Blog Authors Create a batch of Blog Authors Retrieve a batch of Blog Authors Get all Blog Authors Create a new Blog Author Create a new language variation Attach a Blog Author to a multi-language group Update languages of multi-language group

Blog Authors API

Schedule a Blog Post to be Published Create a batch of Blog Tags Delete a batch of Blog Tags Update languages of multi-language group Create a batch of Blog Posts Update a batch of Blog Posts Retrieve the full draft version of the Blog Post Update a Blog Post draft Retrieves a previous version of a blog post Restore a previous version of a blog post, to the draft version of the blog post Create a new language variation Restore a previous version of a blog post Detach a Blog Post from a multi-language group Push Blog Post draft edits live Reset the Blog Post draft to the live version Retrieve a batch of Blog Tags Retrieve a Blog Tag Delete a Blog Tag Update a Blog Tag Retrieve a Blog Post Delete a Blog Post Update a Blog Post Retrieve a batch of Blog Posts Get all Blog Posts Create a new Blog Post Clone a Blog Post Update a batch of Blog Tags Update languages of multi-language group Detach a Blog Tag from a multi-language group Set a new primary language Delete a batch of Blog Posts Get all Blog Tags Create a new Blog Tag Attach a Blog Post to a multi-language group Attach a Blog Tag to a multi-language group Set a new primary language Retrieves all the previous versions of a blog post Create a new language variation

CMS Source Code API-Content

Download a file Create or update a file Create a file Delete a file

CMS Source Code API-Metadata

Get the metadata for a file

CMS Source Code API-Validation

Validate the contents of a file

CMS Source Code API-Extract

Extracts a zip file

CMS Source Code API-Source_Code_Extract

post-/cms/v3/source-code/extract/async do Async get-/cms/v3/source-code/extract/async/tasks/{task Id}/status get Async Status

CRM API Collections

Associations V3 API-Batch

Create a batch of associations Read a batch of associations Archive a batch of associations

Associations V3 Schema API-Types

List association types

Associations V4 API-Batch

Delete Specific Labels Read Create Delete Create Default Associations

Associations V4 API-Basic

Create Delete Create Default List

Associations V4 Schema API-Definitions

Read Update Create Delete

Flexible Associations V4 API-Batch

Delete Specific Labels Read Create Delete Create Default Associations

Flexible Associations V4 API-Associations

Create Delete Create Default List

Carts API-Batch

Read a batch of carts by internal ID, or unique property values Archive a batch of carts by ID Create a batch of carts Update a batch of carts

Carts API-Basic

Read Archive Update List Create

Carts API-Search

post-/crm/v3/objects/carts/search

Commerce Payments API-Batch

Read a batch of commerce payments by internal ID, or unique property values Archive a batch of commerce payments by ID Create a batch of commerce payments Update a batch of commerce payments

Commerce Payments API-Basic

Read Archive Update List Create

Commerce Payments API-Search

post-/crm/v3/objects/commerce payments/search

Commerce Subscriptions API-Batch

Read a batch of subscriptions by internal ID, or unique property values

Commerce Subscriptions API-Basic

Commerce Subscriptions API-Search

post-/crm/v3/objects/subscriptions/search

Companies API-Batch

Read a batch of companies by internal ID, or unique property values Create a batch of companies Update a batch of companies by internal ID, or unique property values Archive a batch of companies by ID

Companies API-Basic

List Create Read Archive Update

Companies API-Search

post-/crm/v3/objects/companies/search do Search

Contacts API-Batch

Archive a batch of contacts by ID Update a batch of contacts by internal ID, or unique property values Create a batch of contacts Read a batch of contacts by internal ID, or unique property values

Contacts API-Basic

List Create Read Archive Update

Contacts API-Search

post-/crm/v3/objects/contacts/search do Search

CRM Cards API-Cards

Get all cards Create a new card Get a card.Delete a card Update a card

CRM Cards API-SampleResponse

Get sample card detail response

Custom Objects API-Batch

Read a batch of objects by internal ID, or unique property values Archive a batch of objects by ID Create a batch of objects Update a batch of objects

Custom Objects API-Basic

Read Archive Update List Create

Custom Objects API-Search

post-/crm/v3/objects/{object Type}/search

Deals API-Batch

Update a batch of deals by internal ID, or unique property values Archive a batch of deals by ID Create a batch of deals Read a batch of deals by internal ID, or unique property values

Deals API-Basic

List Create Read Archive Update

Deals API-Search

post-/crm/v3/objects/deals/search do Search

Deal Splits API-Batch

Create or replace deal splits for deals with the provided IDs. Deal split percentages for each deal must sum up to 1.0 (100%) and may have up to 8 decimal places Read a batch of deal split objects by their associated deal object internal ID Read a batch of deal split objects by their associated deal object internal ID

Discounts API-Batch

Update a batch of discounts Create a batch of discounts Archive a batch of discounts by ID Read a batch of discounts by internal ID, or unique property values Create a batch of discounts Read a batch of discounts by internal ID, or unique property values Archive a batch of discounts by ID

Discounts API-Basic

Read Archive Update List Create Update Create Archive List

Discounts API-Search

post-/crm/v3/objects/discounts/search

Exports API-Public_Exports

get-/crm/v3/exports/export/async/tasks/{task Id}/status

Exports API-Core

Start an export

Feedback Submissions API-Batch

Update a batch of feedback submissions by internal ID, or unique property values

Feedback Submissions API-Batch

Update a batch of feedback submissions by internal ID, or unique property values Create a batch of feedback submissions Archive a batch of feedback submissions by ID Read a batch of feedback submissions by internal ID, or unique property values Create a batch of feedback submissions Archive a batch of feedback submissions by ID Read a batch of feedback submissions by internal ID, or unique property values

Feedback Submissions API-Basic

Read Archive Update List Create Archive Update List Create

Feedback Submissions API-Search

post-/crm/v3/objects/feedback submissions/search do Search

Create a batch of fees Update a batch of fees Archive a batch of fees by ID Read a batch of fees by internal ID, or unique property values Update a batch of fees Create a batch of fees Archive a batch of fees by ID

Read Archive Update List Create Archive List Update

Fees API-Public_Object

Merge two fees with same type

Fees API-Search

post-/crm/v3/objects/fees/search

Goals API-Batch

Read a batch of goal targets by internal ID, or unique property values

Goals API-Basic

Read List Read List

Goals API-Search

post-/crm/v3/objects/goal targets/search do Search post-/crm/v3/objects/goal targets/search do Search

Imports API-Core

Get the information on any import

Imports API-Core

Get the information on any import Cancel an active import Get active imports Start a new import Get active imports Start a new import Cancel an active import

Imports API-Public_Imports

get-/crm/v3/imports/{import Id}/errors get Errors

Leads API-Batch

Read a batch of leads by internal ID, or unique property values Archive a batch of leads by ID Create a batch of leads Update a batch of leads Create a batch of leads Read a batch of leads by internal ID, or unique property values Update a batch of leads Archive a batch of leads by ID

Leads API-Basic

Leads API-Basic

Read Archive Update List Create Archive Update Create List

Leads API-Search

post-/crm/v3/objects/leads/search post-/crm/v3/objects/leads/search

Line Items API-Batch

Create a batch of line items

Line Items API-Batch

Create a batch of line items Update a batch of line items by internal ID, or unique property values Archive a batch of line items by ID Read a batch of line items by internal ID, or unique property values Read a batch of line items by internal ID, or unique property values Update a batch of line items by internal ID, or unique property values

Line Items API-Basic

Line Items API-Basic

List Create Read Archive Update Create Read Update

Line Items API-Search

post-/crm/v3/objects/line items/search do Search

Lists API-Memberships

Add and/or Remove Records from a List Add Records to a List Add All Records from a Source List to a Destination List Fetch List Memberships Ordered by ID Delete All Records from a List Remove Records from a List Remove Records from a List Add All Records from a Source List to a Destination List Add Records to a List

Lists API-Lists

Update List Name

Update List Name Fetch List by ID Delete a List Update List Filter Definition Fetch List by Name Fetch Multiple Lists Create List Restore a List Moves a list to a given folder Moves a folder Rename a folder Get lists record is member of Retrieves a folder.Creates a folder Deletes a folder Translate Legacy List Id to Modern List Id Translate Legacy List Id to Modern List Id in Batch Fetch List Memberships Ordered by Added to List Date Delete a List Update List Filter Definition Rename a folder Retrieves a folder.Fetch List by ID Create List Translate Legacy List Id to Modern List Id in Batch Fetch Multiple Lists Deletes a folder Get lists record is member of Restore a List Fetch List Memberships Ordered by Added to List Date Translate Legacy List Id to Modern List Id Fetch List by Name Moves a list to a given folder

Objects API-Batch

Read a batch of objects by internal ID, or unique property values

Objects API-Batch

Read a batch of objects by internal ID, or unique property values Archive a batch of objects by ID Create a batch of objects Update a batch of objects by internal ID, or unique property values Archive a batch of objects by ID Update a batch of objects by internal ID, or unique property values Create a batch of objects

Objects API-Basic

Read Archive Update List Create List Create Update Archive

Objects API-Public_Object

Merge two objects with same type

Objects API-Search

post-/crm/v3/objects/{object Type}/search do Search

Orders API-Batch

Read a batch of orders by internal ID, or unique property values

Orders API-Batch

Read a batch of orders by internal ID, or unique property values Archive a batch of orders by ID Create a batch of orders Update a batch of orders Update a batch of orders Create a batch of orders Archive a batch of orders by ID

Orders API-Basic

Orders API-Basic

Read Archive Update List Create Update List Create Archive

Orders API-Search

post-/crm/v3/objects/orders/search

Owners API-Owners

Get a page of owners Read an owner by given `id` or `userId`Get a page of owners Read an owner by given `id` or `userId`

Payments API-Batch

Read a batch of payments by internal ID, or unique property values

Payments API-Basic

Payments API-Basic

Payments API-Search

post-/crm/v3/objects/payments/search

Pipelines API-Pipelines

Return a pipeline by ID Replace a pipeline Delete a pipeline Update a pipeline Retrieve all pipelines Create a pipeline Create a pipeline Replace a pipeline Retrieve all pipelines Delete a pipeline Update a pipeline

Pipelines API-Pipeline Audits

Return an audit of all changes to the pipeline

Pipelines API-Pipeline Stages

Return all stages of a pipeline

Pipelines API-Pipeline Stages

Return all stages of a pipeline Create a pipeline stage Return a pipeline stage by ID Replace a pipeline stage Delete a pipeline stage Update a pipeline stage Delete a pipeline stage Return a pipeline stage by ID Create a pipeline stage Replace a pipeline stage

Return an audit of all changes to the pipeline stage

Products API-Batch

Archive a batch of products by ID Read a batch of products by internal ID, or unique property values Create a batch of products Update a batch of products by internal ID, or unique property values Update a batch of products by internal ID, or unique property values Read a batch of products by internal ID, or unique property values Archive a batch of products by ID

Products API-Basic

List Create Read Archive Update Update

Products API-Search

post-/crm/v3/objects/products/search do Search

Quotes API-Batch

Archive a batch of quotes by ID

Quotes API-Batch

Archive a batch of quotes by ID Update a batch of quotes by internal ID, or unique property values Create a batch of quotes Read a batch of quotes by internal ID, or unique property values Read a batch of quotes by internal ID, or unique property values Update a batch of quotes by internal ID, or unique property values Create a batch of quotes

Quotes API-Basic

List Create Read Archive Update Create List Update Read Archive

Quotes API-Search

post-/crm/v3/objects/quotes/search do Search

Taxes API-Batch

Update a batch of taxes

Taxes API-Batch

Update a batch of taxes Create a batch of taxes Read a batch of taxes by internal ID, or unique property values Archive a batch of taxes by ID Archive a batch of taxes by ID Read a batch of taxes by internal ID, or unique property values Create a batch of taxes

Taxes API-Basic

List Create Read Archive Update List Update Read Create

Taxes API-Public_Object

Merge two taxes with same type

Taxes API-Search

post-/crm/v3/objects/taxes/search

Tickets API-Batch

Archive a batch of tickets by ID Read a batch of tickets by internal ID, or unique property values Create a batch of tickets Update a batch of tickets by internal ID, or unique property values Read a batch of tickets by internal ID, or unique property values Create a batch of tickets Update a batch of tickets by internal ID, or unique property values

Tickets API-Basic

Read Archive Update List Create Archive

Tickets API-Search

post-/crm/v3/objects/tickets/search do Search

Invoices API-Batch

Read a batch of invoices by internal ID, or unique property values

Invoices API-Basic

Invoices API-Search

post-/crm/v3/objects/invoices/search

Discounts API-Search

post-/crm/v3/objects/discounts/search

Line Items API-Search

post-/crm/v3/objects/line items/search do Search

Discounts API-Basic

Objects API-Public_Object

Merge two objects with same type

Objects API-Basic

Payments API-Batch

Read a batch of payments by internal ID, or unique property values

Objects API-Search

post-/crm/v3/objects/{object Type}/search do Search

Imports API-Public_Imports

get-/crm/v3/imports/{import Id}/errors get Errors

Lists API-Memberships

Add and/or Remove Records from a List

Tickets API-Basic

Feedback Submissions API-Search

post-/crm/v3/objects/feedback submissions/search do Search

Taxes API-Public_Object

Merge two taxes with same type

Pipelines API-Pipelines

Return a pipeline by ID

Pipelines API-Pipeline Audits

Return an audit of all changes to the pipeline

Lists API-Lists

Tickets API-Batch

Archive a batch of tickets by ID

Taxes API-Search

post-/crm/v3/objects/taxes/search

Payments API-Search

post-/crm/v3/objects/payments/search

Orders API-Search

post-/crm/v3/objects/orders/search

Discounts API-Batch

Update a batch of discounts

Goals API-Batch

Read a batch of goal targets by internal ID, or unique property values

Return an audit of all changes to the pipeline stage

Feedback Submissions API-Basic

Products API-Search

post-/crm/v3/objects/products/search do Search

Quotes API-Search

post-/crm/v3/objects/quotes/search do Search

Conversations API Collections

Conversations Inbox & Messages API-Conversations

Get conversations inboxes.Get a single thread.Archives a thread.Update a thread.Get the original content of a single message.Get message history for a thread.Send a message to a thread.Get actors Get channel accounts.Get a single channel.Get a single message.Get channels.Get a single actor.Get threads.Get a single channel account.Get a single conversations inbox.Get the original content of a single message.Get actors Archives a thread.Get a single message.Update a thread.Get a single channel.Get channels.Get a single conversations inbox.Get threads.Send a message to a thread.Get a single channel account.Get channel accounts.Get message history for a thread.Get a single thread.

Conversations Visitor Identification API

Generate a token

Conversations Visitor Identification API

Generate a token

Engagements API Collections

Calls API-Batch

Create a batch of calls Read a batch of calls by internal ID, or unique property values Update a batch of calls by internal ID, or unique property values Archive a batch of calls by ID Update a batch of calls by internal ID, or unique property values Archive a batch of calls by ID

Calls API-Basic

List Create Read Archive Update Archive Read Create Update

Calls API-Search

post-/crm/v3/objects/calls/search do Search post-/crm/v3/objects/calls/search do Search

Email API-Batch

Create a batch of emails

Email API-Batch

Create a batch of emails Read a batch of emails by internal ID, or unique property values Archive a batch of emails by ID Update a batch of emails by internal ID, or unique property values Read a batch of emails by internal ID, or unique property values Archive a batch of emails by ID Update a batch of emails by internal ID, or unique property values

Email API-Basic

List Create Read Archive Update List Create Update Read Archive

Email API-Search

post-/crm/v3/objects/emails/search do Search post-/crm/v3/objects/emails/search do Search

Meetings API-Batch

Update a batch of meetings by internal ID, or unique property values Archive a batch of meetings by ID Read a batch of meetings by internal ID, or unique property values Create a batch of meetings Read a batch of meetings by internal ID, or unique property values Archive a batch of meetings by ID Create a batch of meetings

Meetings API-Basic

Meetings API-Basic

Read Archive Update List Create Archive List Update

Meetings API-Search

post-/crm/v3/objects/meetings/search do Search

Notes API-Batch

Read a batch of notes by internal ID, or unique property values Archive a batch of notes by ID Update a batch of notes by internal ID, or unique property values Create a batch of notes Update a batch of notes by internal ID, or unique property values Create a batch of notes

Notes API-Basic

Notes API-Basic

List Create Read Archive Update Update Archive Read Create

Notes API-Search

post-/crm/v3/objects/notes/search do Search post-/crm/v3/objects/notes/search do Search

Postal Mail API-Batch

Read a batch of postal mail by internal ID, or unique property values

Postal Mail API-Batch

Read a batch of postal mail by internal ID, or unique property values Archive a batch of postal mail by ID Create a batch of postal mail Update a batch of postal mail by internal ID, or unique property values Create a batch of postal mail Update a batch of postal mail by internal ID, or unique property values Archive a batch of postal mail by ID

Postal Mail API-Basic

Postal Mail API-Basic

List Create Read Archive Update Create

Postal Mail API-Search

post-/crm/v3/objects/postal mail/search do Search

Tasks API-Batch

Archive a batch of tasks by ID Create a batch of tasks Update a batch of tasks by internal ID, or unique property values Read a batch of tasks by internal ID, or unique property values Update a batch of tasks by internal ID, or unique property values Read a batch of tasks by internal ID, or unique property values

Tasks API-Basic

Read Archive Update List Create Archive Update

Tasks API-Search

post-/crm/v3/objects/tasks/search do Search

Communications API-Batch

Update a batch of communications by internal ID, or unique property values Archive a batch of communications by ID Create a batch of communications Read a batch of communications by internal ID, or unique property values Read a batch of communications by internal ID, or unique property values Create a batch of communications

Communications API-Basic

List Create Read Archive Update List Read Create Archive

Communications API-Search

post-/crm/v3/objects/communications/search do Search

Meetings API-Batch

Update a batch of meetings by internal ID, or unique property values

Tasks API-Basic

Calls API-Basic

Events API Collections

Custom Behavioral Events API-Custom Behavioral Events API

Send custom event completion

Custom Behavioral Events API

Query Custom Behavioral Event Definitions Create Custom Behavioral Event Definition Fetch Single Custom Behavioral Event Definition delete-/events/v3/event-definitions/{event Name}Modify Single Custom Behavioral Event Definition Create Property for Custom Behavioral Event Definition delete-/events/v3/event-definitions/{event Name}/property/{property Name}Modify Property for Custom Behavioral Event Definition Fetch Single Custom Behavioral Event Definition Query Custom Behavioral Event Definitions delete-/events/v3/event-definitions/{event Name}Create Custom Behavioral Event Definition delete-/events/v3/event-definitions/{event Name}/property/{property Name}Modify Single Custom Behavioral Event Definition Modify Property for Custom Behavioral Event Definition

Custom Event Definitions API-Event definition

Query custom event definitions Create custom event definition Fetch a specific custom event definition delete-/events/v3/event-definitions/{event Name}Update a custom event definition Create a new property for a custom event definition.Delete a property from a custom event definition Update an existing custom event property Fetch a specific custom event definition Update an existing custom event property Create a new property for a custom event definition.Create custom event definition Update a custom event definition Delete a property from a custom event definition delete-/events/v3/event-definitions/{event Name}

Custom Event Definitions API-Event tracking

Send custom event completion data

Custom Event Definitions API-Event tracking

Send custom event completion data

Custom Event Definitions API-Event definition

Query custom event definitions

Custom Behavioral Events API-Custom Behavioral Events API

Send custom event completion

Extend CRM API Collections

Callings Extensions API-Recording_Settings

get-/crm/v3/extensions/calling/{app Id}/settings/recording get Url Format post-/crm/v3/extensions/calling/{app Id}/settings/recording register Url Format patch-/crm/v3/extensions/calling/{app Id}/settings/recording update Url Format post-/crm/v3/extensions/calling/{app Id}/settings/recording register Url Format patch-/crm/v3/extensions/calling/{app Id}/settings/recording update Url Format get-/crm/v3/extensions/calling/{app Id}/settings/recording get Url Format

Callings Extensions API-Settings

Get calling settings Configure a calling extension Delete calling settings Update settings Update settings Configure a calling extension Delete calling settings

Video Conference Ext API-Settings

Video Conference Ext API-Settings

Get settings Update settings Delete settings Update settings Delete settings

Callings Extensions API-Settings

Get calling settings

GraphQL Collector Collection

Execute a GraphQL operation

Marketing API Collections

Transactional Email API-Public_Smtp_Tokens

Query a single token by ID.Delete a single token by ID.Query SMTP API tokens by campaign name or an emailCampaignId.Create a SMTP API token.Reset the password of an existing token.Query SMTP API tokens by campaign name or an emailCampaignId.Reset the password of an existing token.Create a SMTP API token.

Transactional Email API-Single_Send

Send a single transactional email asynchronously.Send a single transactional email asynchronously.

Subscription Preferences API-Status

Subscribe a contact Unsubscribe a contact Get subscription statuses for a contact Get subscription statuses for a contact Subscribe a contact Unsubscribe a contact

Subscription Preferences API-Definition

Get subscription definitions Get subscription definitions

Marketing Emails API-Statistics

Get aggregated statistics.Get aggregated statistic intervals.Get aggregated statistic intervals.

Marketing Emails API-Marketing Emails

Get the variation of a an A/B marketing email Reset Draft Restore a revision of a marketing email to DRAFT state Get draft version of a marketing email Create or update draft version Get revisions of a marketing email Get a revision of a marketing email.Get all marketing emails for a HubSpot account.Create a new marketing email.Restore a revision of a marketing email Get the details of a specified marketing email.Delete a marketing email.Update a marketing email.Create or update draft version Get revisions of a marketing email Delete a marketing email.Restore a revision of a marketing email Create a new marketing email.Restore a revision of a marketing email to DRAFT state Get a revision of a marketing email.Get all marketing emails for a HubSpot account.Get the details of a specified marketing email.Update a marketing email.Reset Draft Get draft version of a marketing email

Marketing Emails API

Publish or send a marketing email.Create an A/B test variation of a marketing email.Unpublish or cancel a marketing email.Clone a marketing email.Clone a marketing email.Create an A/B test variation of a marketing email.Unpublish or cancel a marketing email.Publish or send a marketing email.

Marketing Events API-Batch

Create or update multiple marketing events Delete multiple marketing events Delete multiple marketing events Create or update multiple marketing events

Marketing Events API-Attendance Subscriber State Changes

Record a subscriber state by contact ids Record a subscriber state by contact email Record a subscriber state by contact email

Marketing Events API-Subscriber State Changes

Record a subscriber state by contact email

Marketing Events API-Subscriber State Changes

Record a subscriber state by contact email Record a subscriber state by contact id Record a subscriber state by contact id

Marketing Events API-Marketing_Events_External

Mark a marketing event as completed

Marketing Events API-Basic

Create a marketing event Mark a marketing event as cancelled Get a marketing event Create or update a marketing event Delete a marketing event Update a marketing event Delete a marketing event Create or update a marketing event Mark a marketing event as cancelled Update a marketing event Get a marketing event

Marketing Events API-Settings

Retrieve the application settings Update the application settings Update the application settings Retrieve the application settings

Marketing Events API-Search

Search for marketing events

Marketing Events API

Read participations breakdown by Marketing Event internal identifier

Marketing Events API

Read participations breakdown by Marketing Event internal identifier Read participations counters by Marketing Event external identifier Read participations counters by Marketing Event internal identifier Read participations breakdown by Marketing Event external identifier Read participations breakdown by Contact identifier Read participations counters by Marketing Event internal identifier Read participations breakdown by Contact identifier Read participations counters by Marketing Event external identifier Read participations breakdown by Marketing Event external identifier

Single-Send API-Single_Send

post-/marketing/v4/email/single-send post-/marketing/v4/email/single-send

Marketing Events API-Marketing_Events_External

Mark a marketing event as completed

Marketing Events API-Attendance Subscriber State Changes

Record a subscriber state by contact ids

Marketing Emails API-Statistics

Get aggregated statistics.

Marketing Events API-Basic

Create a marketing event

Marketing Events API-Search

Search for marketing events

Marketing Emails API-Marketing Emails

Get the variation of a an A/B marketing email

Settings API Collections

Business Unit API-Business Unit

Get Business Units for a user

User Provisioning API-Teams

See details about this account's teams

User Provisioning API-Roles

Retrieves the roles on an account

User Provisioning API-Users

Retrieves a list of users from an account Adds a user Retrieves a user Modifies a user Removes a user Removes a user Modifies a user Adds a user Retrieves a user

Users API-Batch

Read a batch of users by internal ID, or unique property values Read a batch of users by internal ID, or unique property values

Users API-Basic

Read List List Read

Users API-Search

post-/crm/v3/objects/users/search

Currencies API-Currency

get-/settings/v3/currencies/exchange-rates

Currencies API-Currency

get-/settings/v3/currencies/exchange-rates post-/settings/v3/currencies/exchange-rates get-/settings/v3/currencies/codes get-/settings/v3/currencies/company-currency put-/settings/v3/currencies/company-currency post-/settings/v3/currencies/exchange-rates/batch/update get-/settings/v3/currencies/exchange-rates/current post-/settings/v3/currencies/exchange-rates/update-visibility get-/settings/v3/currencies/exchange-rates/{exchange Rate Id}patch-/settings/v3/currencies/exchange-rates/{exchange Rate Id}post-/settings/v3/currencies/exchange-rates/batch/create post-/settings/v3/currencies/exchange-rates/batch/read post-/settings/v3/currencies/exchange-rates/update-visibility post-/settings/v3/currencies/exchange-rates/batch/update post-/settings/v3/currencies/exchange-rates/batch/read post-/settings/v3/currencies/exchange-rates/batch/create patch-/settings/v3/currencies/exchange-rates/{exchange Rate Id}put-/settings/v3/currencies/company-currency get-/settings/v3/currencies/exchange-rates/current get-/settings/v3/currencies/company-currency post-/settings/v3/currencies/exchange-rates get-/settings/v3/currencies/codes

Users API-Search

post-/crm/v3/objects/users/search

User Provisioning API-Roles

Retrieves the roles on an account

User Provisioning API-Teams

See details about this account's teams

User Provisioning API-Users

Retrieves a list of users from an account

Webhooks API Collections

Webhooks API-Settings

get-/webhooks/v3/{app Id}/settings get All

Webhooks API-Settings

get-/webhooks/v3/{app Id}/settings get All put-/webhooks/v3/{app Id}/settings configure delete-/webhooks/v3/{app Id}/settings clear delete-/webhooks/v3/{app Id}/settings clear put-/webhooks/v3/{app Id}/settings configure

Webhooks API-Subscriptions

get-/webhooks/v3/{app Id}/subscriptions/{subscription Id} get By Id

Webhooks API-Subscriptions

get-/webhooks/v3/{app Id}/subscriptions/{subscription Id} get By Id delete-/webhooks/v3/{app Id}/subscriptions/{subscription Id} archive patch-/webhooks/v3/{app Id}/subscriptions/{subscription Id} update get-/webhooks/v3/{app Id}/subscriptions get All post-/webhooks/v3/{app Id}/subscriptions create post-/webhooks/v3/{app Id}/subscriptions/batch/update update Batch get-/webhooks/v3/{app Id}/subscriptions get All patch-/webhooks/v3/{app Id}/subscriptions/{subscription Id} update post-/webhooks/v3/{app Id}/subscriptions create delete-/webhooks/v3/{app Id}/subscriptions/{subscription Id} archive post-/webhooks/v3/{app Id}/subscriptions/batch/update update Batch

GraphQL Collector Collection

Execute a GraphQL operation

Home CRM API Collections Orders API-BasicArchive

Archive

DELETE {{baseUrl}}/crm/v3/objects/orders/:orderId

Move an Object identified by {orderId} to the recycling bin.

HEADERS

Key	Datatype	Required	Description
`Accept`	string