curl --request GET \
--url https://api.hubapi.com/crm/v3/pipelines/{objectType} \
--header 'Authorization: Bearer <token>'{
"results": [
{
"label": "My ticket pipeline",
"displayOrder": 0,
"createdAt": "2019-10-30T03:30:17.883Z",
"updatedAt": "2019-12-07T16:50:06.678Z",
"archived": false,
"id": "812723471",
"stages": [
{
"label": "In Progress",
"displayOrder": 0,
"metadata": {
"ticketState": "OPEN"
},
"createdAt": "2019-10-30T03:30:17.883Z",
"updatedAt": "2019-12-07T16:50:06.678Z",
"archived": false,
"id": "1234912"
},
{
"label": "Done",
"displayOrder": 0,
"metadata": {
"ticketState": "CLOSED"
},
"createdAt": "2019-10-30T03:30:17.883Z",
"updatedAt": "2019-12-07T16:50:06.678Z",
"archived": false,
"id": "1234914"
}
]
}
]
}Retorne todos os pipelines para o objeto especificado por "".
curl --request GET \
--url https://api.hubapi.com/crm/v3/pipelines/{objectType} \
--header 'Authorization: Bearer <token>'{
"results": [
{
"label": "My ticket pipeline",
"displayOrder": 0,
"createdAt": "2019-10-30T03:30:17.883Z",
"updatedAt": "2019-12-07T16:50:06.678Z",
"archived": false,
"id": "812723471",
"stages": [
{
"label": "In Progress",
"displayOrder": 0,
"metadata": {
"ticketState": "OPEN"
},
"createdAt": "2019-10-30T03:30:17.883Z",
"updatedAt": "2019-12-07T16:50:06.678Z",
"archived": false,
"id": "1234912"
},
{
"label": "Done",
"displayOrder": 0,
"metadata": {
"ticketState": "CLOSED"
},
"createdAt": "2019-10-30T03:30:17.883Z",
"updatedAt": "2019-12-07T16:50:06.678Z",
"archived": false,
"id": "1234914"
}
]
}
]
}Produtos suportados
Escopos Necessários
The access token received from the authorization server in the OAuth 2.0 flow.
O tipo de objeto dos fluxos de trabalho que estão sendo recuperados (ex.: negócios ou tickets)
successful operation
Mostrar atributos filhos
Se o pipeline está arquivado ou não.
The date the pipeline was created. The default pipelines will have createdAt = 0.
The order for displaying this pipeline. If two pipelines have a matching displayOrder, they will be sorted alphabetically by label.
A unique identifier generated by HubSpot that can be used to retrieve and update the pipeline.
A unique label used to organize pipelines in HubSpot's UI
As fases associadas ao pipeline. Podem ser recuperadas e atualizadas através dos pontos de extremidade de fases do pipeline.
Mostrar atributos filhos
Whether the pipeline is archived.
A data em que a fase do pipeline foi criada. As fases nos pipelines padrão terão createdAt = 0.
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.
Um identificador exclusivo gerado pelo HubSpot que pode ser usado para recuperar e atualizar a fase do pipeline.
Um rótulo usado para organizar fases de pipeline na UI do HubSpot. Cada rótulo de fase deve ser exclusivo dentro do pipeline.
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".
Mostrar atributos filhos
A data em que a fase do pipeline foi atualizada pela última vez.
A data em que o pipeline foi arquivado. "archivedAt" somente estará presente se o pipeline estiver arquivado.
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.
CRM_PERMISSIONS_ENFORCEMENT, INTERNAL_ONLY, READ_ONLY A data em que o pipeline foi atualizado pela última vez.
A data em que o pipeline foi arquivado. "archivedAt" somente estará presente se o pipeline estiver arquivado.