HubSpot CRM

CRM and marketing platform

developers.hubspot.com/docs/api ↗

Version

OpenAPI

3.0.1

Endpoints

172

Schemas

104

67

Quality

Updated

3 days ago

Crm crm marketing sales

Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://api.hubapi.com

Endpoints

Clear filters

GET POST PUT PATCH DELETE

Basic 18 endpoints

GET /crm/v3/objects/companies List

Read a page of companies. Control what is returned via the properties query param.

operationId: Basic_listCompaniesPage

Parameters

Name	In	Required	Type	Description
limit	query	optional	integer	The maximum number of results to display per page.
after	query	optional	string	The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
properties	query	optional	array	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
propertiesWithHistory	query	optional	array	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
associations	query	optional	array	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
archived	query	optional	boolean	Whether to return only results that have been archived.

Responses

default —

200

successful operation

GET /crm/v3/objects/companies

GET /crm/v3/objects/companies/{companyId} Read

Read an Object identified by {companyId}. {companyId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

operationId: Basic_readCompanyObject

Parameters

Name	In	Required	Type	Description
companyId	path	required	string	—
properties	query	optional	array	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
propertiesWithHistory	query	optional	array	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
associations	query	optional	array	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
archived	query	optional	boolean	Whether to return only results that have been archived.
idProperty	query	optional	string	The name of a property whose values are unique for this object type

Responses

default —

200

successful operation

GET /crm/v3/objects/companies/{companyId}

GET /crm/v3/objects/contacts List

Read a page of contacts. Control what is returned via the properties query param.

operationId: Basic_listContactsPage

Parameters

Name	In	Required	Type	Description
limit	query	optional	integer	The maximum number of results to display per page.
after	query	optional	string	The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
properties	query	optional	array	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
propertiesWithHistory	query	optional	array	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
associations	query	optional	array	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
archived	query	optional	boolean	Whether to return only results that have been archived.

Responses

default —

200

successful operation

GET /crm/v3/objects/contacts

GET /crm/v3/objects/contacts/{contactId} Read

Read an Object identified by {contactId}. {contactId} refers to the internal object ID. Control what is returned via the properties query param.

operationId: Basic_readContactById

Parameters

Name	In	Required	Type	Description
contactId	path	required	string	—
properties	query	optional	array	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
propertiesWithHistory	query	optional	array	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
associations	query	optional	array	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
archived	query	optional	boolean	Whether to return only results that have been archived.

Responses

default —

200

successful operation

GET /crm/v3/objects/contacts/{contactId}

GET /crm/v3/objects/deals List

Read a page of deals. Control what is returned via the properties query param.

operationId: Basic_getDealsPage

Parameters

Name	In	Required	Type	Description
limit	query	optional	integer	The maximum number of results to display per page.
after	query	optional	string	The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
properties	query	optional	array	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
propertiesWithHistory	query	optional	array	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
associations	query	optional	array	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
archived	query	optional	boolean	Whether to return only results that have been archived.

Responses

default —

200

successful operation

GET /crm/v3/objects/deals

GET /crm/v3/objects/deals/{dealId} Read

Read an Object identified by {dealId}. {dealId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

operationId: Basic_readDealById

Parameters

Name	In	Required	Type	Description
dealId	path	required	string	—
properties	query	optional	array	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
propertiesWithHistory	query	optional	array	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
associations	query	optional	array	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
archived	query	optional	boolean	Whether to return only results that have been archived.
idProperty	query	optional	string	The name of a property whose values are unique for this object type

Responses

default —

200

successful operation

GET /crm/v3/objects/deals/{dealId}

GET /crm/v3/objects/feedback_submissions List

Read a page of feedback submissions. Control what is returned via the properties query param.

operationId: Basic_listFeedbackSubmissionsPage

Parameters

Name	In	Required	Type	Description
limit	query	optional	integer	The maximum number of results to display per page.
after	query	optional	string	The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
properties	query	optional	array	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
propertiesWithHistory	query	optional	array	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
associations	query	optional	array	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
archived	query	optional	boolean	Whether to return only results that have been archived.

Responses

default —

200

successful operation

GET /crm/v3/objects/feedback_submissions

GET /crm/v3/objects/feedback_submissions/{feedbackSubmissionId} Read

Read an Object identified by {feedbackSubmissionId}. {feedbackSubmissionId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

operationId: Basic_readFeedbackSubmission

Parameters

Name	In	Required	Type	Description
feedbackSubmissionId	path	required	string	—
properties	query	optional	array	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
propertiesWithHistory	query	optional	array	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
associations	query	optional	array	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
archived	query	optional	boolean	Whether to return only results that have been archived.
idProperty	query	optional	string	The name of a property whose values are unique for this object type

Responses

default —

200

successful operation

GET /crm/v3/objects/feedback_submissions/{feedbackSubmissionId}

GET /crm/v3/objects/line_items List

Read a page of line items. Control what is returned via the properties query param.

operationId: Basic_listLineItemsPage

Parameters

Name	In	Required	Type	Description
limit	query	optional	integer	The maximum number of results to display per page.
after	query	optional	string	The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
properties	query	optional	array	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
propertiesWithHistory	query	optional	array	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
associations	query	optional	array	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
archived	query	optional	boolean	Whether to return only results that have been archived.

Responses

default —

200

successful operation

GET /crm/v3/objects/line_items

GET /crm/v3/objects/line_items/{lineItemId} Read

Read an Object identified by {lineItemId}. {lineItemId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

operationId: Basic_readLineItemById

Parameters

Name	In	Required	Type	Description
lineItemId	path	required	string	—
properties	query	optional	array	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
propertiesWithHistory	query	optional	array	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
associations	query	optional	array	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
archived	query	optional	boolean	Whether to return only results that have been archived.
idProperty	query	optional	string	The name of a property whose values are unique for this object type

Responses

default —

200

successful operation

GET /crm/v3/objects/line_items/{lineItemId}

GET /crm/v3/objects/products List

Read a page of products. Control what is returned via the properties query param.

operationId: Basic_listProductsPage

Parameters

Name	In	Required	Type	Description
limit	query	optional	integer	The maximum number of results to display per page.
after	query	optional	string	The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
properties	query	optional	array	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
propertiesWithHistory	query	optional	array	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
associations	query	optional	array	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
archived	query	optional	boolean	Whether to return only results that have been archived.

Responses

default —

200

successful operation

GET /crm/v3/objects/products

GET /crm/v3/objects/products/{productId} Read

Read an Object identified by {productId}. {productId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

operationId: Basic_readProductById

Parameters

Name	In	Required	Type	Description
productId	path	required	string	—
properties	query	optional	array	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
propertiesWithHistory	query	optional	array	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
associations	query	optional	array	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
archived	query	optional	boolean	Whether to return only results that have been archived.
idProperty	query	optional	string	The name of a property whose values are unique for this object type

Responses

default —

200

successful operation

GET /crm/v3/objects/products/{productId}

GET /crm/v3/objects/quotes List

Read a page of quotes. Control what is returned via the properties query param.

operationId: Basic_listQuotesPage

Parameters

Name	In	Required	Type	Description
limit	query	optional	integer	The maximum number of results to display per page.
after	query	optional	string	The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
properties	query	optional	array	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
propertiesWithHistory	query	optional	array	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
associations	query	optional	array	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
archived	query	optional	boolean	Whether to return only results that have been archived.

Responses

default —

200

successful operation

GET /crm/v3/objects/quotes

GET /crm/v3/objects/quotes/{quoteId} Read

Read an Object identified by {quoteId}. {quoteId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

operationId: Basic_readQuoteById

Parameters

Name	In	Required	Type	Description
quoteId	path	required	string	—
properties	query	optional	array	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
propertiesWithHistory	query	optional	array	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
associations	query	optional	array	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
archived	query	optional	boolean	Whether to return only results that have been archived.
idProperty	query	optional	string	The name of a property whose values are unique for this object type

Responses

default —

200

successful operation

GET /crm/v3/objects/quotes/{quoteId}

GET /crm/v3/objects/tickets List

Read a page of tickets. Control what is returned via the properties query param.

operationId: Basic_listTicketsPage

Parameters

Name	In	Required	Type	Description
limit	query	optional	integer	The maximum number of results to display per page.
after	query	optional	string	The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
properties	query	optional	array	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
propertiesWithHistory	query	optional	array	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
associations	query	optional	array	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
archived	query	optional	boolean	Whether to return only results that have been archived.

Responses

default —

200

successful operation

GET /crm/v3/objects/tickets

GET /crm/v3/objects/tickets/{ticketId} Read

Read an Object identified by {ticketId}. {ticketId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

operationId: Basic_readTicketById

Parameters

Name	In	Required	Type	Description
ticketId	path	required	string	—
properties	query	optional	array	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
propertiesWithHistory	query	optional	array	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
associations	query	optional	array	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
archived	query	optional	boolean	Whether to return only results that have been archived.
idProperty	query	optional	string	The name of a property whose values are unique for this object type

Responses

default —

200

successful operation

GET /crm/v3/objects/tickets/{ticketId}

GET /crm/v3/objects/{objectType} List

Read a page of objects. Control what is returned via the properties query param.

operationId: Basic_listObjectsPage

Parameters

Name	In	Required	Type	Description
objectType	path	required	string	—
limit	query	optional	integer	The maximum number of results to display per page.
after	query	optional	string	The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
properties	query	optional	array	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
propertiesWithHistory	query	optional	array	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
associations	query	optional	array	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
archived	query	optional	boolean	Whether to return only results that have been archived.

Responses

default —

200

successful operation

GET /crm/v3/objects/{objectType}

GET /crm/v3/objects/{objectType}/{objectId} Read

Read an Object identified by {objectId}. {objectId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

operationId: Basic_readObjectById

Parameters

Name	In	Required	Type	Description
objectType	path	required	string	—
objectId	path	required	string	—
properties	query	optional	array	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
propertiesWithHistory	query	optional	array	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
associations	query	optional	array	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
archived	query	optional	boolean	Whether to return only results that have been archived.
idProperty	query	optional	string	The name of a property whose values are unique for this object type

Responses

default —

200

successful operation

GET /crm/v3/objects/{objectType}/{objectId}

Core 6 endpoints

GET /crm/v3/imports Get active imports

Returns a paged list of active imports for this account.

operationId: Core_getActiveImportsPage

Parameters

Name	In	Required	Type	Description
after	query	optional	string	The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
before	query	optional	string	—
limit	query	optional	integer	The maximum number of results to display per page.

Responses

default —

200

successful operation

GET /crm/v3/imports

GET /crm/v3/imports/{importId} Get the information on any import

A complete summary of an import record, including any updates.

operationId: Core_getImportRecord

Parameters

Name	In	Required	Type	Description
importId	path	required	integer	—

Responses

default —

200

successful operation

GET /crm/v3/imports/{importId}

GET /crm/v3/properties/{objectType} Read all properties

Read all existing properties for the specified object type and HubSpot account.

operationId: Core_getAllProperties

Parameters

Name	In	Required	Type	Description
objectType	path	required	string	—
archived	query	optional	boolean	Whether to return only results that have been archived.
properties	query	optional	string	—

Responses

default —

200

successful operation

GET /crm/v3/properties/{objectType}

GET /crm/v3/properties/{objectType}/{propertyName} Read a property

Read a property identified by {propertyName}.

operationId: Core_readProperty

Parameters

Name	In	Required	Type	Description
objectType	path	required	string	—
propertyName	path	required	string	—
archived	query	optional	boolean	Whether to return only results that have been archived.
properties	query	optional	string	—

Responses

default —

200

successful operation

GET /crm/v3/properties/{objectType}/{propertyName}

GET /crm/v3/schemas Get all schemas

Returns all object schemas that have been defined for your account.

operationId: Core_getAllSchemas

Parameters

Name	In	Required	Type	Description
archived	query	optional	boolean	Whether to return only results that have been archived.

Responses

default —

200

successful operation

GET /crm/v3/schemas

GET /crm/v3/schemas/{objectType} Get an existing schema

Returns an existing object schema.

operationId: Core_getExistingSchema

Parameters

Name	In	Required	Type	Description
objectType	path	required	string	Fully qualified name or object type ID of your schema.

Responses

default —

200

successful operation

GET /crm/v3/schemas/{objectType}

Events 3 endpoints

GET /crm/v3/timeline/events/{eventTemplateId}/{eventId} Gets the event

This returns the previously created event. It contains all existing info for the event, but not necessarily the CRM object.

operationId: Events_getEventById

Parameters

Name	In	Required	Type	Description
eventTemplateId	path	required	string	The event template ID.
eventId	path	required	string	The event ID.

Responses

default —

200

successful operation

GET /crm/v3/timeline/events/{eventTemplateId}/{eventId}

GET /crm/v3/timeline/events/{eventTemplateId}/{eventId}/detail Gets the detailTemplate as rendered

This will take the detailTemplate from the event template and return an object rendering the specified event. If the template references extraData that isn’t found in the event, it will be ignored and we’ll render without it.

operationId: Events_renderDetailTemplate

Parameters

Name	In	Required	Type	Description
eventTemplateId	path	required	string	The event template ID.
eventId	path	required	string	The event ID.

Responses

default —

200

successful operation

GET /crm/v3/timeline/events/{eventTemplateId}/{eventId}/detail

GET /crm/v3/timeline/events/{eventTemplateId}/{eventId}/render Renders the header or detail as HTML

This will take either the headerTemplate or detailTemplate from the event template and render for the specified event as HTML. If the template references extraData that isn’t found in the event, it will be ignored and we’ll render without it.

operationId: Events_renderingHtml

Parameters

Name	In	Required	Type	Description
eventTemplateId	path	required	string	The event template ID.
eventId	path	required	string	The event ID.
detail	query	optional	boolean	Set to ‘true’, we want to render the `detailTemplate` instead of the `headerTemplate`.

Responses

default —

200

successful operation

GET /crm/v3/timeline/events/{eventTemplateId}/{eventId}/render

Groups 2 endpoints

GET /crm/v3/properties/{objectType}/groups Read all property groups

Read all existing property groups for the specified object type and HubSpot account.

operationId: Groups_readAllProperty

Parameters

Name	In	Required	Type	Description
objectType	path	required	string	—

Responses

default —

200

successful operation

GET /crm/v3/properties/{objectType}/groups

GET /crm/v3/properties/{objectType}/groups/{groupName} Read a property group

Read a property group identified by {groupName}.

operationId: Groups_readPropertyGroup

Parameters

Name	In	Required	Type	Description
objectType	path	required	string	—
groupName	path	required	string	—

Responses

default —

200

successful operation

GET /crm/v3/properties/{objectType}/groups/{groupName}

Owners 2 endpoints

GET /crm/v3/owners Get a page of owners

operationId: Owners_getPage

Parameters

Name	In	Required	Type	Description
email	query	optional	string	Filter by email address (optional)
after	query	optional	string	The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
limit	query	optional	integer	The maximum number of results to display per page.
archived	query	optional	boolean	Whether to return only results that have been archived.

Responses

default —

200

successful operation

GET /crm/v3/owners

GET /crm/v3/owners/{ownerId} Read an owner by given `id` or `userId`

operationId: Owners_getById

Parameters

Name	In	Required	Type	Description
ownerId	path	required	integer	—
idProperty	query	optional	string	—
archived	query	optional	boolean	Whether to return only results that have been archived.

Responses

default —

200

successful operation

GET /crm/v3/owners/{ownerId}

Pipelineaudits 1 endpoints

GET /crm/v3/pipelines/{objectType}/{pipelineId}/audit Return an audit of all changes to the pipeline

Return a reverse chronological list of all mutations that have occurred on the pipeline identified by {pipelineId}.

operationId: PipelineAudits_getByPipelineId

Parameters

Name	In	Required	Type	Description
objectType	path	required	string	—
pipelineId	path	required	string	—

Responses

default —

200

successful operation

GET /crm/v3/pipelines/{objectType}/{pipelineId}/audit

Pipelinestageaudits 1 endpoints

GET /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}/audit Return an audit of all changes to the pipeline stage

Return a reverse chronological list of all mutations that have occurred on the pipeline stage identified by {stageId}.

operationId: PipelineStageAudits_getStageAudit

Parameters

Name	In	Required	Type	Description
objectType	path	required	string	—
stageId	path	required	string	—

Responses

default —

200

successful operation

GET /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}/audit

Pipelinestages 2 endpoints

GET /crm/v3/pipelines/{objectType}/{pipelineId}/stages Return all stages of a pipeline

Return all the stages associated with the pipeline identified by {pipelineId}.

operationId: PipelineStages_getAll

Parameters

Name	In	Required	Type	Description
objectType	path	required	string	—
pipelineId	path	required	string	—

Responses

default —

200

successful operation

GET /crm/v3/pipelines/{objectType}/{pipelineId}/stages

GET /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId} Return a pipeline stage by ID

Return the stage identified by {stageId} associated with the pipeline identified by {pipelineId}.

operationId: PipelineStages_getById

Parameters

Name	In	Required	Type	Description
objectType	path	required	string	—
pipelineId	path	required	string	—
stageId	path	required	string	—

Responses

default —

200

successful operation

GET /crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}

Pipelines 2 endpoints

GET /crm/v3/pipelines/{objectType} Retrieve all pipelines

Return all pipelines for the object type specified by {objectType}.

operationId: Pipelines_getAll

Parameters

Name	In	Required	Type	Description
objectType	path	required	string	—

Responses

default —

200

successful operation

GET /crm/v3/pipelines/{objectType}

GET /crm/v3/pipelines/{objectType}/{pipelineId} Return a pipeline by ID

Return a single pipeline object identified by its unique {pipelineId}.

operationId: Pipelines_getById

Parameters

Name	In	Required	Type	Description
objectType	path	required	string	—
pipelineId	path	required	string	—

Responses

default —

200

successful operation

GET /crm/v3/pipelines/{objectType}/{pipelineId}

Publicimports 1 endpoints

GET /crm/v3/imports/{importId}/errors

operationId: PublicImports_getErrorDetails

Parameters

Name	In	Required	Type	Description
after	query	optional	string	The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
limit	query	optional	integer	The maximum number of results to display per page.
importId	path	required	integer	—

Responses

default —

200

successful operation

GET /crm/v3/imports/{importId}/errors

Recordingsettings 1 endpoints

GET /crm/v3/extensions/calling/{appId}/settings/recording

operationId: RecordingSettings_getByAppId

Parameters

Name	In	Required	Type	Description
appId	path	required	integer	—

Responses

default —

200

successful operation

GET /crm/v3/extensions/calling/{appId}/settings/recording

Settings 2 endpoints

GET /crm/v3/extensions/calling/{appId}/settings Get calling settings

Returns the calling extension settings configured for your app.

operationId: Settings_getCallingConfig

Parameters

Name	In	Required	Type	Description
appId	path	required	integer	The ID of the target app.

Responses

default —

200

successful operation

GET /crm/v3/extensions/calling/{appId}/settings

GET /crm/v3/extensions/videoconferencing/settings/{appId} Get settings

Return the settings for a video conference application with the specified ID.

operationId: Settings_getById

Parameters

Name	In	Required	Type	Description
appId	path	required	integer	The ID of the video conference application. This is the identifier of the application created in your HubSpot developer portal.

Responses

default —

200

successful operation

GET /crm/v3/extensions/videoconferencing/settings/{appId}

Templates 2 endpoints

GET /crm/v3/timeline/{appId}/event-templates List all event templates for your app

Use this to list all event templates owned by your app.

operationId: Templates_listEventTemplates

Parameters

Name	In	Required	Type	Description
appId	path	required	integer	The ID of the target app.

Responses

default —

200

successful operation

GET /crm/v3/timeline/{appId}/event-templates

GET /crm/v3/timeline/{appId}/event-templates/{eventTemplateId} Gets a specific event template for your app

View the current state of a specific template and its tokens.

operationId: Templates_getSpecificEventTemplate

Parameters

Name	In	Required	Type	Description
eventTemplateId	path	required	string	The event template ID.
appId	path	required	integer	The ID of the target app.

Responses

default —

200

successful operation

GET /crm/v3/timeline/{appId}/event-templates/{eventTemplateId}

Load more endpoints

Schemas

object ActionResponse

{
  "type": "object",
  "required": [
    "completedAt",
    "startedAt",
    "status"
  ],
  "properties": {
    "links": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "status": {
      "enum": [
        "PENDING",
        "PROCESSING",
        "CANCELED",
        "COMPLETE"
      ],
      "type": "string"
    },
    "startedAt": {
      "type": "string",
      "format": "date-time"
    },
    "completedAt": {
      "type": "string",
      "format": "date-time"
    },
    "requestedAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}

object AssociatedId

{
  "type": "object",
  "required": [
    "id",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  }
}

object AssociationDefinition

{
  "type": "object",
  "example": {
    "id": "105",
    "name": "my_object_to_contact",
    "toObjectTypeId": "0-1",
    "fromObjectTypeId": "2-123456"
  },
  "required": [
    "fromObjectTypeId",
    "id",
    "toObjectTypeId"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "105",
      "description": "A unique ID for this association."
    },
    "name": {
      "type": "string",
      "example": "my_object_to_contact",
      "description": "A unique name for this association."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the association was defined."
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the association was last updated."
    },
    "toObjectTypeId": {
      "type": "string",
      "example": "0-1",
      "description": "ID of the target object type ID to link to."
    },
    "fromObjectTypeId": {
      "type": "string",
      "example": "2-123456",
      "description": "ID of the primary object type to link from."
    }
  },
  "description": "Defines an association between two object types."
}

object AssociationDefinitionEgg

{
  "type": "object",
  "example": {
    "name": "my_object_to_contact",
    "toObjectTypeId": "contact",
    "fromObjectTypeId": "2-123456"
  },
  "required": [
    "fromObjectTypeId",
    "toObjectTypeId"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "my_object_to_contact",
      "description": "A unique name for this association."
    },
    "toObjectTypeId": {
      "type": "string",
      "example": "contact",
      "description": "ID of the target object type ID to link to."
    },
    "fromObjectTypeId": {
      "type": "string",
      "example": "2-123456",
      "description": "ID of the primary object type to link from."
    }
  },
  "description": "Defines an association between two object types."
}

object AssociationSpec

{
  "type": "object",
  "required": [
    "associationCategory",
    "associationTypeId"
  ],
  "properties": {
    "associationTypeId": {
      "type": "integer",
      "format": "int32"
    },
    "associationCategory": {
      "enum": [
        "HUBSPOT_DEFINED",
        "USER_DEFINED",
        "INTEGRATOR_DEFINED"
      ],
      "type": "string"
    }
  }
}

object BatchInputPropertyCreate

{
  "type": "object",
  "required": [
    "inputs"
  ],
  "properties": {
    "inputs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PropertyCreate"
      }
    }
  }
}

object BatchInputPropertyName

{
  "type": "object",
  "required": [
    "inputs"
  ],
  "properties": {
    "inputs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PropertyName"
      }
    }
  }
}

object BatchInputSimplePublicObjectBatchInput

{
  "type": "object",
  "required": [
    "inputs"
  ],
  "properties": {
    "inputs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SimplePublicObjectBatchInput"
      }
    }
  }
}

object BatchInputSimplePublicObjectId

{
  "type": "object",
  "required": [
    "inputs"
  ],
  "properties": {
    "inputs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SimplePublicObjectId"
      }
    }
  }
}

object BatchInputSimplePublicObjectInputForCreate

{
  "type": "object",
  "required": [
    "inputs"
  ],
  "properties": {
    "inputs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SimplePublicObjectInputForCreate"
      }
    }
  }
}

object BatchInputTimelineEvent

{
  "type": "object",
  "example": {
    "inputs": [
      {
        "email": "art3mis-pup@petspot.com",
        "tokens": {
          "petAge": 3,
          "petName": "Art3mis",
          "petColor": "black"
        },
        "extraData": {
          "questions": [
            {
              "answer": "Bark!",
              "question": "Who's a good girl?"
            },
            {
              "answer": "Woof!",
              "question": "Do you wanna go on a walk?"
            }
          ]
        },
        "timelineIFrame": {
          "url": "https://my.petspot.com/pets/Art3mis",
          "width": 600,
          "height": 400,
          "linkLabel": "View Art3mis",
          "headerLabel": "Art3mis dog"
        },
        "eventTemplateId": "1001298"
      },
      {
        "email": "pocket-tiger@petspot.com",
        "tokens": {
          "petAge": 3,
          "petName": "Pocket",
          "petColor": "yellow"
        },
        "extraData": {
          "questions": [
            {
              "answer": "Purr...",
              "question": "Who's a good kitty?"
            },
            {
              "answer": "Meow!",
              "question": "Will you stop playing with that?"
            }
          ]
        },
        "timelineIFrame": {
          "url": "https://my.petspot.com/pets/Pocket",
          "width": 600,
          "height": 400,
          "linkLabel": "View Pocket",
          "headerLabel": "Pocket Tiger"
        },
        "eventTemplateId": "1001298"
      }
    ]
  },
  "required": [
    "inputs"
  ],
  "properties": {
    "inputs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TimelineEvent"
      },
      "example": [
        {
          "email": "art3mis-pup@petspot.com",
          "tokens": {
            "petAge": 3,
            "petName": "Art3mis",
            "petColor": "black"
          },
          "extraData": {
            "questions": [
              {
                "answer": "Bark!",
                "question": "Who's a good girl?"
              },
              {
                "answer": "Woof!",
                "question": "Do you wanna go on a walk?"
              }
            ]
          },
          "timelineIFrame": {
            "url": "https://my.petspot.com/pets/Art3mis",
            "width": 600,
            "height": 400,
            "linkLabel": "View Art3mis",
            "headerLabel": "Art3mis dog"
          },
          "eventTemplateId": "1001298"
        },
        {
          "email": "pocket-tiger@petspot.com",
          "tokens": {
            "petAge": 3,
            "petName": "Pocket",
            "petColor": "yellow"
          },
          "extraData": {
            "questions": [
              {
                "answer": "Purr...",
                "question": "Who's a good kitty?"
              },
              {
                "answer": "Meow!",
                "question": "Will you stop playing with that?"
              }
            ]
          },
          "timelineIFrame": {
            "url": "https://my.petspot.com/pets/Pocket",
            "width": 600,
            "height": 400,
            "linkLabel": "View Pocket",
            "headerLabel": "Pocket Tiger"
          },
          "eventTemplateId": "1001298"
        }
      ],
      "description": "A collection of timeline events we want to create."
    }
  },
  "description": "Used to create timeline events in batches."
}

object BatchReadInputPropertyName

{
  "type": "object",
  "required": [
    "archived",
    "inputs"
  ],
  "properties": {
    "inputs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PropertyName"
      }
    },
    "archived": {
      "type": "boolean"
    }
  }
}

object BatchReadInputSimplePublicObjectId

{
  "type": "object",
  "required": [
    "inputs",
    "properties",
    "propertiesWithHistory"
  ],
  "properties": {
    "inputs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SimplePublicObjectId"
      }
    },
    "idProperty": {
      "type": "string"
    },
    "properties": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "propertiesWithHistory": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

object BatchResponseProperty

{
  "type": "object",
  "required": [
    "completedAt",
    "results",
    "startedAt",
    "status"
  ],
  "properties": {
    "links": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "status": {
      "enum": [
        "PENDING",
        "PROCESSING",
        "CANCELED",
        "COMPLETE"
      ],
      "type": "string"
    },
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Property"
      }
    },
    "startedAt": {
      "type": "string",
      "format": "date-time"
    },
    "completedAt": {
      "type": "string",
      "format": "date-time"
    },
    "requestedAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}

object BatchResponsePropertyWithErrors

{
  "type": "object",
  "required": [
    "completedAt",
    "results",
    "startedAt",
    "status"
  ],
  "properties": {
    "links": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StandardError"
      }
    },
    "status": {
      "enum": [
        "PENDING",
        "PROCESSING",
        "CANCELED",
        "COMPLETE"
      ],
      "type": "string"
    },
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Property"
      }
    },
    "numErrors": {
      "type": "integer",
      "format": "int32"
    },
    "startedAt": {
      "type": "string",
      "format": "date-time"
    },
    "completedAt": {
      "type": "string",
      "format": "date-time"
    },
    "requestedAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}

object BatchResponseSimplePublicObject

{
  "type": "object",
  "required": [
    "completedAt",
    "results",
    "startedAt",
    "status"
  ],
  "properties": {
    "links": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "status": {
      "enum": [
        "PENDING",
        "PROCESSING",
        "CANCELED",
        "COMPLETE"
      ],
      "type": "string"
    },
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SimplePublicObject"
      }
    },
    "startedAt": {
      "type": "string",
      "format": "date-time"
    },
    "completedAt": {
      "type": "string",
      "format": "date-time"
    },
    "requestedAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}

object BatchResponseSimplePublicObjectWithErrors

{
  "type": "object",
  "required": [
    "completedAt",
    "results",
    "startedAt",
    "status"
  ],
  "properties": {
    "links": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StandardError"
      }
    },
    "status": {
      "enum": [
        "PENDING",
        "PROCESSING",
        "CANCELED",
        "COMPLETE"
      ],
      "type": "string"
    },
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SimplePublicObject"
      }
    },
    "numErrors": {
      "type": "integer",
      "format": "int32"
    },
    "startedAt": {
      "type": "string",
      "format": "date-time"
    },
    "completedAt": {
      "type": "string",
      "format": "date-time"
    },
    "requestedAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}

object BatchResponseTimelineEventResponse

{
  "type": "object",
  "example": {
    "status": "COMPLETE",
    "results": [
      {
        "id": "petspot:1001298:art3mis-pup@petspot.com-6edaa73d-d734-404d-908f-74774d58ac2bX",
        "email": "art3mis-pup@petspot.com",
        "tokens": {
          "petAge": "3",
          "petName": "Art3mis",
          "petColor": "black"
        },
        "objectId": "28001",
        "extraData": {
          "questions": [
            {
              "answer": "Bark!",
              "question": "Who's a good girl?"
            },
            {
              "answer": "Woof!",
              "question": "Do you wanna go on a walk?"
            }
          ]
        },
        "timestamp": "2020-01-30T18:13:25.665Z",
        "objectType": "contacts",
        "timelineIFrame": {
          "url": "https://my.petspot.com/pets/Art3mis",
          "width": 600,
          "height": 400,
          "linkLabel": "View Art3mis",
          "headerLabel": "Art3mis dog"
        },
        "eventTemplateId": "1001298"
      },
      {
        "id": "petspot:1001298:pocket-tiger@petspot.com-0df6277b-6eba-4d1f-8c19-1994cbfaa4caX",
        "email": "pocket-tiger@petspot.com",
        "tokens": {
          "petAge": "3",
          "petName": "Pocket",
          "petColor": "yellow"
        },
        "objectId": "28651",
        "extraData": {
          "questions": [
            {
              "answer": "Purr...",
              "question": "Who's a good kitty?"
            },
            {
              "answer": "Meow!",
              "question": "Will you stop playing with that?"
            }
          ]
        },
        "timestamp": "2020-01-30T18:13:25.665Z",
        "objectType": "contacts",
        "timelineIFrame": {
          "url": "https://my.petspot.com/pets/Pocket",
          "width": 600,
          "height": 400,
          "linkLabel": "View Pocket",
          "headerLabel": "Pocket Tiger"
        },
        "eventTemplateId": "1001298"
      }
    ],
    "startedAt": "2020-01-30T18:13:24.974023Z",
    "completedAt": "2020-01-30T18:13:26.227559Z"
  },
  "required": [
    "completedAt",
    "results",
    "startedAt",
    "status"
  ],
  "properties": {
    "links": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "status": {
      "enum": [
        "PENDING",
        "PROCESSING",
        "CANCELED",
        "COMPLETE"
      ],
      "type": "string",
      "example": "COMPLETE",
      "description": "The status of the batch response. Should always be COMPLETED if processed."
    },
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TimelineEventResponse"
      },
      "example": [
        {
          "id": "petspot:1001298:art3mis-pup@petspot.com-6edaa73d-d734-404d-908f-74774d58ac2b",
          "email": "art3mis-pup@petspot.com",
          "tokens": {
            "petAge": "3",
            "petName": "Art3mis",
            "petColor": "black"
          },
          "objectId": "28001",
          "extraData": {
            "questions": [
              {
                "answer": "Bark!",
                "question": "Who's a good girl?"
              },
              {
                "answer": "Woof!",
                "question": "Do you wanna go on a walk?"
              }
            ]
          },
          "timestamp": "2020-01-30T18:13:25.665Z",
          "objectType": "contacts",
          "timelineIFrame": {
            "url": "https://my.petspot.com/pets/Art3mis",
            "width": 600,
            "height": 400,
            "linkLabel": "View Art3mis",
            "headerLabel": "Art3mis dog"
          },
          "eventTemplateId": "1001298"
        },
        {
          "id": "petspot:1001298:pocket-tiger@petspot.com-0df6277b-6eba-4d1f-8c19-1994cbfaa4ca",
          "email": "pocket-tiger@petspot.com",
          "tokens": {
            "petAge": "3",
            "petName": "Pocket",
            "petColor": "yellow"
          },
          "objectId": "28651",
          "extraData": {
            "questions": [
              {
                "answer": "Purr...",
                "question": "Who's a good kitty?"
              },
              {
                "answer": "Meow!",
                "question": "Will you stop playing with that?"
              }
            ]
          },
          "timestamp": "2020-01-30T18:13:25.665Z",
          "objectType": "contacts",
          "timelineIFrame": {
            "url": "https://my.petspot.com/pets/Pocket",
            "width": 600,
            "height": 400,
            "linkLabel": "View Pocket",
            "headerLabel": "Pocket Tiger"
          },
          "eventTemplateId": "1001298"
        }
      ],
      "description": "Successfully created events."
    },
    "startedAt": {
      "type": "string",
      "format": "date-time",
      "description": "The time the request began processing."
    },
    "completedAt": {
      "type": "string",
      "format": "date-time",
      "description": "The time the request was completed."
    },
    "requestedAt": {
      "type": "string",
      "format": "date-time",
      "description": "The time the request occurred."
    }
  },
  "description": "The state of the batch event request."
}

object BatchResponseTimelineEventResponseWithErrors

{
  "type": "object",
  "required": [
    "completedAt",
    "results",
    "startedAt",
    "status"
  ],
  "properties": {
    "links": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StandardError"
      }
    },
    "status": {
      "enum": [
        "PENDING",
        "PROCESSING",
        "CANCELED",
        "COMPLETE"
      ],
      "type": "string"
    },
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TimelineEventResponse"
      }
    },
    "numErrors": {
      "type": "integer",
      "format": "int32"
    },
    "startedAt": {
      "type": "string",
      "format": "date-time"
    },
    "completedAt": {
      "type": "string",
      "format": "date-time"
    },
    "requestedAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}

object CollectionResponseAssociatedId

{
  "type": "object",
  "required": [
    "results"
  ],
  "properties": {
    "paging": {
      "$ref": "#/components/schemas/Paging"
    },
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AssociatedId"
      }
    }
  }
}

object CollectionResponseObjectSchemaNoPaging

{
  "type": "object",
  "required": [
    "results"
  ],
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ObjectSchema"
      }
    }
  }
}

object CollectionResponsePipelineNoPaging

{
  "type": "object",
  "required": [
    "results"
  ],
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Pipeline"
      }
    }
  }
}

object CollectionResponsePipelineStageNoPaging

{
  "type": "object",
  "required": [
    "results"
  ],
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PipelineStage"
      }
    }
  }
}

object CollectionResponsePropertyGroupNoPaging

{
  "type": "object",
  "required": [
    "results"
  ],
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PropertyGroup"
      }
    }
  }
}

object CollectionResponsePropertyNoPaging

{
  "type": "object",
  "required": [
    "results"
  ],
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Property"
      }
    }
  }
}

object CollectionResponsePublicAuditInfoNoPaging

{
  "type": "object",
  "required": [
    "results"
  ],
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PublicAuditInfo"
      }
    }
  }
}

object CollectionResponsePublicImportErrorForwardPaging

{
  "type": "object",
  "required": [
    "results"
  ],
  "properties": {
    "paging": {
      "$ref": "#/components/schemas/ForwardPaging"
    },
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PublicImportError"
      }
    }
  }
}

object CollectionResponsePublicImportResponse

{
  "type": "object",
  "required": [
    "results"
  ],
  "properties": {
    "paging": {
      "$ref": "#/components/schemas/Paging"
    },
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PublicImportResponse"
      }
    }
  }
}

object CollectionResponsePublicOwnerForwardPaging

{
  "type": "object",
  "required": [
    "results"
  ],
  "properties": {
    "paging": {
      "$ref": "#/components/schemas/ForwardPaging"
    },
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PublicOwner"
      }
    }
  }
}

object CollectionResponseSimplePublicObjectWithAssociationsForwardPaging

{
  "type": "object",
  "required": [
    "results"
  ],
  "properties": {
    "paging": {
      "$ref": "#/components/schemas/ForwardPaging"
    },
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SimplePublicObjectWithAssociations"
      }
    }
  }
}

object CollectionResponseTimelineEventTemplateNoPaging

{
  "type": "object",
  "required": [
    "results"
  ],
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TimelineEventTemplate"
      }
    }
  }
}

object CollectionResponseWithTotalSimplePublicObjectForwardPaging

{
  "type": "object",
  "required": [
    "results",
    "total"
  ],
  "properties": {
    "total": {
      "type": "integer",
      "format": "int32"
    },
    "paging": {
      "$ref": "#/components/schemas/ForwardPaging"
    },
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SimplePublicObject"
      }
    }
  }
}

object CoreStartImportRequest

{
  "type": "object",
  "properties": {
    "files": {
      "type": "string",
      "format": "binary",
      "description": "A list of files containing the data to import"
    },
    "importRequest": {
      "type": "string",
      "description": "JSON formatted metadata about the import. This includes a name for the import and the column mappings for each file. See the overview tab for more on the required format."
    }
  }
}

object Error

{
  "type": "object",
  "example": {
    "links": {
      "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
    },
    "message": "Invalid input (details will vary based on the error)",
    "category": "VALIDATION_ERROR",
    "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf"
  },
  "required": [
    "category",
    "correlationId",
    "message"
  ],
  "properties": {
    "links": {
      "type": "object",
      "example": {
        "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
      },
      "description": "A map of link names to associated URIs containing documentation about the error or recommended remediation steps",
      "additionalProperties": {
        "type": "string"
      }
    },
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ErrorDetail"
      },
      "description": "further information about the error"
    },
    "context": {
      "type": "object",
      "example": {
        "missingScopes": [
          "scope1",
          "scope2"
        ],
        "invalidPropertyName": [
          "propertyValue"
        ]
      },
      "description": "Context about the error condition",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    "message": {
      "type": "string",
      "example": "Invalid input (details will vary based on the error)",
      "description": "A human readable message describing the error along with remediation steps where appropriate"
    },
    "category": {
      "type": "string",
      "example": "VALIDATION_ERROR",
      "description": "The error category"
    },
    "subCategory": {
      "type": "string",
      "description": "A specific category that contains more specific detail about the error"
    },
    "correlationId": {
      "type": "string",
      "format": "uuid",
      "example": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
      "description": "A unique identifier for the request. Include this value with any error reports or support tickets"
    }
  }
}

object ErrorDetail

{
  "type": "object",
  "required": [
    "message"
  ],
  "properties": {
    "in": {
      "type": "string",
      "description": "The name of the field or parameter in which the error was found."
    },
    "code": {
      "type": "string",
      "description": "The status code associated with the error detail"
    },
    "context": {
      "type": "object",
      "example": {
        "missingScopes": [
          "scope1",
          "scope2"
        ]
      },
      "description": "Context about the error condition",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    "message": {
      "type": "string",
      "description": "A human readable message describing the error along with remediation steps where appropriate"
    },
    "subCategory": {
      "type": "string",
      "description": "A specific category that contains more specific detail about the error"
    }
  }
}

object EventDetail

{
  "type": "object",
  "example": {
    "details": "<p>Registration occurred at Jan 30, 2020, 1:13:25 PM</p><h4>Questions</h4><p><strong>Who&#x27;s a good kitty?</strong>: Purr...</p><p><strong>Will you stop playing with that?</strong>: Meow!</p><p>EDIT</p>"
  },
  "required": [
    "details"
  ],
  "properties": {
    "details": {
      "type": "string",
      "example": "<p>Registration occurred at Jan 30, 2020, 1:13:25 PM</p><h4>Questions</h4><p><strong>Who&#x27;s a good kitty?</strong>: Purr...</p><p><strong>Will you stop playing with that?</strong>: Meow!</p><p>EDIT</p>",
      "description": "The details Markdown rendered as HTML."
    }
  },
  "description": "The details Markdown rendered as HTML."
}

object EventsCreateMultipleBatchResponse

{
  "type": "object",
  "example": {
    "status": "COMPLETE",
    "results": [
      {
        "id": "petspot:1001298:art3mis-pup@petspot.com-b9d73144-41bb-46c8-9a3f-f0849c1ad7e6",
        "email": "art3mis-pup@petspot.com",
        "tokens": {
          "petAge": "3",
          "petName": "Art3mis",
          "petColor": "black"
        },
        "objectId": "28001",
        "extraData": {
          "questions": [
            {
              "answer": "Bark!",
              "question": "Who's a good girl?"
            },
            {
              "answer": "Woof!",
              "question": "Do you wanna go on a walk?"
            }
          ]
        },
        "timestamp": "2020-01-30T18:10:17.057Z",
        "objectType": "contacts",
        "timelineIFrame": {
          "url": "https://my.petspot.com/pets/Art3mis",
          "width": 600,
          "height": 400,
          "linkLabel": "View Art3mis",
          "headerLabel": "Art3mis dog"
        },
        "eventTemplateId": "1001298"
      },
      {
        "id": "petspot:1001298:pocket-tiger@petspot.com-c09a620f-60a4-46a8-be9f-fe0609fc3f0e",
        "email": "pocket-tiger@petspot.com",
        "tokens": {
          "petAge": "3",
          "petName": "Pocket",
          "petColor": "yellow"
        },
        "objectId": "28651",
        "extraData": {
          "questions": [
            {
              "answer": "Purr...",
              "question": "Who's a good kitty?"
            },
            {
              "answer": "Meow!",
              "question": "Will you stop playing with that?"
            }
          ]
        },
        "timestamp": "2020-01-30T18:10:17.057Z",
        "objectType": "contacts",
        "timelineIFrame": {
          "url": "https://my.petspot.com/pets/Pocket",
          "width": 600,
          "height": 400,
          "linkLabel": "View Pocket",
          "headerLabel": "Pocket Tiger"
        },
        "eventTemplateId": "1001298"
      }
    ],
    "startedAt": "2020-01-30T18:10:16.478734Z",
    "completedAt": "2020-01-30T18:10:17.793206Z"
  },
  "properties": {
    "status": {
      "type": "string",
      "example": "COMPLETE"
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "petspot:1001298:art3mis-pup@petspot.com-b9d73144-41bb-46c8-9a3f-f0849c1ad7e6"
          },
          "email": {
            "type": "string",
            "example": "art3mis-pup@petspot.com"
          },
          "tokens": {
            "type": "object",
            "properties": {
              "petAge": {
                "type": "string",
                "example": "3"
              },
              "petName": {
                "type": "string",
                "example": "Art3mis"
              },
              "petColor": {
                "type": "string",
                "example": "black"
              }
            }
          },
          "objectId": {
            "type": "string",
            "example": "28001"
          },
          "extraData": {
            "type": "object",
            "properties": {
              "questions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "answer": {
                      "type": "string",
                      "example": "Bark!"
                    },
                    "question": {
                      "type": "string",
                      "example": "Who's a good girl?"
                    }
                  }
                }
              }
            }
          },
          "timestamp": {
            "type": "string",
            "example": "2020-01-30T18:10:17.057Z"
          },
          "objectType": {
            "type": "string",
            "example": "contacts"
          },
          "timelineIFrame": {
            "type": "object",
            "properties": {
              "url": {
                "type": "string",
                "example": "https://my.petspot.com/pets/Art3mis"
              },
              "width": {
                "type": "number",
                "example": 600
              },
              "height": {
                "type": "number",
                "example": 400
              },
              "linkLabel": {
                "type": "string",
                "example": "View Art3mis"
              },
              "headerLabel": {
                "type": "string",
                "example": "Art3mis dog"
              }
            }
          },
          "eventTemplateId": {
            "type": "string",
            "example": "1001298"
          }
        }
      }
    },
    "startedAt": {
      "type": "string",
      "example": "2020-01-30T18:10:16.478734Z"
    },
    "completedAt": {
      "type": "string",
      "example": "2020-01-30T18:10:17.793206Z"
    }
  }
}

string EventsRenderingHtmlResponse

{
  "type": "string"
}

object ExternalSettings

{
  "type": "object",
  "example": {
    "userVerifyUrl": "https://example.com/user-verify",
    "createMeetingUrl": "https://example.com/create-meeting",
    "deleteMeetingUrl": "https://example.com/delete-meeting",
    "updateMeetingUrl": "https://example.com/update-meeting"
  },
  "required": [
    "createMeetingUrl"
  ],
  "properties": {
    "userVerifyUrl": {
      "type": "string",
      "example": "https://example.com/user-verify",
      "description": "The URL that HubSpot will use to verify that a user exists in the video conference application."
    },
    "createMeetingUrl": {
      "type": "string",
      "example": "https://example.com/create-meeting",
      "description": "The URL that HubSpot will send requests to create a new video conference."
    },
    "deleteMeetingUrl": {
      "type": "string",
      "example": "https://example.com/delete-meeting",
      "description": "The URL that HubSpot will send notifications of meetings that have been deleted in HubSpot."
    },
    "fetchAccountsUri": {
      "type": "string"
    },
    "updateMeetingUrl": {
      "type": "string",
      "example": "https://example.com/update-meeting",
      "description": "The URL that HubSpot will send updates to existing meetings. Typically called when the user changes the topic or times of a meeting."
    }
  },
  "description": "The URLs of the various actions provided by the video conferencing application. All URLs must use the `https` protocol."
}

object Filter

{
  "type": "object",
  "required": [
    "operator",
    "propertyName"
  ],
  "properties": {
    "value": {
      "type": "string"
    },
    "values": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "operator": {
      "enum": [
        "EQ",
        "NEQ",
        "LT",
        "LTE",
        "GT",
        "GTE",
        "BETWEEN",
        "IN",
        "NOT_IN",
        "HAS_PROPERTY",
        "NOT_HAS_PROPERTY",
        "CONTAINS_TOKEN",
        "NOT_CONTAINS_TOKEN"
      ],
      "type": "string",
      "description": "null"
    },
    "highValue": {
      "type": "string"
    },
    "propertyName": {
      "type": "string"
    }
  }
}

object FilterGroup

{
  "type": "object",
  "required": [
    "filters"
  ],
  "properties": {
    "filters": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Filter"
      }
    }
  }
}

object ForwardPaging

{
  "type": "object",
  "properties": {
    "next": {
      "$ref": "#/components/schemas/NextPage"
    }
  }
}

object ImportRowCore

{
  "type": "object",
  "required": [
    "fileId",
    "lineNumber",
    "rowData"
  ],
  "properties": {
    "fileId": {
      "type": "integer",
      "format": "int32"
    },
    "rowData": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "pageName": {
      "type": "string"
    },
    "lineNumber": {
      "type": "integer",
      "format": "int32"
    }
  }
}

object ImportTemplate

{
  "type": "object",
  "required": [
    "templateId",
    "templateType"
  ],
  "properties": {
    "templateId": {
      "type": "integer",
      "format": "int32"
    },
    "templateType": {
      "enum": [
        "admin_defined",
        "previous_import",
        "user_file"
      ],
      "type": "string"
    }
  }
}

object NextPage

{
  "type": "object",
  "example": {
    "link": "?after=NTI1Cg%3D%3D",
    "after": "NTI1Cg%3D%3D"
  },
  "required": [
    "after"
  ],
  "properties": {
    "link": {
      "type": "string",
      "example": "?after=NTI1Cg%3D%3D"
    },
    "after": {
      "type": "string",
      "example": "NTI1Cg%3D%3D"
    }
  }
}

object ObjectSchema

{
  "type": "object",
  "example": {
    "id": "123456X",
    "name": "my_object",
    "labels": {
      "plural": "My objects",
      "singular": "My object"
    },
    "metaType": "PORTAL_SPECIFIC",
    "createdAt": "2020-02-20T18:07:11.390Z",
    "updatedAt": "2020-02-20T18:09:07.555Z",
    "properties": [
      {
        "name": "my_object_property",
        "type": "string",
        "label": "My object property",
        "archived": false,
        "createdAt": "2020-02-20T18:07:11.802Z",
        "fieldType": "text",
        "groupName": "my_object_information",
        "updatedAt": "2020-02-20T18:07:11.802Z",
        "calculated": false,
        "displayOrder": -1,
        "hasUniqueValue": false,
        "externalOptions": false
      }
    ],
    "associations": [
      {
        "id": "123X",
        "name": "my_object_to_contact",
        "toObjectTypeId": "0-1",
        "fromObjectTypeId": "2-123456"
      }
    ],
    "fullyQualifiedName": "p7878787_my_object\"",
    "requiredProperties": [
      "my_object_property"
    ],
    "searchableProperties": [
      "my_object_property"
    ],
    "primaryDisplayProperty": "my_object_property"
  },
  "required": [
    "associations",
    "id",
    "labels",
    "name",
    "properties",
    "requiredProperties"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "123456",
      "description": "A unique ID for this schema's object type. Will be defined as {meta-type}-{unique ID}."
    },
    "name": {
      "type": "string",
      "example": "my_object",
      "description": "A unique name for the schema's object type."
    },
    "labels": {
      "$ref": "#/components/schemas/ObjectTypeDefinitionLabels"
    },
    "archived": {
      "type": "boolean"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the object schema was created."
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the object schema was last updated."
    },
    "properties": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Property"
      },
      "example": [
        {
          "name": "my_object_property",
          "type": "string",
          "label": "My object property",
          "archived": false,
          "createdAt": "2020-02-20T18:07:11.802Z",
          "fieldType": "text",
          "groupName": "my_object_information",
          "updatedAt": "2020-02-20T18:07:11.802Z",
          "calculated": false,
          "displayOrder": -1,
          "hasUniqueValue": false,
          "externalOptions": false
        }
      ],
      "description": "Properties defined for this object type."
    },
    "description": {
      "type": "string"
    },
    "associations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AssociationDefinition"
      },
      "example": [
        {
          "id": "123",
          "name": "my_object_to_contact",
          "toObjectTypeId": "0-1",
          "fromObjectTypeId": "2-123456"
        }
      ],
      "description": "Associations defined for a given object type."
    },
    "objectTypeId": {
      "type": "string"
    },
    "fullyQualifiedName": {
      "type": "string",
      "example": "p7878787_my_object\"",
      "description": "An assigned unique ID for the object, including portal ID and object name."
    },
    "requiredProperties": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "my_object_property"
      ],
      "description": "The names of properties that should be **required** when creating an object of this type."
    },
    "searchableProperties": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "my_object_property"
      ],
      "description": "Names of properties that will be indexed for this object type in by HubSpot's product search."
    },
    "primaryDisplayProperty": {
      "type": "string",
      "example": "my_object_property",
      "description": "The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type."
    },
    "secondaryDisplayProperties": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type."
    }
  },
  "description": "Defines an object schema, including its properties and associations."
}

object ObjectSchemaEgg

{
  "type": "object",
  "example": {
    "name": "my_object",
    "labels": {
      "plural": "My objects",
      "singular": "My object"
    },
    "metaType": "PORTAL_SPECIFIC",
    "properties": [
      {
        "name": "my_object_property",
        "label": "My object property",
        "isPrimaryDisplayLabel": true
      }
    ],
    "associatedObjects": [
      "CONTACT"
    ],
    "requiredProperties": [
      "my_object_property"
    ],
    "primaryDisplayProperty": "my_object_property"
  },
  "required": [
    "associatedObjects",
    "labels",
    "name",
    "properties",
    "requiredProperties"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "my_object",
      "description": "A unique name for this object. For internal use only."
    },
    "labels": {
      "$ref": "#/components/schemas/ObjectTypeDefinitionLabels"
    },
    "properties": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ObjectTypePropertyCreate"
      },
      "example": [
        {
          "name": "my_object_property",
          "label": "My object property",
          "isPrimaryDisplayLabel": true
        }
      ],
      "description": "Properties defined for this object type."
    },
    "description": {
      "type": "string"
    },
    "associatedObjects": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "CONTACT"
      ],
      "description": "Associations defined for this object type."
    },
    "requiredProperties": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "my_object_property"
      ],
      "description": "The names of properties that should be **required** when creating an object of this type."
    },
    "searchableProperties": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Names of properties that will be indexed for this object type in by HubSpot's product search."
    },
    "primaryDisplayProperty": {
      "type": "string",
      "example": "my_object_property",
      "description": "The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type."
    },
    "secondaryDisplayProperties": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type."
    }
  },
  "description": "Defines a new object type, its properties, and associations."
}

object ObjectTypeDefinition

{
  "type": "object",
  "example": {
    "id": "123456",
    "name": "my_object",
    "labels": {
      "plural": "My objects",
      "singular": "My object"
    },
    "metaType": "PORTAL_SPECIFIC",
    "portalId": 12345678,
    "createdAt": "2020-02-20T18:07:11.390Z",
    "updatedAt": "2020-02-21T14:13:28.818002Z",
    "requiredProperties": [
      "my_object_property"
    ],
    "searchableProperties": [
      "my_object_property"
    ],
    "primaryDisplayProperty": "my_object_property"
  },
  "required": [
    "id",
    "labels",
    "name",
    "requiredProperties"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "123456",
      "description": "A unique ID for this object type. Will be defined as {meta-type}-{unique ID}."
    },
    "name": {
      "type": "string",
      "example": "my_object",
      "description": "A unique name for this object. For internal use only."
    },
    "labels": {
      "$ref": "#/components/schemas/ObjectTypeDefinitionLabels"
    },
    "archived": {
      "type": "boolean"
    },
    "portalId": {
      "type": "integer",
      "format": "int32",
      "example": 12345678,
      "description": "The ID of the account that this object type is specific to."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the object type was created."
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the object type was last updated."
    },
    "description": {
      "type": "string"
    },
    "objectTypeId": {
      "type": "string"
    },
    "fullyQualifiedName": {
      "type": "string"
    },
    "requiredProperties": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "my_object_property"
      ],
      "description": "The names of properties that should be **required** when creating an object of this type."
    },
    "searchableProperties": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "my_object_property"
      ],
      "description": "Names of properties that will be indexed for this object type in by HubSpot's product search."
    },
    "primaryDisplayProperty": {
      "type": "string",
      "example": "my_object_property",
      "description": "The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type."
    },
    "secondaryDisplayProperties": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type."
    }
  },
  "description": "Defines an object type."
}

object ObjectTypeDefinitionLabels

{
  "type": "object",
  "example": {
    "plural": "My objects",
    "singular": "My object"
  },
  "properties": {
    "plural": {
      "type": "string",
      "example": "My objects",
      "description": "The word for multiple objects. (There’s no way to change this later.)"
    },
    "singular": {
      "type": "string",
      "example": "My object",
      "description": "The word for one object. (There’s no way to change this later.)"
    }
  },
  "description": "Singular and plural labels for the object. Used in CRM display."
}

object ObjectTypeDefinitionPatch

{
  "type": "object",
  "example": {
    "requiredProperties": [
      "my_object_property"
    ],
    "searchableProperties": [
      "my_object_property"
    ],
    "primaryDisplayProperty": "my_object_property"
  },
  "properties": {
    "labels": {
      "$ref": "#/components/schemas/ObjectTypeDefinitionLabels"
    },
    "restorable": {
      "type": "boolean"
    },
    "description": {
      "type": "string"
    },
    "requiredProperties": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "my_object_property"
      ],
      "description": "The names of properties that should be **required** when creating an object of this type."
    },
    "searchableProperties": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "my_object_property"
      ],
      "description": "Names of properties that will be indexed for this object type in by HubSpot's product search."
    },
    "primaryDisplayProperty": {
      "type": "string",
      "example": "my_object_property",
      "description": "The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type."
    },
    "secondaryDisplayProperties": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type."
    }
  },
  "description": "Defines attributes to update on an object type."
}

Load more schemas