Specifies a space-separated list of optional OAuth scopes to include in the authorization request.

Data Type

string

Default Value

"content social automation files forms timeline e-commerce business-intelligence tickets sales-email-read crm.objects.custom.read crm.objects.custom.write crm.schemas.custom.read crm.objects.feedback_submissions.read crm.objects.goals.read crm.objects.leads.read crm.objects.leads.write crm.objects.orders.read crm.objects.orders.write crm.schemas.orders.read crm.schemas.orders.write conversations.read conversations.write crm.objects.users.read settings.users.read settings.users.teams.read crm.objects.quotes.read crm.objects.quotes.write crm.schemas.quotes.read marketing.campaigns.read marketing.campaigns.write crm.objects.invoices.read crm.objects.invoices.write crm.objects.appointments.read crm.objects.appointments.write crm.schemas.appointments.read crm.schemas.appointments.write crm.objects.courses.read crm.objects.courses.write crm.schemas.courses.read crm.schemas.courses.write crm.objects.listings.read crm.objects.listings.write crm.schemas.listings.read crm.schemas.listings.write crm.objects.services.read crm.objects.services.write crm.schemas.services.read crm.schemas.services.write"

Remarks

This property defines a set of optional OAuth scopes that can be requested when connecting to HubSpot using OAuth 2.0. These scopes provide access to additional features or data types that are not required for basic functionality but may be useful depending on your use case.

HubSpot uses scopes to determine what your application is allowed to access, such as marketing emails, files, quotes, custom objects, and more. These permissions are presented to the user during the OAuth consent flow.

All scopes listed in this property are optional. If the user approves them, the corresponding permissions are included in the access and refresh tokens. If a scope is listed, but the user’s HubSpot account does not support it, the authorization still succeeds, but the resulting tokens do not include access to that feature.

You can modify this list to request access to specific optional features your application uses, such as quotes, forms, or custom objects. For example: "forms crm.objects.quotes.read".

Important: Scopes must be space-separated, not comma-separated. Using commas results in an invalid or incomplete authorization request. To learn more about available scopes and how to configure them, refer to the HubSpot API documentation for more details.