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"
}
]
}
]
}Alle Pipelines für den durch „“ angegebenen Objekttyp zurückgeben
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"
}
]
}
]
}Unterstützte Produkte
Erforderliche Bereiche
The access token received from the authorization server in the OAuth 2.0 flow.
Der Objekttyp der Pipelines, die abgerufen werden (z. B. Deals oder Tickets)
successful operation
Anzeigen untergeordnete attribute
Ob die Pipeline archiviert ist.
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
Die der Pipeline zugeordneten Phasen. Diese können über die Pipeline-Phasen-Endpunkte abgerufen und aktualisiert werden.
Anzeigen untergeordnete attribute
Whether the pipeline is archived.
Das Datum, an dem die Pipeline-Phase erstellt wurde. Für die Phasen von Standard-Pipelines gilt createdAt = 0.
Die Reihenfolge, in der diese Pipeline-Phase angezeigt wird. Wenn „displayOrder“ bei zwei Pipeline-Phasen übereinstimmt, werden sie alphabetisch nach Label sortiert.
Eine von HubSpot generierte eindeutige ID, die zum Abrufen und Aktualisieren der Pipeline-Phase verwendet werden kann
Ein Label zum Organisieren von Pipeline-Phasen in der HubSpot-Benutzeroberfläche. Das Label jeder Pipeline-Phase muss innerhalb dieser Pipeline eindeutig sein.
Ein JSON-Objekt mit Eigenschaften, die nicht in allen Objekt-Pipelines vorhanden sind.
Bei Deal-Pipelines ist das Feld „probability“ ein Pflichtfeld ({ "probability": 0.5 }). Es zeigt die Wahrscheinlichkeit an, mit der ein Deal abgeschlossen wird. Mögliche Werte liegen zwischen 0,0 und 1,0 in Schritten von 0,1.
Bei Ticket-Pipelines ist das Feld „ticketState“ optional ({ "ticketState": "OPEN" }). Es zeigt an, ob das Ticket noch offen ist oder von einem Mitglied Ihres Support-Teams geschlossen wurde. Mögliche Werte sind OFFEN oder GESCHLOSSEN.
Anzeigen untergeordnete attribute
Das Datum, an dem die Pipeline-Phase zuletzt aktualisiert wurde
Das Datum, an dem die Pipeline archiviert ist. „archivedAt“ ist nur vorhanden, wenn die Pipeline archiviert ist.
Definiert die Ebene des Schreibzugriffs für die Pipeline-Phase. Mögliche Werte sind „CRM_PERMISSIONS_ENFORCEMENT“, „READ_ONLY“ oder „INTERNAL_ONLY“.
CRM_PERMISSIONS_ENFORCEMENT, INTERNAL_ONLY, READ_ONLY Das Datum, an dem die Pipeline zuletzt aktualisiert wurde
Das Datum, an dem die Pipeline archiviert ist. „archivedAt“ ist nur vorhanden, wenn die Pipeline archiviert ist.