> ## 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.

# Retrieve permissions

> Recupere as permissões de edição de fase para um pipeline específico na sua conta HubSpot. Este endpoint permite visualizar as permissões definidas para a edição de fases dentro de um determinado pipeline, identificado pelo seu tipo de objeto e ID do pipeline. Isso pode ser útil para gerenciar o acesso e garantir que apenas usuários autorizados possam modificar as fases do pipeline.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/2026-09/crm-pipeline-governance-v2026-09.json GET /crm/pipelines-rules/2026-09/{objectTypeId}/{pipelineId}/stage-edit-permissions
openapi: 3.0.1
info:
  title: CRM Pipeline Governance
  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: Advanced
  - name: Basic
paths:
  /crm/pipelines-rules/2026-09/{objectTypeId}/{pipelineId}/stage-edit-permissions:
    get:
      tags:
        - Basic
      summary: Recuperar permissões
      description: >-
        Recupere as permissões de edição de fase para um pipeline específico na
        sua conta HubSpot. Este endpoint permite visualizar as permissões
        definidas para a edição de fases dentro de um determinado pipeline,
        identificado pelo seu tipo de objeto e ID do pipeline. Isso pode ser
        útil para gerenciar o acesso e garantir que apenas usuários autorizados
        possam modificar as fases do pipeline.
      operationId: >-
        get-/crm/pipelines-rules/2026-09/{objectTypeId}/{pipelineId}/stage-edit-permissions
      parameters:
        - name: objectTypeId
          in: path
          description: >-
            O identificador exclusivo do tipo de objeto para o qual as
            permissões de edição de fase do pipeline estão sendo recuperadas.
          required: true
          style: simple
          explode: false
          schema:
            type: string
        - name: pipelineId
          in: path
          description: >-
            O identificador exclusivo do pipeline cujas permissões de edição de
            fase estão sendo recuperadas.
          required: true
          style: simple
          explode: false
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicPipelineStagePermissions'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - crm.pipelines.stage_permissions.read
components:
  schemas:
    PublicPipelineStagePermissions:
      required:
        - createdAt
        - id
        - objectTypeId
        - pipelineId
        - stages
        - updatedAt
      type: object
      properties:
        createdAt:
          type: string
          description: >-
            A data e hora em que essas permissões foram criadas, no formato ISO
            8601.
          format: date-time
        id:
          type: string
          description: >-
            O identificador exclusivo do conjunto de permissões de fase do
            pipeline.
        objectTypeId:
          type: string
          description: O identificador para o tipo de objeto associado a estas permissões.
        pipelineId:
          type: string
          description: >-
            O identificador exclusivo para o pipeline ao qual estas permissões
            de fase se aplicam.
        stages:
          type: array
          description: >-
            Uma matriz de permissões de fase, cada uma definindo regras de
            acesso para uma fase específica dentro do pipeline.
          items:
            $ref: '#/components/schemas/PublicStagePermission'
        updatedAt:
          type: string
          description: >-
            Data e hora da última atualização dessas permissões, no formato ISO
            8601.
          format: date-time
    PublicStagePermission:
      required:
        - label
        - permissionMode
        - pipelineStageId
        - superAdmin
        - teamIds
        - userIds
      type: object
      properties:
        label:
          type: string
          description: >-
            Um rótulo descritivo para a fase, usado para fins de exibição. É uma
            string que ajuda a identificar o propósito ou a função da fase.
        permissionMode:
          type: string
          description: >-
            Define o modo de permissão para a fase. É uma string que pode ser
            "OPEN" ou "RESTRICTED", indicando se a fase é acessível a todos os
            usuários ou restrita a determinados usuários ou equipes.
          enum:
            - OPEN
            - RESTRICTED
        pipelineStageId:
          type: string
          description: >-
            O identificador exclusivo para a fase do pipeline. É uma string que
            distingue esta fase das outras dentro do pipeline.
        superAdmin:
          type: boolean
          description: >-
            Um valor booleano que indica se os superadministradores têm acesso a
            esta fase. Se for verdadeiro, os superadministradores podem acessar
            a fase independentemente de outras permissões.
        teamIds:
          type: array
          description: >-
            Uma matriz de strings que representa os IDs das equipes que têm
            acesso a esta fase. Esta propriedade é usada para especificar quais
            equipes podem interagir com a fase.
          items:
            type: string
        userIds:
          type: array
          description: >-
            Uma matriz de strings que representam os IDs de usuários individuais
            que têm acesso a esta fase. Esta propriedade permite especificar o
            controle de acesso no nível do usuário.
          items:
            type: string
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: Uma string que representa a categoria geral do erro.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: >-
            Um objeto que inclui contexto adicional sobre a condição de erro,
            com propriedades como matrizes de strings.
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Uma string que identifica de forma exclusiva a solicitação para fins
            de rastreamento e depuração.
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: >-
            Uma matriz de objetos ErrorDetail que fornecem informações
            detalhadas sobre cada erro encontrado.
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um objeto que contém links relacionados, em que cada chave é uma
            string e o valor é uma string que representa um URL.
        message:
          type: string
          description: >-
            Uma string contendo uma mensagem legível por humanos que descreve o
            erro.
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Uma string que fornece detalhes mais específicos sobre a categoria
            do erro.
      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. Esta é uma
            propriedade de string.
        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 detalhes.
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: >-
            O nome do campo ou parâmetro no qual o erro foi encontrado. Esta é
            uma propriedade de string.
        message:
          type: string
          description: >-
            Uma mensagem legível descrevendo o erro, juntamente com as etapas de
            correção, quando apropriado. É 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.pipelines.approval.read: ''
            crm.pipelines.governance.read: ''
            crm.pipelines.governance.write: ''
            crm.pipelines.stage_permissions.read: ''
            crm.pipelines.stage_permissions.write: ''

````