Zum Hauptinhalt springen
GET
/
crm
/
v3
/
pipelines
/
{objectType}
/
{pipelineId}
Retornar um pipeline por ID
curl --request GET \
  --url https://api.hubapi.com/crm/v3/pipelines/{objectType}/{pipelineId} \
  --header 'Authorization: Bearer <token>'
{
  "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

Requer um dos seguintes produtos ou superior.
Marketing HubMarketing Hub -Grátis
Sales HubSales Hub -Grátis
Service HubService Hub -Grátis
Content HubContent Hub -Starter
Esta API requer um dos seguintes escopos:
automation
crm.objects.appointments.read
crm.objects.appointments.sensitive.read.v2
crm.objects.appointments.sensitive.write.v2
crm.objects.appointments.write
crm.objects.carts.read
crm.objects.commercepayments.write
crm.objects.companies.highly_sensitive.read.v2
crm.objects.companies.highly_sensitive.write.v2
crm.objects.companies.read
crm.objects.companies.sensitive.read.v2
crm.objects.companies.sensitive.write.v2
crm.objects.companies.write
crm.objects.contacts.highly_sensitive.read.v2
crm.objects.contacts.highly_sensitive.write.v2
crm.objects.contacts.read
crm.objects.contacts.sensitive.read.v2
crm.objects.contacts.sensitive.write.v2
crm.objects.contacts.write
crm.objects.courses.read
crm.objects.courses.write
crm.objects.custom.highly_sensitive.read.v2
crm.objects.custom.highly_sensitive.write.v2
crm.objects.custom.read
crm.objects.custom.sensitive.read.v2
crm.objects.custom.sensitive.write.v2
crm.objects.custom.write
crm.objects.deals.highly_sensitive.read.v2
crm.objects.deals.highly_sensitive.write.v2
crm.objects.deals.read
crm.objects.deals.sensitive.read.v2
crm.objects.deals.sensitive.write.v2
crm.objects.deals.write
crm.objects.feedback_submissions.read
crm.objects.goals.read
crm.objects.goals.write
crm.objects.invoices.read
crm.objects.invoices.write
crm.objects.leads.read
crm.objects.leads.write
crm.objects.line_items.read
crm.objects.line_items.write
crm.objects.listings.read
crm.objects.listings.write
crm.objects.marketing_events.read
crm.objects.marketing_events.write
crm.objects.orders.read
crm.objects.owners.read
crm.objects.products.write
crm.objects.quotes.read
crm.objects.quotes.write
crm.objects.services.read
crm.objects.services.write
crm.objects.subscriptions.read
crm.objects.subscriptions.write
crm.objects.users.read
crm.pipelines.orders.read
crm.schemas.appointments.read
crm.schemas.carts.read
crm.schemas.commercepayments.read
crm.schemas.companies.read
crm.schemas.contacts.read
crm.schemas.courses.read
crm.schemas.custom.read
crm.schemas.deals.read
crm.schemas.invoices.read
crm.schemas.line_items.read
crm.schemas.listings.read
crm.schemas.orders.read
crm.schemas.quotes.read
crm.schemas.services.read
crm.schemas.subscriptions.read
e-commerce
media_bridge.read
tickets
tickets.highly_sensitive.v2
tickets.sensitive.v2
timeline

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
objectType
string
required
​
pipelineId
string
required

Response

successful operation

A pipeline definition.

​
createdAt
string<date-time>
required

The date the pipeline was created. The default pipelines will have createdAt = 0.

Example:

"2019-10-30T03:30:17.883+00:00"

​
archived
boolean
required

Se o pipeline está arquivado ou não.

Example:

false

​
displayOrder
integer
required

The order for displaying this pipeline. If two pipelines have a matching displayOrder, they will be sorted alphabetically by label.

Example:

0

​
stages
object[]
required

As fases associadas ao pipeline. Podem ser recuperadas e atualizadas através dos pontos de extremidade de fases do pipeline.

Example:

"[{\"id\":\"1234912\",\"label\":\"In Progress\",\"archived\":false,\"metadata\":{\"ticketState\":\"OPEN\"},\"createdAt\":\"2019-10-30T03:30:17.883Z\",\"updatedAt\":\"2019-12-07T16:50:06.678Z\",\"displayOrder\":0},{\"id\":\"1234914\",\"label\":\"Done\",\"archived\":false,\"metadata\":{\"ticketState\":\"CLOSED\"},\"createdAt\":\"2019-10-30T03:30:17.883Z\",\"updatedAt\":\"2019-12-07T16:50:06.678Z\",\"displayOrder\":0}]"

​
label
string
required

A unique label used to organize pipelines in HubSpot's UI

Example:

"My ticket pipeline"

​
id
string
required

A unique identifier generated by HubSpot that can be used to retrieve and update the pipeline.

Example:

"812723471"

​
updatedAt
string<date-time>
required

A data em que o pipeline foi atualizado pela última vez.

Example:

"2019-12-07T16:50:06.678+00:00"

​
archivedAt
string<date-time>

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

⌘I