{ "openapi" : "3.0.1", "info" : { "title" : "CRM Forecasts", "description" : "Basepom for all HubSpot Projects", "version" : "2026-09-beta", "x-hubspot-product-tier-requirements" : { "marketing" : "FREE", "sales" : "PROFESSIONAL", "service" : "PROFESSIONAL", "cms" : "FREE", "commerce" : "FREE", "crmHub" : "FREE", "dataHub" : "FREE" } }, "servers" : [ { "url" : "https://api.hubapi.com" } ], "tags" : [ { "name" : "Basic" }, { "name" : "Batch" }, { "name" : "Search" } ], "paths" : { "/crm/objects/2026-09-beta/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}" : { "put" : { "tags" : [ "Batch" ], "operationId" : "put-/crm/objects/2026-09-beta/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}_/crm/objects/2026-09-beta/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}", "parameters" : [ { "name" : "fromObjectId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "fromObjectType", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "toObjectId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "toObjectType", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponsePublicDefaultAssociation" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "oauth" ] }, { "oauth2" : [ "crm.objects.deals.read" ] }, { "oauth2" : [ "crm.objects.subscriptions.read" ] }, { "oauth2" : [ "crm.objects.services.read" ] }, { "oauth2" : [ "crm.objects.orders.read" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.custom.read" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.tasks.read" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.read" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] }, { "oauth2" : [ "media_bridge.read" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.invoices.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.users.write" ] }, { "oauth2" : [ "crm.objects.calls.read" ] }, { "oauth2" : [ "crm.objects.meetings.read" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.users.read" ] }, { "oauth2" : [ "crm.objects.partner-services.read" ] }, { "oauth2" : [ "crm.objects.orders.write" ] }, { "oauth2" : [ "crm.objects.partner-services.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.carts.write" ] }, { "oauth2" : [ "tickets" ] }, { "oauth2" : [ "crm.objects.commercepayments.read" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.subscriptions.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.contacts.read" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.invoices.read" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.custom.write" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "e-commerce" ] }, { "oauth2" : [ "crm.objects.appointments.read" ] }, { "oauth2" : [ "crm.objects.projects.read" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.read" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.goals.read" ] }, { "oauth2" : [ "crm.objects.line_items.read" ] }, { "oauth2" : [ "crm.objects.partner-clients.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.quotes.write" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.leads.read" ] }, { "oauth2" : [ "crm.objects.leads.write" ] }, { "oauth2" : [ "crm.objects.carts.read" ] }, { "oauth2" : [ "crm.objects.emails.read" ] }, { "oauth2" : [ "crm.objects.quotes.read" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.partner-clients.read" ] }, { "oauth2" : [ "crm.objects.notes.read" ] }, { "oauth2" : [ "crm.objects.courses.read" ] }, { "oauth2" : [ "crm.objects.listings.read" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.products.read" ] } ] } }, "/crm/objects/2026-09-beta/{objectType}" : { "get" : { "tags" : [ "Basic" ], "summary" : "Retrieve forecasts", "description" : "Retrieve all forecasts.", "operationId" : "get-/crm/objects/2026-09-beta/{objectType}_/crm/objects/2026-09-beta/{objectType}", "parameters" : [ { "name" : "objectType", "in" : "path", "description" : "The type of CRM object to retrieve.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "after", "in" : "query", "description" : "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.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "archived", "in" : "query", "description" : "Whether to return only results that have been archived.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean", "example" : null, "default" : false } }, { "name" : "associations", "in" : "query", "description" : "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.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } } }, { "name" : "limit", "in" : "query", "description" : "The maximum number of results to display per page.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : null, "default" : 10 } }, { "name" : "properties", "in" : "query", "description" : "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.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } } }, { "name" : "propertiesWithHistory", "in" : "query", "description" : "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.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CollectionResponseSimplePublicObjectWithAssociationsForwardPaging" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "oauth" ] }, { "oauth2" : [ "crm.objects.deals.read" ] }, { "oauth2" : [ "crm.objects.subscriptions.read" ] }, { "oauth2" : [ "crm.objects.services.read" ] }, { "oauth2" : [ "crm.objects.orders.read" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.custom.read" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.tasks.read" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.read" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] }, { "oauth2" : [ "media_bridge.read" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.invoices.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.users.write" ] }, { "oauth2" : [ "crm.objects.calls.read" ] }, { "oauth2" : [ "crm.objects.meetings.read" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.users.read" ] }, { "oauth2" : [ "crm.objects.partner-services.read" ] }, { "oauth2" : [ "crm.objects.orders.write" ] }, { "oauth2" : [ "crm.objects.partner-services.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.carts.write" ] }, { "oauth2" : [ "tickets" ] }, { "oauth2" : [ "crm.objects.commercepayments.read" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.subscriptions.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.contacts.read" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.invoices.read" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.custom.write" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "e-commerce" ] }, { "oauth2" : [ "crm.objects.appointments.read" ] }, { "oauth2" : [ "crm.objects.projects.read" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.read" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.goals.read" ] }, { "oauth2" : [ "crm.objects.line_items.read" ] }, { "oauth2" : [ "crm.objects.partner-clients.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.quotes.write" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.leads.read" ] }, { "oauth2" : [ "crm.objects.leads.write" ] }, { "oauth2" : [ "crm.objects.carts.read" ] }, { "oauth2" : [ "crm.objects.emails.read" ] }, { "oauth2" : [ "crm.objects.quotes.read" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.partner-clients.read" ] }, { "oauth2" : [ "crm.objects.notes.read" ] }, { "oauth2" : [ "crm.objects.courses.read" ] }, { "oauth2" : [ "crm.objects.listings.read" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.products.read" ] } ] }, "post" : { "tags" : [ "Basic" ], "summary" : "", "operationId" : "post-/crm/objects/2026-09-beta/{objectType}_/crm/objects/2026-09-beta/{objectType}", "parameters" : [ { "name" : "objectType", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SimplePublicObjectInputForCreate" }, "example" : null } }, "required" : true }, "responses" : { "201" : { "description" : "successful operation", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SimplePublicObject" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "oauth" ] }, { "oauth2" : [ "crm.objects.deals.read" ] }, { "oauth2" : [ "crm.objects.subscriptions.read" ] }, { "oauth2" : [ "crm.objects.services.read" ] }, { "oauth2" : [ "crm.objects.orders.read" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.custom.read" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.tasks.read" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.read" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] }, { "oauth2" : [ "media_bridge.read" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.invoices.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.users.write" ] }, { "oauth2" : [ "crm.objects.calls.read" ] }, { "oauth2" : [ "crm.objects.meetings.read" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.users.read" ] }, { "oauth2" : [ "crm.objects.partner-services.read" ] }, { "oauth2" : [ "crm.objects.orders.write" ] }, { "oauth2" : [ "crm.objects.partner-services.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.carts.write" ] }, { "oauth2" : [ "tickets" ] }, { "oauth2" : [ "crm.objects.commercepayments.read" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.subscriptions.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.contacts.read" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.invoices.read" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.custom.write" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "e-commerce" ] }, { "oauth2" : [ "crm.objects.appointments.read" ] }, { "oauth2" : [ "crm.objects.projects.read" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.read" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.goals.read" ] }, { "oauth2" : [ "crm.objects.line_items.read" ] }, { "oauth2" : [ "crm.objects.partner-clients.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.quotes.write" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.leads.read" ] }, { "oauth2" : [ "crm.objects.leads.write" ] }, { "oauth2" : [ "crm.objects.carts.read" ] }, { "oauth2" : [ "crm.objects.emails.read" ] }, { "oauth2" : [ "crm.objects.quotes.read" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.partner-clients.read" ] }, { "oauth2" : [ "crm.objects.notes.read" ] }, { "oauth2" : [ "crm.objects.courses.read" ] }, { "oauth2" : [ "crm.objects.listings.read" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.products.read" ] } ] } }, "/crm/objects/2026-09-beta/{objectType}/batch/create" : { "post" : { "tags" : [ "Batch" ], "operationId" : "post-/crm/objects/2026-09-beta/{objectType}/batch/create_/crm/objects/2026-09-beta/{objectType}/batch/create", "parameters" : [ { "name" : "objectType", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInputForCreate" }, "example" : null } }, "required" : true }, "responses" : { "201" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" }, "example" : null } } }, "207" : { "description" : "multiple statuses", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "oauth" ] }, { "oauth2" : [ "crm.objects.deals.read" ] }, { "oauth2" : [ "crm.objects.subscriptions.read" ] }, { "oauth2" : [ "crm.objects.services.read" ] }, { "oauth2" : [ "crm.objects.orders.read" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.custom.read" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.tasks.read" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.read" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] }, { "oauth2" : [ "media_bridge.read" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.invoices.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.users.write" ] }, { "oauth2" : [ "crm.objects.calls.read" ] }, { "oauth2" : [ "crm.objects.meetings.read" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.users.read" ] }, { "oauth2" : [ "crm.objects.partner-services.read" ] }, { "oauth2" : [ "crm.objects.orders.write" ] }, { "oauth2" : [ "crm.objects.partner-services.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.carts.write" ] }, { "oauth2" : [ "tickets" ] }, { "oauth2" : [ "crm.objects.commercepayments.read" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.subscriptions.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.contacts.read" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.invoices.read" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.custom.write" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "e-commerce" ] }, { "oauth2" : [ "crm.objects.appointments.read" ] }, { "oauth2" : [ "crm.objects.projects.read" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.read" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.goals.read" ] }, { "oauth2" : [ "crm.objects.line_items.read" ] }, { "oauth2" : [ "crm.objects.partner-clients.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.quotes.write" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.leads.read" ] }, { "oauth2" : [ "crm.objects.leads.write" ] }, { "oauth2" : [ "crm.objects.carts.read" ] }, { "oauth2" : [ "crm.objects.emails.read" ] }, { "oauth2" : [ "crm.objects.quotes.read" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.partner-clients.read" ] }, { "oauth2" : [ "crm.objects.notes.read" ] }, { "oauth2" : [ "crm.objects.courses.read" ] }, { "oauth2" : [ "crm.objects.listings.read" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.products.read" ] } ] } }, "/crm/objects/2026-09-beta/{objectType}/batch/read" : { "post" : { "tags" : [ "Batch" ], "operationId" : "post-/crm/objects/2026-09-beta/{objectType}/batch/read_/crm/objects/2026-09-beta/{objectType}/batch/read", "parameters" : [ { "name" : "objectType", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "archived", "in" : "query", "description" : "Whether to return only results that have been archived.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean", "example" : null, "default" : false } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchReadInputSimplePublicObjectId" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" }, "example" : null } } }, "207" : { "description" : "multiple statuses", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "oauth" ] }, { "oauth2" : [ "crm.objects.deals.read" ] }, { "oauth2" : [ "crm.objects.subscriptions.read" ] }, { "oauth2" : [ "crm.objects.services.read" ] }, { "oauth2" : [ "crm.objects.orders.read" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.custom.read" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.tasks.read" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.read" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] }, { "oauth2" : [ "media_bridge.read" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.invoices.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.users.write" ] }, { "oauth2" : [ "crm.objects.calls.read" ] }, { "oauth2" : [ "crm.objects.meetings.read" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.users.read" ] }, { "oauth2" : [ "crm.objects.partner-services.read" ] }, { "oauth2" : [ "crm.objects.orders.write" ] }, { "oauth2" : [ "crm.objects.partner-services.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.carts.write" ] }, { "oauth2" : [ "tickets" ] }, { "oauth2" : [ "crm.objects.commercepayments.read" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.subscriptions.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.contacts.read" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.invoices.read" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.custom.write" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "e-commerce" ] }, { "oauth2" : [ "crm.objects.appointments.read" ] }, { "oauth2" : [ "crm.objects.projects.read" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.read" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.goals.read" ] }, { "oauth2" : [ "crm.objects.line_items.read" ] }, { "oauth2" : [ "crm.objects.partner-clients.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.quotes.write" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.leads.read" ] }, { "oauth2" : [ "crm.objects.leads.write" ] }, { "oauth2" : [ "crm.objects.carts.read" ] }, { "oauth2" : [ "crm.objects.emails.read" ] }, { "oauth2" : [ "crm.objects.quotes.read" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.partner-clients.read" ] }, { "oauth2" : [ "crm.objects.notes.read" ] }, { "oauth2" : [ "crm.objects.courses.read" ] }, { "oauth2" : [ "crm.objects.listings.read" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.products.read" ] } ] } }, "/crm/objects/2026-09-beta/{objectType}/batch/update" : { "post" : { "tags" : [ "Batch" ], "operationId" : "post-/crm/objects/2026-09-beta/{objectType}/batch/update_/crm/objects/2026-09-beta/{objectType}/batch/update", "parameters" : [ { "name" : "objectType", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchInputSimplePublicObjectBatchInput" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseSimplePublicObject" }, "example" : null } } }, "207" : { "description" : "multiple statuses", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BatchResponseSimplePublicObjectWithErrors" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "oauth" ] }, { "oauth2" : [ "crm.objects.deals.read" ] }, { "oauth2" : [ "crm.objects.subscriptions.read" ] }, { "oauth2" : [ "crm.objects.services.read" ] }, { "oauth2" : [ "crm.objects.orders.read" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.custom.read" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.tasks.read" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.read" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] }, { "oauth2" : [ "media_bridge.read" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.invoices.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.users.write" ] }, { "oauth2" : [ "crm.objects.calls.read" ] }, { "oauth2" : [ "crm.objects.meetings.read" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.users.read" ] }, { "oauth2" : [ "crm.objects.partner-services.read" ] }, { "oauth2" : [ "crm.objects.orders.write" ] }, { "oauth2" : [ "crm.objects.partner-services.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.carts.write" ] }, { "oauth2" : [ "tickets" ] }, { "oauth2" : [ "crm.objects.commercepayments.read" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.subscriptions.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.contacts.read" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.invoices.read" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.custom.write" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "e-commerce" ] }, { "oauth2" : [ "crm.objects.appointments.read" ] }, { "oauth2" : [ "crm.objects.projects.read" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.read" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.goals.read" ] }, { "oauth2" : [ "crm.objects.line_items.read" ] }, { "oauth2" : [ "crm.objects.partner-clients.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.quotes.write" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.leads.read" ] }, { "oauth2" : [ "crm.objects.leads.write" ] }, { "oauth2" : [ "crm.objects.carts.read" ] }, { "oauth2" : [ "crm.objects.emails.read" ] }, { "oauth2" : [ "crm.objects.quotes.read" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.partner-clients.read" ] }, { "oauth2" : [ "crm.objects.notes.read" ] }, { "oauth2" : [ "crm.objects.courses.read" ] }, { "oauth2" : [ "crm.objects.listings.read" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.products.read" ] } ] } }, "/crm/objects/2026-09-beta/{objectType}/search" : { "post" : { "tags" : [ "Search" ], "summary" : "Search for forecasts", "description" : "Search for existing forecasts in your HubSpot account. This endpoint allows you to filter and sort objects based on various criteria, providing a flexible way to retrieve specific data. It is useful for finding objects that match certain properties or conditions.", "operationId" : "post-/crm/objects/2026-09-beta/{objectType}/search_/crm/objects/2026-09-beta/{objectType}/search", "parameters" : [ { "name" : "objectType", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublicObjectSearchRequest" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CollectionResponseWithTotalSimplePublicObject" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "oauth" ] }, { "oauth2" : [ "crm.objects.deals.read" ] }, { "oauth2" : [ "crm.objects.subscriptions.read" ] }, { "oauth2" : [ "crm.objects.services.read" ] }, { "oauth2" : [ "crm.objects.orders.read" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.custom.read" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.tasks.read" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.read" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] }, { "oauth2" : [ "media_bridge.read" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.invoices.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.users.write" ] }, { "oauth2" : [ "crm.objects.calls.read" ] }, { "oauth2" : [ "crm.objects.meetings.read" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.users.read" ] }, { "oauth2" : [ "crm.objects.partner-services.read" ] }, { "oauth2" : [ "crm.objects.orders.write" ] }, { "oauth2" : [ "crm.objects.partner-services.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.carts.write" ] }, { "oauth2" : [ "tickets" ] }, { "oauth2" : [ "crm.objects.commercepayments.read" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.subscriptions.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.contacts.read" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.invoices.read" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.custom.write" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "e-commerce" ] }, { "oauth2" : [ "crm.objects.appointments.read" ] }, { "oauth2" : [ "crm.objects.projects.read" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.read" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.goals.read" ] }, { "oauth2" : [ "crm.objects.line_items.read" ] }, { "oauth2" : [ "crm.objects.partner-clients.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.quotes.write" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.leads.read" ] }, { "oauth2" : [ "crm.objects.leads.write" ] }, { "oauth2" : [ "crm.objects.carts.read" ] }, { "oauth2" : [ "crm.objects.emails.read" ] }, { "oauth2" : [ "crm.objects.quotes.read" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.partner-clients.read" ] }, { "oauth2" : [ "crm.objects.notes.read" ] }, { "oauth2" : [ "crm.objects.courses.read" ] }, { "oauth2" : [ "crm.objects.listings.read" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.products.read" ] } ], "x-hubspot-rate-limit-exemptions" : [ "ten-secondly" ] } }, "/crm/objects/2026-09-beta/{objectType}/{objectId}" : { "get" : { "tags" : [ "Basic" ], "summary" : "Retrieve a forecast", "description" : "Retrieve an individual forecast.", "operationId" : "get-/crm/objects/2026-09-beta/{objectType}/{objectId}_/crm/objects/2026-09-beta/{objectType}/{objectId}", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "The unique identifier of the object to read.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "objectType", "in" : "path", "description" : "The type of the object to retrieve (forecast).", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "archived", "in" : "query", "description" : "Whether to return only results that have been archived.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean", "example" : null, "default" : false } }, { "name" : "associations", "in" : "query", "description" : "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.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } } }, { "name" : "idProperty", "in" : "query", "description" : "The name of a property whose values are unique for this object type", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "properties", "in" : "query", "description" : "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.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } } }, { "name" : "propertiesWithHistory", "in" : "query", "description" : "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.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "oauth" ] }, { "oauth2" : [ "crm.objects.deals.read" ] }, { "oauth2" : [ "crm.objects.subscriptions.read" ] }, { "oauth2" : [ "crm.objects.services.read" ] }, { "oauth2" : [ "crm.objects.orders.read" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.custom.read" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.tasks.read" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.read" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] }, { "oauth2" : [ "media_bridge.read" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.invoices.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.users.write" ] }, { "oauth2" : [ "crm.objects.calls.read" ] }, { "oauth2" : [ "crm.objects.meetings.read" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.users.read" ] }, { "oauth2" : [ "crm.objects.partner-services.read" ] }, { "oauth2" : [ "crm.objects.orders.write" ] }, { "oauth2" : [ "crm.objects.partner-services.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.carts.write" ] }, { "oauth2" : [ "tickets" ] }, { "oauth2" : [ "crm.objects.commercepayments.read" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.subscriptions.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.contacts.read" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.invoices.read" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.custom.write" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "e-commerce" ] }, { "oauth2" : [ "crm.objects.appointments.read" ] }, { "oauth2" : [ "crm.objects.projects.read" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.read" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.goals.read" ] }, { "oauth2" : [ "crm.objects.line_items.read" ] }, { "oauth2" : [ "crm.objects.partner-clients.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.quotes.write" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.leads.read" ] }, { "oauth2" : [ "crm.objects.leads.write" ] }, { "oauth2" : [ "crm.objects.carts.read" ] }, { "oauth2" : [ "crm.objects.emails.read" ] }, { "oauth2" : [ "crm.objects.quotes.read" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.partner-clients.read" ] }, { "oauth2" : [ "crm.objects.notes.read" ] }, { "oauth2" : [ "crm.objects.courses.read" ] }, { "oauth2" : [ "crm.objects.listings.read" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.products.read" ] } ] }, "delete" : { "tags" : [ "Basic" ], "operationId" : "delete-/crm/objects/2026-09-beta/{objectType}/{objectId}_/crm/objects/2026-09-beta/{objectType}/{objectId}", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "objectType", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "204" : { "description" : "No content", "content" : { } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "oauth" ] }, { "oauth2" : [ "crm.objects.deals.read" ] }, { "oauth2" : [ "crm.objects.subscriptions.read" ] }, { "oauth2" : [ "crm.objects.services.read" ] }, { "oauth2" : [ "crm.objects.orders.read" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.custom.read" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.tasks.read" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.read" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] }, { "oauth2" : [ "media_bridge.read" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.invoices.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.users.write" ] }, { "oauth2" : [ "crm.objects.calls.read" ] }, { "oauth2" : [ "crm.objects.meetings.read" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.users.read" ] }, { "oauth2" : [ "crm.objects.partner-services.read" ] }, { "oauth2" : [ "crm.objects.orders.write" ] }, { "oauth2" : [ "crm.objects.partner-services.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.carts.write" ] }, { "oauth2" : [ "tickets" ] }, { "oauth2" : [ "crm.objects.commercepayments.read" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.subscriptions.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.contacts.read" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.invoices.read" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.custom.write" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "e-commerce" ] }, { "oauth2" : [ "crm.objects.appointments.read" ] }, { "oauth2" : [ "crm.objects.projects.read" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.read" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.goals.read" ] }, { "oauth2" : [ "crm.objects.line_items.read" ] }, { "oauth2" : [ "crm.objects.partner-clients.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.quotes.write" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.leads.read" ] }, { "oauth2" : [ "crm.objects.leads.write" ] }, { "oauth2" : [ "crm.objects.carts.read" ] }, { "oauth2" : [ "crm.objects.emails.read" ] }, { "oauth2" : [ "crm.objects.quotes.read" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.partner-clients.read" ] }, { "oauth2" : [ "crm.objects.notes.read" ] }, { "oauth2" : [ "crm.objects.courses.read" ] }, { "oauth2" : [ "crm.objects.listings.read" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.products.read" ] } ] }, "patch" : { "tags" : [ "Basic" ], "operationId" : "patch-/crm/objects/2026-09-beta/{objectType}/{objectId}_/crm/objects/2026-09-beta/{objectType}/{objectId}", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "objectType", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "idProperty", "in" : "query", "description" : "The name of a property whose values are unique for this object type", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SimplePublicObjectInput" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SimplePublicObject" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "oauth" ] }, { "oauth2" : [ "crm.objects.deals.read" ] }, { "oauth2" : [ "crm.objects.subscriptions.read" ] }, { "oauth2" : [ "crm.objects.services.read" ] }, { "oauth2" : [ "crm.objects.orders.read" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.custom.read" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.tasks.read" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.read" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] }, { "oauth2" : [ "media_bridge.read" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.invoices.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.users.write" ] }, { "oauth2" : [ "crm.objects.calls.read" ] }, { "oauth2" : [ "crm.objects.meetings.read" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.users.read" ] }, { "oauth2" : [ "crm.objects.partner-services.read" ] }, { "oauth2" : [ "crm.objects.orders.write" ] }, { "oauth2" : [ "crm.objects.partner-services.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.carts.write" ] }, { "oauth2" : [ "tickets" ] }, { "oauth2" : [ "crm.objects.commercepayments.read" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.subscriptions.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.contacts.read" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.invoices.read" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.custom.write" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "e-commerce" ] }, { "oauth2" : [ "crm.objects.appointments.read" ] }, { "oauth2" : [ "crm.objects.projects.read" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.read" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.goals.read" ] }, { "oauth2" : [ "crm.objects.line_items.read" ] }, { "oauth2" : [ "crm.objects.partner-clients.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.quotes.write" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.leads.read" ] }, { "oauth2" : [ "crm.objects.leads.write" ] }, { "oauth2" : [ "crm.objects.carts.read" ] }, { "oauth2" : [ "crm.objects.emails.read" ] }, { "oauth2" : [ "crm.objects.quotes.read" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.partner-clients.read" ] }, { "oauth2" : [ "crm.objects.notes.read" ] }, { "oauth2" : [ "crm.objects.courses.read" ] }, { "oauth2" : [ "crm.objects.listings.read" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.products.read" ] } ] } }, "/crm/objects/2026-09-beta/{objectType}/{objectId}/associations/{toObjectType}" : { "get" : { "tags" : [ "Basic" ], "operationId" : "get-/crm/objects/2026-09-beta/{objectType}/{objectId}/associations/{toObjectType}_/crm/objects/2026-09-beta/{objectType}/{objectId}/associations/{toObjectType}", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "objectType", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "toObjectType", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "after", "in" : "query", "description" : "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.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The maximum number of results to display per page.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : null, "default" : 500 } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CollectionResponseMultiAssociatedObjectWithLabelForwardPaging" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "oauth" ] }, { "oauth2" : [ "crm.objects.deals.read" ] }, { "oauth2" : [ "crm.objects.subscriptions.read" ] }, { "oauth2" : [ "crm.objects.services.read" ] }, { "oauth2" : [ "crm.objects.orders.read" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.custom.read" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.tasks.read" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.read" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] }, { "oauth2" : [ "media_bridge.read" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.invoices.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.users.write" ] }, { "oauth2" : [ "crm.objects.calls.read" ] }, { "oauth2" : [ "crm.objects.meetings.read" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.users.read" ] }, { "oauth2" : [ "crm.objects.partner-services.read" ] }, { "oauth2" : [ "crm.objects.orders.write" ] }, { "oauth2" : [ "crm.objects.partner-services.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.carts.write" ] }, { "oauth2" : [ "tickets" ] }, { "oauth2" : [ "crm.objects.commercepayments.read" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.subscriptions.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.contacts.read" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.invoices.read" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.custom.write" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "e-commerce" ] }, { "oauth2" : [ "crm.objects.appointments.read" ] }, { "oauth2" : [ "crm.objects.projects.read" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.read" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.goals.read" ] }, { "oauth2" : [ "crm.objects.line_items.read" ] }, { "oauth2" : [ "crm.objects.partner-clients.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.quotes.write" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.leads.read" ] }, { "oauth2" : [ "crm.objects.leads.write" ] }, { "oauth2" : [ "crm.objects.carts.read" ] }, { "oauth2" : [ "crm.objects.emails.read" ] }, { "oauth2" : [ "crm.objects.quotes.read" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.partner-clients.read" ] }, { "oauth2" : [ "crm.objects.notes.read" ] }, { "oauth2" : [ "crm.objects.courses.read" ] }, { "oauth2" : [ "crm.objects.listings.read" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.products.read" ] } ] } }, "/crm/objects/2026-09-beta/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}" : { "put" : { "tags" : [ "Basic" ], "operationId" : "put-/crm/objects/2026-09-beta/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}_/crm/objects/2026-09-beta/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "objectType", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "toObjectId", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "toObjectType", "in" : "path", "description" : "", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/AssociationSpec" } }, "example" : null } }, "required" : true }, "responses" : { "201" : { "description" : "successful operation", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LabelsBetweenObjectPair" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "oauth" ] }, { "oauth2" : [ "crm.objects.deals.read" ] }, { "oauth2" : [ "crm.objects.subscriptions.read" ] }, { "oauth2" : [ "crm.objects.services.read" ] }, { "oauth2" : [ "crm.objects.orders.read" ] }, { "oauth2" : [ "crm.objects.listings.write" ] }, { "oauth2" : [ "crm.objects.custom.read" ] }, { "oauth2" : [ "crm.objects.companies.write" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.tasks.read" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.read" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.read.v2" ] }, { "oauth2" : [ "media_bridge.read" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.contacts.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.commercepayments.write" ] }, { "oauth2" : [ "crm.objects.invoices.write" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.users.write" ] }, { "oauth2" : [ "crm.objects.calls.read" ] }, { "oauth2" : [ "crm.objects.meetings.read" ] }, { "oauth2" : [ "crm.objects.custom.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.users.read" ] }, { "oauth2" : [ "crm.objects.partner-services.read" ] }, { "oauth2" : [ "crm.objects.orders.write" ] }, { "oauth2" : [ "crm.objects.partner-services.write" ] }, { "oauth2" : [ "crm.objects.appointments.write" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.write" ] }, { "oauth2" : [ "crm.objects.carts.write" ] }, { "oauth2" : [ "tickets" ] }, { "oauth2" : [ "crm.objects.commercepayments.read" ] }, { "oauth2" : [ "crm.objects.products.write" ] }, { "oauth2" : [ "crm.objects.services.write" ] }, { "oauth2" : [ "crm.objects.subscriptions.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.contacts.read" ] }, { "oauth2" : [ "crm.objects.appointments.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.invoices.read" ] }, { "oauth2" : [ "crm.objects.projects.highly_sensitive.read" ] }, { "oauth2" : [ "tickets.sensitive.v2" ] }, { "oauth2" : [ "crm.objects.custom.write" ] }, { "oauth2" : [ "crm.objects.deals.write" ] }, { "oauth2" : [ "e-commerce" ] }, { "oauth2" : [ "crm.objects.appointments.read" ] }, { "oauth2" : [ "crm.objects.projects.read" ] }, { "oauth2" : [ "crm.objects.companies.sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.deals.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.companies.highly_sensitive.write.v2" ] }, { "oauth2" : [ "crm.objects.custom.highly_sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.goals.write" ] }, { "oauth2" : [ "crm.objects.line_items.write" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.read" ] }, { "oauth2" : [ "crm.objects.contacts.write" ] }, { "oauth2" : [ "crm.objects.goals.read" ] }, { "oauth2" : [ "crm.objects.line_items.read" ] }, { "oauth2" : [ "crm.objects.partner-clients.write" ] }, { "oauth2" : [ "crm.objects.projects.write" ] }, { "oauth2" : [ "crm.objects.deals.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.projects.sensitive.write" ] }, { "oauth2" : [ "crm.objects.quotes.write" ] }, { "oauth2" : [ "tickets.highly_sensitive.v2" ] }, { "oauth2" : [ "crm.objects.leads.read" ] }, { "oauth2" : [ "crm.objects.leads.write" ] }, { "oauth2" : [ "crm.objects.carts.read" ] }, { "oauth2" : [ "crm.objects.emails.read" ] }, { "oauth2" : [ "crm.objects.quotes.read" ] }, { "oauth2" : [ "crm.objects.courses.write" ] }, { "oauth2" : [ "crm.objects.partner-clients.read" ] }, { "oauth2" : [ "crm.objects.notes.read" ] }, { "oauth2" : [ "crm.objects.courses.read" ] }, { "oauth2" : [ "crm.objects.listings.read" ] }, { "oauth2" : [ "crm.objects.contacts.sensitive.read.v2" ] }, { "oauth2" : [ "crm.objects.products.read" ] } ] } } }, "components" : { "schemas" : { "AssociatedId" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The ID for the association type.", "example" : null }, "type" : { "type" : "string", "description" : "The type of associations.", "example" : "deal_to_contact" } }, "description" : "Contains the id and type of an association", "example" : null }, "AssociationSpec" : { "required" : [ "associationCategory", "associationTypeId" ], "type" : "object", "properties" : { "associationCategory" : { "type" : "string", "description" : "The category of the association, such as \"HUBSPOT_DEFINED\".", "example" : null, "enum" : [ "HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK" ] }, "associationTypeId" : { "type" : "integer", "description" : "The ID representing the specific type of association.", "format" : "int32", "example" : null } }, "description" : "Defines the type, direction, and details of the relationship between two CRM objects.", "example" : null }, "AssociationSpecWithLabel" : { "required" : [ "category", "typeId" ], "type" : "object", "properties" : { "category" : { "type" : "string", "description" : "Association category. Can be HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED or WORK", "example" : null, "enum" : [ "HUBSPOT_DEFINED", "INTEGRATOR_DEFINED", "USER_DEFINED", "WORK" ] }, "label" : { "type" : "string", "description" : "An optional descriptor that provides additional context about the relationship between associated records, such as \"Mentor\" and \"Mentee\".", "example" : null }, "typeId" : { "type" : "integer", "description" : "An integer value used to uniquely identify a specific association type within its Association Category.", "format" : "int32", "example" : null } }, "description" : "Defines the type, direction, and details of the relationship between two CRM objects.", "example" : null }, "BatchInputSimplePublicObjectBatchInput" : { "required" : [ "inputs" ], "type" : "object", "properties" : { "inputs" : { "type" : "array", "description" : "An array of SimplePublicObjectBatchInput objects, each containing the properties and identifiers for the CRM objects to be updated.", "example" : null, "items" : { "$ref" : "#/components/schemas/SimplePublicObjectBatchInput" } } }, "example" : null }, "BatchInputSimplePublicObjectBatchInputForCreate" : { "required" : [ "inputs" ], "type" : "object", "properties" : { "inputs" : { "type" : "array", "description" : "An array of objects, each representing a CRM object to be created. Each object includes properties and associations necessary for the creation of the CRM object.", "example" : null, "items" : { "$ref" : "#/components/schemas/SimplePublicObjectBatchInputForCreate" } } }, "example" : null }, "BatchReadInputSimplePublicObjectId" : { "required" : [ "inputs", "properties", "propertiesWithHistory" ], "type" : "object", "properties" : { "idProperty" : { "type" : "string", "example" : null }, "inputs" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/SimplePublicObjectId" } }, "properties" : { "type" : "array", "description" : "Key-value pairs for setting properties for the new object.", "example" : null, "items" : { "type" : "string", "example" : null } }, "propertiesWithHistory" : { "type" : "array", "description" : "Key-value pairs for setting properties for the new object and their histories.", "example" : null, "items" : { "type" : "string", "example" : null } } }, "description" : "Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property.", "example" : null }, "BatchResponsePublicDefaultAssociation" : { "required" : [ "completedAt", "results", "startedAt", "status" ], "type" : "object", "properties" : { "completedAt" : { "type" : "string", "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", "format" : "date-time", "example" : null }, "errors" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/StandardError" } }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "An object containing relevant links related to the batch request.", "example" : null }, "numErrors" : { "type" : "integer", "description" : "The total number of errors that occurred during the operation.", "format" : "int32", "example" : null }, "requestedAt" : { "type" : "string", "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", "format" : "date-time", "example" : null }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicDefaultAssociation" } }, "startedAt" : { "type" : "string", "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", "format" : "date-time", "example" : null }, "status" : { "type" : "string", "description" : "The status of the batch processing request. Can be: \"PENDING\", \"PROCESSING\", \"CANCELED\", or \"COMPLETE\".", "example" : null, "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] } }, "description" : "The response returned after performing a batch operation on associations.", "example" : null }, "BatchResponseSimplePublicObject" : { "required" : [ "completedAt", "results", "startedAt", "status" ], "type" : "object", "properties" : { "completedAt" : { "type" : "string", "description" : "The timestamp when the batch processing was completed, in ISO 8601 format.", "format" : "date-time", "example" : null }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "An object containing relevant links related to the batch request.", "example" : null }, "requestedAt" : { "type" : "string", "description" : "The timestamp when the batch request was initially made, in ISO 8601 format.", "format" : "date-time", "example" : null }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/SimplePublicObject" } }, "startedAt" : { "type" : "string", "description" : "The timestamp when the batch processing began, in ISO 8601 format.", "format" : "date-time", "example" : null }, "status" : { "type" : "string", "description" : "The status of the batch processing request: \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\"", "example" : null, "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] } }, "description" : "A public object batch response object", "example" : null }, "BatchResponseSimplePublicObjectWithErrors" : { "required" : [ "completedAt", "results", "startedAt", "status" ], "type" : "object", "properties" : { "completedAt" : { "type" : "string", "description" : "The timestamp when the batch process was completed, in ISO 8601 format.", "format" : "date-time", "example" : null }, "errors" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/StandardError" } }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "An object containing relevant links related to the batch request.", "example" : null }, "numErrors" : { "type" : "integer", "description" : "The number of errors encountered during the batch process.", "format" : "int32", "example" : null }, "requestedAt" : { "type" : "string", "description" : "The timestamp when the batch process was initiated, in ISO 8601 format.", "format" : "date-time", "example" : null }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/SimplePublicObject" } }, "startedAt" : { "type" : "string", "description" : "The timestamp when the batch process began execution, in ISO 8601 format.", "format" : "date-time", "example" : null }, "status" : { "type" : "string", "description" : "The status of the batch processing request - \"PENDING\", \"PROCESSING\", \"CANCELLED\", or \"COMPLETE\"", "example" : null, "enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ] } }, "description" : "Represents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation.", "example" : null }, "CollectionResponseAssociatedId" : { "required" : [ "results" ], "type" : "object", "properties" : { "paging" : { "$ref" : "#/components/schemas/Paging" }, "results" : { "type" : "array", "description" : "An array of associated IDs, each represented by an object of type AssociatedId.", "example" : null, "items" : { "$ref" : "#/components/schemas/AssociatedId" } } }, "example" : null }, "CollectionResponseMultiAssociatedObjectWithLabelForwardPaging" : { "required" : [ "results" ], "type" : "object", "properties" : { "paging" : { "$ref" : "#/components/schemas/ForwardPaging" }, "results" : { "type" : "array", "description" : "An array of multi-associated objects, each containing an ID and a list of association types with labels.", "example" : null, "items" : { "$ref" : "#/components/schemas/MultiAssociatedObjectWithLabel" } } }, "example" : null }, "CollectionResponseSimplePublicObjectWithAssociationsForwardPaging" : { "required" : [ "results" ], "type" : "object", "properties" : { "paging" : { "$ref" : "#/components/schemas/ForwardPaging" }, "results" : { "type" : "array", "description" : "An array of SimplePublicObjectWithAssociations, each representing a CRM object and its associated data.", "example" : null, "items" : { "$ref" : "#/components/schemas/SimplePublicObjectWithAssociations" } } }, "example" : null }, "CollectionResponseWithTotalSimplePublicObject" : { "required" : [ "results", "total" ], "type" : "object", "properties" : { "paging" : { "$ref" : "#/components/schemas/Paging" }, "results" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/SimplePublicObject" } }, "total" : { "type" : "integer", "description" : "The number of available results", "format" : "int32", "example" : null } }, "description" : "Represents a list of simple objects returned from an API request, along with the total count of objects available.", "example" : null }, "Error" : { "required" : [ "category", "correlationId", "message" ], "type" : "object", "properties" : { "category" : { "type" : "string", "description" : "The error category", "example" : null }, "context" : { "type" : "object", "additionalProperties" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "description" : "Context about the error condition", "example" : "{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}" }, "correlationId" : { "type" : "string", "description" : "A unique identifier for the request. Include this value with any error reports or support tickets", "format" : "uuid", "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" }, "errors" : { "type" : "array", "description" : "further information about the error", "example" : null, "items" : { "$ref" : "#/components/schemas/ErrorDetail" } }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps", "example" : null }, "message" : { "type" : "string", "description" : "A human readable message describing the error along with remediation steps where appropriate", "example" : "An error occurred" }, "subCategory" : { "type" : "string", "description" : "A specific category that contains more specific detail about the error", "example" : null } }, "example" : { "message" : "Invalid input (details will vary based on the error)", "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf", "category" : "VALIDATION_ERROR", "links" : { "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" } } }, "ErrorDetail" : { "required" : [ "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "The status code associated with the error detail", "example" : null }, "context" : { "type" : "object", "additionalProperties" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "description" : "Context about the error condition", "example" : "{missingScopes=[scope1, scope2]}" }, "in" : { "type" : "string", "description" : "The name of the field or parameter in which the error was found.", "example" : null }, "message" : { "type" : "string", "description" : "A human readable message describing the error along with remediation steps where appropriate", "example" : null }, "subCategory" : { "type" : "string", "description" : "A specific category that contains more specific detail about the error", "example" : null } }, "example" : null }, "Filter" : { "required" : [ "operator", "propertyName" ], "type" : "object", "properties" : { "highValue" : { "type" : "string", "description" : "The upper boundary value when using ranged-based filters.", "example" : null }, "operator" : { "type" : "string", "description" : "The comparison operator used in the filter, such as \"EQ\" or \"GT\".", "example" : null, "enum" : [ "BETWEEN", "CONTAINS_TOKEN", "EQ", "GT", "GTE", "HAS_PROPERTY", "IN", "LT", "LTE", "NEQ", "NOT_CONTAINS_TOKEN", "NOT_HAS_PROPERTY", "NOT_IN" ] }, "propertyName" : { "type" : "string", "description" : "The name of the property to apply the filter to.", "example" : null }, "value" : { "type" : "string", "description" : "The value to match against the property.", "example" : null }, "values" : { "type" : "array", "description" : "The values to match against the property.", "example" : null, "items" : { "type" : "string", "example" : null } } }, "description" : "Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against. ", "example" : null }, "FilterGroup" : { "required" : [ "filters" ], "type" : "object", "properties" : { "filters" : { "type" : "array", "description" : "An array of filter objects that define the criteria for the search. Each filter specifies a property, an operator, and a value to match against.", "example" : null, "items" : { "$ref" : "#/components/schemas/Filter" } } }, "example" : null }, "ForwardPaging" : { "type" : "object", "properties" : { "next" : { "$ref" : "#/components/schemas/NextPage" } }, "example" : null }, "LabelsBetweenObjectPair" : { "required" : [ "fromObjectId", "fromObjectTypeId", "labels", "toObjectId", "toObjectTypeId" ], "type" : "object", "properties" : { "fromObjectId" : { "type" : "string", "description" : "Source unique ID of the object.", "example" : null }, "fromObjectTypeId" : { "type" : "string", "description" : "Source object type.", "example" : null }, "labels" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "toObjectId" : { "type" : "string", "description" : "Target unique ID of the object.", "example" : null }, "toObjectTypeId" : { "type" : "string", "description" : "Target object type.", "example" : null } }, "description" : "The relationship descriptors applicable between two object types.", "example" : null }, "MultiAssociatedObjectWithLabel" : { "required" : [ "associationTypes", "toObjectId" ], "type" : "object", "properties" : { "associationTypes" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/AssociationSpecWithLabel" } }, "toObjectId" : { "type" : "string", "description" : "Target unique ID of the object.", "example" : null } }, "description" : "Represents an object that is associated with multiple other objects, with optional context.", "example" : null }, "NextPage" : { "required" : [ "after" ], "type" : "object", "properties" : { "after" : { "type" : "string", "description" : "A paging cursor token for retrieving subsequent pages.", "example" : null }, "link" : { "type" : "string", "description" : "A URL that can be used to retrieve the next page results.", "example" : null } }, "description" : "Specifies the paging information needed to retrieve the next set of results in a paginated API response", "example" : null }, "Paging" : { "type" : "object", "properties" : { "next" : { "$ref" : "#/components/schemas/NextPage" }, "prev" : { "$ref" : "#/components/schemas/PreviousPage" } }, "example" : null }, "PreviousPage" : { "required" : [ "before" ], "type" : "object", "properties" : { "before" : { "type" : "string", "description" : "A paging cursor token for retrieving previous pages.", "example" : null }, "link" : { "type" : "string", "description" : "A URL that can be used to retrieve the previous pages' results.", "example" : null } }, "description" : "specifies the paging information needed to retrieve the previous set of results in a paginated API response", "example" : null }, "PublicAssociationsForObject" : { "required" : [ "to", "types" ], "type" : "object", "properties" : { "to" : { "$ref" : "#/components/schemas/PublicObjectId" }, "types" : { "type" : "array", "description" : "An array of AssociationSpec objects, each specifying the type of association between the current object and the target object. This includes details like the association category and type ID.", "example" : null, "items" : { "$ref" : "#/components/schemas/AssociationSpec" } } }, "example" : null }, "PublicDefaultAssociation" : { "required" : [ "associationSpec", "from", "to" ], "type" : "object", "properties" : { "associationSpec" : { "$ref" : "#/components/schemas/AssociationSpec" }, "from" : { "$ref" : "#/components/schemas/PublicObjectId" }, "to" : { "$ref" : "#/components/schemas/PublicObjectId" } }, "example" : null }, "PublicObjectId" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The unique ID of the object.", "example" : null } }, "description" : "Contains the Id of a Public Object", "example" : null }, "PublicObjectSearchRequest" : { "required" : [ "after", "filterGroups", "limit", "properties", "sorts" ], "type" : "object", "properties" : { "after" : { "type" : "string", "description" : "A paging cursor token for retrieving subsequent pages.", "example" : null }, "filterGroups" : { "type" : "array", "description" : "Up to 6 groups of filters defining additional query criteria.", "example" : null, "items" : { "$ref" : "#/components/schemas/FilterGroup" } }, "limit" : { "type" : "integer", "description" : "The maximum results to return, up to 200 objects.", "format" : "int32", "example" : null }, "properties" : { "type" : "array", "description" : "A list of property names to include in the response.", "example" : null, "items" : { "type" : "string", "example" : null } }, "query" : { "type" : "string", "description" : "The search query string, up to 3000 characters.", "example" : null }, "sorts" : { "type" : "array", "description" : "Specifies sorting order based on object properties.", "example" : null, "items" : { "type" : "string", "example" : null } } }, "description" : "Describes a search request", "example" : null }, "PublicObjectWarning" : { "required" : [ "category", "context", "message" ], "type" : "object", "properties" : { "category" : { "type" : "string", "example" : null }, "context" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "example" : null }, "message" : { "type" : "string", "example" : null } }, "example" : null }, "SimplePublicObject" : { "required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ], "type" : "object", "properties" : { "archived" : { "type" : "boolean", "description" : "Whether the object is archived.", "example" : null }, "archivedAt" : { "type" : "string", "description" : "The timestamp when the object was archived, in ISO 8601 format.", "format" : "date-time", "example" : null }, "createdAt" : { "type" : "string", "description" : "The timestamp when the object was created, in ISO 8601 format.", "format" : "date-time", "example" : null }, "id" : { "type" : "string", "description" : "The unique ID of the object.", "example" : null }, "objectWriteTraceId" : { "type" : "string", "description" : "An identifier used for tracing the write request for the object.", "example" : null }, "properties" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "Key-value pairs representing the properties of the object.", "example" : null }, "propertiesWithHistory" : { "type" : "object", "additionalProperties" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ValueWithTimestamp" } }, "description" : "Key-value pairs representing the properties of the object along with their history.", "example" : null }, "updatedAt" : { "type" : "string", "description" : "The timestamp when the object was last updated, in ISO 8601 format.", "format" : "date-time", "example" : null }, "url" : { "type" : "string", "description" : "The URL associated with the object.", "example" : null }, "warnings" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicObjectWarning" } } }, "description" : "A simple public object.", "example" : null }, "SimplePublicObjectBatchInput" : { "required" : [ "id", "properties" ], "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The unique ID of the object.", "example" : null }, "idProperty" : { "type" : "string", "description" : "The name of a unique identifier property, which can be used for identifying objects instead of the object ID.", "example" : "my_unique_property_name" }, "objectWriteTraceId" : { "type" : "string", "description" : "A unique identifier for tracing the request.", "example" : null }, "properties" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "Key-value pairs representing the properties of the object.", "example" : null } }, "description" : "Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties.", "example" : null }, "SimplePublicObjectBatchInputForCreate" : { "required" : [ "associations", "properties" ], "type" : "object", "properties" : { "associations" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicAssociationsForObject" } }, "objectWriteTraceId" : { "type" : "string", "description" : "An identifier used for tracing the creation or update request of the object.", "example" : null }, "properties" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "Key value pairs representing the properties of the object.", "example" : null } }, "description" : "An input object that contains a collection of objects to be created together in a batch.", "example" : null }, "SimplePublicObjectId" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The unique ID of the object.", "example" : "430001" } }, "description" : "Contains the Id of a Public Object", "example" : null }, "SimplePublicObjectInput" : { "required" : [ "properties" ], "type" : "object", "properties" : { "properties" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "Key value pairs representing the properties of the object.", "example" : null } }, "description" : "Represents the input required to create or update a CRM object, containing an object with property names and their corresponding values.", "example" : null }, "SimplePublicObjectInputForCreate" : { "required" : [ "associations", "properties" ], "type" : "object", "properties" : { "associations" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicAssociationsForObject" } }, "properties" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "Key-value pairs for setting properties for the new object.", "example" : null } }, "description" : "Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects.", "example" : null }, "SimplePublicObjectWithAssociations" : { "required" : [ "archived", "createdAt", "id", "properties", "updatedAt" ], "type" : "object", "properties" : { "archived" : { "type" : "boolean", "description" : "Whether the object is archived.", "example" : null }, "archivedAt" : { "type" : "string", "description" : "The timestamp when the object was archived, in ISO 8601 format.", "format" : "date-time", "example" : null }, "associations" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/CollectionResponseAssociatedId" }, "description" : "A list defining relationships with other objects.", "example" : null }, "createdAt" : { "type" : "string", "description" : "The timestamp when the object was created, in ISO 8601 format.", "format" : "date-time", "example" : null }, "id" : { "type" : "string", "description" : "The unique ID of the object.", "example" : null }, "objectWriteTraceId" : { "type" : "string", "description" : "An identifier used for tracing the creation or update request of the object.", "example" : null }, "properties" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "Key value pairs representing the properties of the object.", "example" : null }, "propertiesWithHistory" : { "type" : "object", "additionalProperties" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/ValueWithTimestamp" } }, "description" : "Key-value pairs representing the properties of the object along with their history.", "example" : null }, "updatedAt" : { "type" : "string", "description" : "The timestamp when the object was last updated, in ISO 8601 format.", "format" : "date-time", "example" : null }, "url" : { "type" : "string", "description" : "The URL on the API that provide direct navigation to the corresponding UI pages for the connectors.", "example" : null }, "warnings" : { "type" : "array", "example" : null, "items" : { "$ref" : "#/components/schemas/PublicObjectWarning" } } }, "description" : "Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.", "example" : null }, "StandardError" : { "required" : [ "category", "context", "errors", "links", "message", "status" ], "type" : "object", "properties" : { "category" : { "type" : "string", "description" : "The main category of the error.", "example" : null }, "context" : { "type" : "object", "additionalProperties" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "description" : "Additional context-specific information related to the error.", "example" : null }, "errors" : { "type" : "array", "description" : "The detailed error objects.", "example" : null, "items" : { "$ref" : "#/components/schemas/ErrorDetail" } }, "id" : { "type" : "string", "description" : "A unique ID for the error instance.", "example" : null }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "URLs linking to documentation or resources associated with the error.", "example" : null }, "message" : { "type" : "string", "description" : "A human-readable string describing the error and possible remediation steps.", "example" : null }, "status" : { "type" : "string", "description" : "The HTTP status code associated with the error.", "example" : null }, "subCategory" : { "type" : "object", "properties" : { }, "description" : "A more specific error category within each main category.", "example" : null } }, "description" : "Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request.", "example" : null }, "ValueWithTimestamp" : { "required" : [ "sourceType", "timestamp", "value" ], "type" : "object", "properties" : { "sourceId" : { "type" : "string", "description" : "The unique ID of the property.", "example" : null }, "sourceLabel" : { "type" : "string", "description" : "A human-readable label.", "example" : null }, "sourceType" : { "type" : "string", "description" : "The property type.", "example" : null }, "timestamp" : { "type" : "string", "description" : "The timestamp when the property was updated, in ISO 8601 format.", "format" : "date-time", "example" : null }, "updatedByUserId" : { "type" : "integer", "description" : "The ID of the user who last updated the property.", "format" : "int32", "example" : null }, "value" : { "type" : "string", "description" : "The property value.", "example" : null } }, "description" : "Property model that includes timestamp.", "example" : null } }, "responses" : { "Error" : { "description" : "An error occurred.", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/Error" }, "example" : null } } } }, "securitySchemes" : { "developer_hapikey" : { "type" : "apiKey", "name" : "hapikey", "in" : "query" }, "oauth2" : { "type" : "oauth2", "flows" : { "authorizationCode" : { "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", "scopes" : { "crm.objects.appointments.read" : "", "crm.objects.appointments.sensitive.read.v2" : "", "crm.objects.appointments.sensitive.write.v2" : "", "crm.objects.appointments.write" : "", "crm.objects.calls.read" : "", "crm.objects.carts.read" : "", "crm.objects.carts.write" : "", "crm.objects.commercepayments.read" : "", "crm.objects.commercepayments.write" : "", "crm.objects.companies.highly_sensitive.read.v2" : "", "crm.objects.companies.highly_sensitive.write.v2" : "", "crm.objects.companies.read" : "", "crm.objects.companies.sensitive.read.v2" : "", "crm.objects.companies.sensitive.write.v2" : "", "crm.objects.companies.write" : "", "crm.objects.contacts.highly_sensitive.read.v2" : "", "crm.objects.contacts.highly_sensitive.write.v2" : "", "crm.objects.contacts.read" : "", "crm.objects.contacts.sensitive.read.v2" : "", "crm.objects.contacts.sensitive.write.v2" : "", "crm.objects.contacts.write" : "", "crm.objects.courses.read" : "", "crm.objects.courses.write" : "", "crm.objects.custom.highly_sensitive.read.v2" : "", "crm.objects.custom.highly_sensitive.write.v2" : "", "crm.objects.custom.read" : "", "crm.objects.custom.sensitive.read.v2" : "", "crm.objects.custom.sensitive.write.v2" : "", "crm.objects.custom.write" : "", "crm.objects.deals.highly_sensitive.read.v2" : "", "crm.objects.deals.highly_sensitive.write.v2" : "", "crm.objects.deals.read" : "", "crm.objects.deals.sensitive.read.v2" : "", "crm.objects.deals.sensitive.write.v2" : "", "crm.objects.deals.write" : "", "crm.objects.emails.read" : "", "crm.objects.goals.read" : "", "crm.objects.goals.write" : "", "crm.objects.invoices.read" : "", "crm.objects.invoices.write" : "", "crm.objects.leads.read" : "", "crm.objects.leads.write" : "", "crm.objects.line_items.read" : "", "crm.objects.line_items.write" : "", "crm.objects.listings.read" : "", "crm.objects.listings.write" : "", "crm.objects.meetings.read" : "", "crm.objects.notes.read" : "", "crm.objects.orders.read" : "", "crm.objects.orders.write" : "", "crm.objects.partner-clients.read" : "", "crm.objects.partner-clients.write" : "", "crm.objects.partner-services.read" : "", "crm.objects.partner-services.write" : "", "crm.objects.products.read" : "", "crm.objects.products.write" : "", "crm.objects.projects.highly_sensitive.read" : "", "crm.objects.projects.highly_sensitive.write" : "", "crm.objects.projects.read" : "", "crm.objects.projects.sensitive.read" : "", "crm.objects.projects.sensitive.write" : "", "crm.objects.projects.write" : "", "crm.objects.quotes.read" : "", "crm.objects.quotes.write" : "", "crm.objects.services.read" : "", "crm.objects.services.write" : "", "crm.objects.subscriptions.read" : "", "crm.objects.subscriptions.write" : "", "crm.objects.tasks.read" : "", "crm.objects.users.read" : "", "crm.objects.users.write" : "", "e-commerce" : "", "media_bridge.read" : "", "oauth" : "", "tickets" : "", "tickets.highly_sensitive.v2" : "", "tickets.sensitive.v2" : "" } } } }, "private_apps" : { "type" : "apiKey", "name" : "private-app", "in" : "header" }, "private_apps_legacy" : { "type" : "apiKey", "name" : "private-app-legacy", "in" : "header" } } }, "x-hubspot-product-tier-requirements" : { "marketing" : "FREE", "sales" : "PROFESSIONAL", "service" : "PROFESSIONAL", "cms" : "FREE", "commerce" : "FREE", "crmHub" : "FREE", "dataHub" : "FREE" } }