> ## Documentation Index
> Fetch the complete documentation index at: https://br.developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieves the roles on an account

> Recupere uma lista de funções de usuário disponíveis na sua conta HubSpot. Este endpoint fornece informações sobre os diferentes conjuntos de permissões que podem ser atribuídos aos usuários, o que é útil para gerenciar o acesso e as permissões de usuário na conta.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/2026-09/settings-user-provisioning-v2026-09.json GET /settings/users/2026-09/roles
openapi: 3.0.1
info:
  title: Settings User Provisioning
  description: Basepom for all HubSpot Projects
  version: 2026-09
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Basic
  - name: Roles
  - name: Seats
  - name: Teams
  - name: Users
paths:
  /settings/users/2026-09/roles:
    get:
      tags:
        - Roles
      summary: Recupera as funções em uma conta
      description: >-
        Recupere uma lista de funções de usuário disponíveis na sua conta
        HubSpot. Este endpoint fornece informações sobre os diferentes conjuntos
        de permissões que podem ser atribuídos aos usuários, o que é útil para
        gerenciar o acesso e as permissões de usuário na conta.
      operationId: get-/settings/users/2026-09/roles
      parameters: []
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/CollectionResponsePublicPermissionSetNoPaging
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - crm.objects.users.read
        - oauth2:
            - settings.users.read
components:
  schemas:
    CollectionResponsePublicPermissionSetNoPaging:
      required:
        - results
      type: object
      properties:
        results:
          type: array
          description: >-
            Uma matriz de objetos PublicPermissionSet, cada um representando um
            conjunto de permissões específico. Esta propriedade é obrigatória.
          items:
            $ref: '#/components/schemas/PublicPermissionSet'
    PublicPermissionSet:
      required:
        - id
        - name
        - requiresBillingWrite
      type: object
      properties:
        id:
          type: string
          description: >-
            O identificador exclusivo para o conjunto de permissões. É uma
            string.
        name:
          type: string
          description: O nome do conjunto de permissões. É uma string.
        requiresBillingWrite:
          type: boolean
          description: >-
            Um booleano que indica se o conjunto de permissões exige acesso de
            gravação de cobrança.
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: A categoria de erro, fornecendo uma classificação geral do erro.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: >-
            Contexto sobre a condição de erro, representado como um objeto com
            propriedades adicionais que são arrays de strings.
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            O identificador exclusivo da solicitação. Inclua este valor em
            relatórios de erro ou tickets de suporte. Ele é formatado como um
            UUID.
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: >-
            Mais informações sobre o erro, representadas como uma matriz de
            objetos ErrorDetail.
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um mapa de nomes de links para URIs associados que contêm
            documentação sobre o erro ou etapas de correção recomendadas.
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado.
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém detalhes mais específicos sobre
            o erro. Esta é uma propriedade de string.
      description: >-
        Representa uma resposta de erro retornada pela API quando uma operação
        falha. Este componente é usado em vários endpoints para fornecer
        informações detalhadas sobre o erro encontrado.
      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: O código de status associado ao detalhe do erro.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: >-
            Contexto sobre a condição de erro, representado como um objeto com
            propriedades adicionais. Cada propriedade é uma matriz de strings
            que fornece mais contexto.
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: O nome do campo ou parâmetro no qual o erro foi encontrado.
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado. Esta é uma propriedade de
            string obrigatória.
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém detalhes mais específicos sobre
            o erro. Esta é uma propriedade de string.
      description: >-
        Representa informações detalhadas sobre um erro ocorrido na API. Este
        componente é usado para fornecer contexto e detalhes adicionais sobre os
        erros, geralmente como parte de uma resposta de erro.
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            crm.objects.users.read: ''
            crm.objects.users.write: ''
            settings.billing.write: ''
            settings.users.read: ''
            settings.users.teams.read: ''
            settings.users.write: ''

````