Skip to main content

Scopes provide access to a specific set of HubSpot API endpoints and the associated data from a HubSpot account. If you created a private app, you can specify which scopes your app has access to in your private app settings. If you're developing a public app, you'll configure both required and optional scopes that users who install your app will be prompted to authorize via the app's install URL.

Any scopes required to make a request to a specific endpoint will be listed under the Requirements section in the reference documentation, which can be accessed by navigating to the endpoint reference link at the top of an API guide.

updated-scope-screenshot-in-reference-doc

Some scopes may list both Standard and Granular scopes. If both scope types are listed, you should opt for using the granular scopes when possible, as they specify more explicit access for your API requests.

Access to specific APIs or endpoints depends on HubSpot account tier. You can find a full list of available scopes and accessible endpoints in the table below.

ScopeDescriptionProvides access toRequired account tier
cms.domains.readList connected domainsin an account.CMS APIAny account
cms.domains.writeCreate, update, and delete connected domains.CMS APIAny account
cms.functions.readView all Content Hub serverless functions, any related secrets, and function execution results.CMS APIContent Hub Enterprise
cms.functions.writeGrants access to write Content Hub serverless functions and secrets.CMS APIContent Hub Enterprise
cms.knowledge_base.articles.readView details about knowledge articles.CMS APIService Hub Professional or Enterprise
cms.knowledge_base.articles.writeGrants access to update knowledge articles.CMS APIService Hub Professional or Enterprise
cms.knowledge_base.articles.publishGrants access to update and publish knowledge articles.CMS APIService Hub Professional or Enterprise
cms.knowledge_base.settings.readView general and template knowledge base settings, such as the domain or root URL.CMS APIService Hub Professional or Enterprise
cms.knowledge_base.settings.writeGrants access to update general and template knowledge base settings. This includes write access to knowledge articles.CMS APIService Hub Professional or Enterprise
cms.membership.access_groups.readView membership access groups and their definitions.CMS APIService Hub or Content Hub Professional or Enterprise
cms.membership.access_groups.writeCreate, edit, and delete membership access groups.CMS APIService Hub or Content Hub Professional or Enterprise
crm.lists.readView details about contact lists.List endpointsAny account
crm.lists.writeCreate, delete, or make changes to contact listsList endpointsAny account
crm.objects.appointments.readView properties and other details about appointments.Appointments endpointsAny account
crm.objects.appointments.sensitive.readView Sensitive Data properties for appointments.Appointments endpointsAny Enterprise account
crm.objects.appointments.sensitive.writeEdit Sensitive Data properties and values for appointments.Appointments endpointsAny Enterprise account
crm.objects.appointments.writeCreate, delete, or make changes to appointments.Appointments endpointsAny account
crm.objects.carts.readView properties and other details about carts.Carts endpointsAny account
crm.objects.carts.writeCreate, delete, or make changes to carts.Carts endpointsAny account
crm.objects.commercepayments.readView details about commerce payments.Commerce payments endpointsAny Starter account
crm.objects.companies.highly_sensitive.readView Highly Sensitive Data properties for companies.Companies endpointsAny Enterprise account
crm.objects.companies.highly_sensitive.writeEdit Highly Sensitive Data properties and values for companies.Companies endpointsAny Enterprise account
crm.objects.companies.readView properties and other details about companies.Companies endpointsAny account
crm.objects.companies.sensitive.readView Sensitive Data properties for companies.Companies endpointsAny Enterprise account
crm.objects.companies.sensitive.writeEdit Sensitive Data properties and values for companies.Companies endpointsAny Enterprise account
crm.objects.companies.writeView properties and create, delete, or make changes to companies.Companies endpointsAny account
crm.objects.contacts.highly_sensitive.readView Highly Sensitive Data properties for contacts.Contacts endpointsAny Enterprise account
crm.objects.contacts.highly_sensitive.writeEdit Highly Sensitive Data properties and values for contacts.Contacts endpointsAny Enterprise account
crm.objects.contacts.readView properties and other details about contacts.Contacts endpointsAny account
crm.objects.contacts.sensitive.readView Sensitive Data properties for contacts.Contacts endpointsAny Enterprise account
crm.objects.contacts.sensitive.writeEdit Sensitive Data properties and values for contacts.Contacts endpointsAny Enterprise account
crm.objects.contacts.writeView properties and create, delete, and make changes to contacts.Contacts endpointsAny account
crm.objects.courses.readView details about courses.Courses endpointsAny account
crm.objects.courses.writeCreate, delete, or make changes to courses.Courses endpointsAny account
crm.objects.custom.highly_sensitive.readView Highly Sensitive Data properties for custom objects.Custom objects endpointsAny Enterprise account
crm.objects.custom.highly_sensitive.writeEdit Highly Sensitive Data properties and values for custom objects.Custom objects endpointsAny Enterprise account
crm.objects.custom.readView details about custom objects.Custom objects endpointsAny Enterprise account
crm.objects.custom.sensitive.readView Sensitive Data properties for custom objects.Custom objects endpointsAny Enterprise account
crm.objects.custom.sensitive.writeEdit Sensitive Data properties and values for custom objects.Custom object endpointsAny Enterprise account
crm.objects.custom.writeCreate, delete, or make changes to custom objects.Custom objects endpointsAny Enterprise account
crm.objects.deals.highly_sensitive.readView Highly Sensitive Data properties for deals.Deals endpointsAny Enterprise account
crm.objects.deals.highly_sensitive.writeEdit Highly Sensitive Data properties and values for deals.Deals endpointsAny Enterprise account
crm.objects.deals.readView properties and other details about deals.Deals endpointsAny account
crm.objects.deals.sensitive.readView Sensitive Data properties for deals.Deals endpointsAny Enterprise account
crm.objects.deals.sensitive.writeEdit Sensitive Data properties and values for deals.Deals endpointsAny Enterprise account
crm.objects.deals.writeView properties and create, delete, or make changes to deals.Deals endpointsAny account
crm.objects.feedback_submission.readView details about submissions to any of your feedback surveys.Feedback surveys endpointsService Hub Professional or Enterprise
crm.objects.goals.readView all goal types.Goals endpointsSales Hub Starter, Professional, or Enterprise
crm.objects.invoices.readView details about invoices.Invoices endpointsAny account
crm.objects.leads.readView properties and other details about leads.Leads endpointsSales Hub Professional or Enterprise
crm.objects.leads.writeCreate, delete, or make changes to leads.Leads endpointsSales Hub Professional or Enterprise
crm.objects.line_items.readView properties and other details about line items.Line items endpointsAny account
crm.objects.line_items.writeCreate, delete, or make changes to line items.Line items endpointsAny account
crm.objects.listings.readView properties and other details about listings.Listings endpointsAny account
crm.objects.listings.writeCreate, delete, or make changes to listings.Listings endpointsAny account
crm.objects.marketing_events.readView details about marketing events.Marketing events endpointsAny account
crm.objects.marketing_events.writeCreate, delete, or make changes to marketing events.Marketing events endpointsAny account
crm.objects.orders.readView properties and other details about orders.Orders endpointsAny account
crm.objects.orders.writeCreate, delete, or make changes to orders.Orders endpointsAny account
crm.objects.owners.readView details about users assigned to a CRM record.Owners endpointsAny account
crm.objects.quotes.readView properties and other details about quotes and quote templates.Quotes endpointsAny account
crm.objects.quotes.writeCreate, delete, or make changes to quotes.Quotes endpointsAny account
crm.objects.services.readView properties and other details about services.Services endpointsAny account
crm.objects.services.writeCreate, delete, or make changes to services.Services endpointsAny account
crm.objects.subscriptions.readView properties and other details about commerce subscriptions.Commerce subscriptions endpointsAny account
crm.objects.users.readView properties and other details about users.Users endpointsAny account
crm.objects.users.writeCreate, delete, or make changes to users.Users endpointsAny account
crm.schemas.carts.readView details about property settings for carts.Carts endpointsAny account
crm.schemas.carts.writeCreate, delete, or make changes to property settings for carts.Carts endpointsAny account
crm.schemas.commercepayments.readView details about property settings for commerce payments.Commerce payments endpoints.Any Starter account
crm.schemas.companies.readView details about property settings for companiesProperties endpointsAny account
crm.schemas.companies.writeCreate, delete, or make changes to property settings for companies.Properties endpointsAny account
crm.schemas.contacts.readView details about property settings for contacts.Properties endpoints.Any account
crm.schemas.contacts.writeCreate, delete, or make changes to property settings for contacts.Properties endpointsAny account
crm.schemas.custom.readView details about custom object definitions in the HubSpot CRM.Custom objects endpointsAny Enterprise
crm.schemas.deals.readView details about property settings for deals.Properties endpointsAny account
crm.schemas.deals.writeCreate, delete, or make changes to property settings for deals.Properties endpointsAny account
crm.schema.invoices.readView details about property settings for invoices.Invoices endpointsAny account
crm.schemas.line_items.readView details about line items.Line items endpointsAny account
crm.schemas.quotes.readView details about quotes and quotes templates.Quotes endpointsAny account
crm.schemas.subscriptions.readView details about property settings for commerce subscriptions.Commerce subscriptions endpointsAny account
settings.billing.writeMake changes to your account's billing settings. This includes managing and assigning paid seats for users.Settings endpointsAny account
settings.currencies.readReads existing exchange rates along with the current company currency associated with your portal.Account information endpointsAny account
settings.currencies.writeCreate, update and delete exchange rates along with updating the company currency associated with your portal.Account information endpointsAny account
settings.users.readView details about account users and their permissions.User Provisioning endpointsAny account
settings.users.writeManage users and user permissions on your HubSpot account. This includes creating new users, assigning permissions and roles, and deleting existing users.User Provisioning endpointsAny account
settings.users.teams.readSee details about the account's teams.User Provisioning endpointsAny account
settings.users.team.writeAssign users to teams on your HubSpot account.User Provisioning endpointsAny account
account-info.security.readIncludes access to account activity logs and other account security information.Account activity APIAny account
accountingAllows HubSpot and the accounting integration to share invoice, product, and contact details.Accounting Extension APIAny account
actionsAdd forms to the contact's pages that do custom actions.CRM Extensions APIAny account
analytics.behavioral_events.sendIncludes access to send custom behavioral events.Analytics APIMarketing Hub Enterprise
automationThis includes workflows.Automation API (Workflows endpoints)Marketing Hub Professional or Enterprise
behavioral_events.event_definitions.read_writeCreate, read, update, or delete behavioral events. This includes behavioral event properties.Analytics APIMarketing Hub Enterprise
business_units.view.readView business unit data, including logo information.Business Units APIBusiness Units Add-on
business-intelligenceThis includes endpoints that sit on top of sources and email.Analytics APIAny account
collector.graphql_query.executeQuery data from your HubSpot account using the GraphQL API endpointGraphQL API endpointCMS Hub Professional or Enterprise
collector.graphql_schema.readPerform introspection queries via GraphQL application clients such as GraphiQLGraphiQL and other 3rd party GraphQL clientsCMS Hub Professional or Enterprise
communication_preferences.readView details of your contacts' subscription preferences.Subscription Preferences APIAny account
communication_preferences.read_writeSubscribe/unsubscribe contacts to your subscription types. It won't subscribe contacts who have unsubscribed.Subscription Preferences APIAny account
communication_preferences.writeSubscribe/unsubscribe contacts to your subscription types. It won't subscribe contacts who have unsubscribed.Subscription Preferences APIAny account
contentThis includes sites, landing pages, email, blog, and campaigns.CMS API and Calendar, Email and Email Events endpointsCMS Hub Professional or Enterprise, or Marketing Hub Professional or Enterprise
conversations.readView details about threads in the conversations inbox.Conversations inbox and messages APIAny account
conversations.visitor_identification.tokens.createFetch identification tokens for authenticated website visitors interacting with the HubSpot chat widget.Visitor Identification APIAny Professional or Enterprise
conversations.writeSend messages in conversations. Create and update message threads.Conversations inbox and messages APIAny account
crm.exportExport records from your CRM for all CRM data types.CRM Exports APIAny account
crm.importAllows you to import records into your CRM. This includes creating new records or modifying any of your existing records for all CRM data types (contacts, companies, deals, tickets, etc). It doesn't include archiving or deleting any data.CRM Imports APIAny account
ctas.readAllows read access for CTAs.No publicAPI availableMarketing Hub or CMS Hub Starter, Professional or Enterprise
e-commerceThis includes access to e-commerce features.Products and line items endpointsAny accountNote: Only Professional and Enterprise accounts can use this scope for the Products API.
external_integrations.forms.accessIncludes the ability to rename, delete, and clone existing forms.Forms endpointsAny account
filesThis includes access to File Manager.Files (File Manager) and file mapper (CMS templates, modules, and layout) endpointsAny account
files.ui_hidden.readView details or download user files, attachments, and system files from all HubSpot tools.Files (File Manager) and file mapper (CMS templates, modules, and layout) endpointsAny account
formsThis includes access to the Forms endpoints.Forms endpointsAny account
forms-uploaded-filesDownload files submitted through a form.Get a file uploaded via form submission endpointAny account
hubdbThis includes access to HubDB.HubDB endpointsCMS Hub Professional or Enterprise, or Marketing Hub Professional or Enterprise with Website Add-on
integration-syncThis exposes the sync API, which allows syncing of most CRM objects.Ecommerce Bridge APIAny account
marketing-emailGrants access to send marketing emails through the single-send APIMarketing emails APIMarketing Hub Enterprise or the transactional email add-on
media_bridge.readGrants access to events and objects from the media bridge.Media Bridge APIAny account
media_bridge.writeGrants access to create and update events and objects from the media bridge.Media Bridge APIAny account
oauthBasic scope required for OAuth. This scope is added by default to all apps.Any account
sales-email-readGrants access to read all details of one-to-one emails sent to contacts.Engagements endpointsNote: This scope is required to get the content of email engagements. See the Engagements overview for more details.Any account
socialThis includes Social Inbox.Social Media APIMarketing Hub Professional or Enterprise
ticketsThis includes access to tickets.Tickets endpointsAny account
tickets.highly_sensitiveGrants access to view and edit Highly Sensitive Data properties and values for tickets.Tickets endpointsAny Enterprise account
tickets.sensitiveGrants access to view and edit Sensitive Data properties and values for tickets.Tickets endpointsAny Enterprise account
timelineGrants access to manage custom events on HubSpot CRM records. This includes creating or updating records.Timeline Events endpointsAny account
transactional-emailThis includes transactional emails and the transactional emails endpoints.Transactional email endpoints**Marketing Hub** Professional or Enterprise with Transactional Email Add-on