Pular para o conteúdo principal
GET
/
crm
/
pipelines
/
2026-03
/
{objectType}
/
{pipelineId}
/
stages
/
{stageId}
Retornar uma fase do pipeline por ID
curl --request GET \
  --url https://api.hubapi.com/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId} \
  --header 'Authorization: Bearer <token>'
{
  "archived": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "displayOrder": 123,
  "id": "<string>",
  "label": "<string>",
  "metadata": {},
  "updatedAt": "2023-11-07T05:31:56Z",
  "writePermissions": "CRM_PERMISSIONS_ENFORCEMENT",
  "archivedAt": "2023-11-07T05:31:56Z"
}

Supported products

Autorizações

Authorization
string
header
obrigatório

The access token received from the authorization server in the OAuth 2.0 flow.

Parâmetros de caminho

objectType
string
obrigatório
pipelineId
string
obrigatório
stageId
string
obrigatório

Resposta

successful operation

archived
boolean
obrigatório

Se o pipeline está arquivado ou não.

createdAt
string<date-time>
obrigatório

A data em que a fase do pipeline foi criada. As fases nos pipelines padrão terão createdAt = 0.

displayOrder
integer<int32>
obrigatório

A ordem para exibir esta fase do pipeline. Se duas fases do pipeline tiverem um "displayOrder" correspondente, elas serão classificadas em ordem alfabética pelo rótulo de associação.

id
string
obrigatório

Um identificador exclusivo gerado pelo HubSpot que pode ser usado para recuperar e atualizar a fase do pipeline.

label
string
obrigatório

Um rótulo usado para organizar fases de pipeline na UI do HubSpot. Cada rótulo de fase deve ser exclusivo dentro do pipeline.

metadata
object
obrigatório

Um objeto JSON contendo propriedades que não estão presentes em todos os pipelines de objeto.

Para pipelines de "deals", o campo "probability" é obrigatório ("{ "probability": 0.5 }"), e representa a probabilidade de um negócio ser fechado. Os valores possíveis estão entre 0,0 e 1,0 em incrementos de 0,1.

Para pipelines de "tickets", o campo "ticketState" é opcional ("{ "ticketState": "OPEN" }"), e representa se o ticket permanece aberto ou foi fechado por um membro da sua equipe de suporte. Os valores possíveis são "OPEN" ou "CLOSED".

updatedAt
string<date-time>
obrigatório

A data em que a fase do pipeline foi atualizada pela última vez.

writePermissions
enum<string>
obrigatório

Define o nível de acesso de gravação para a fase do pipeline, com os valores possíveis sendo CRM_PERMISSIONS_ENFORCEMENT, READ_ONLY ou INTERNAL_ONLY.

Opções disponíveis:
CRM_PERMISSIONS_ENFORCEMENT,
INTERNAL_ONLY,
READ_ONLY
archivedAt
string<date-time>

A data em que o pipeline foi arquivado. "archivedAt" somente estará presente se o pipeline estiver arquivado.

Last modified on April 13, 2026