GET
/
crm-pipelines
/
v1
/
pipelines
/
{object_type}
Get all pipelines for a specified object type
curl --request GET \
  --url https://api.hubapi.com/crm-pipelines/v1/pipelines/{object_type}
{
  "results": [
    {
      "pipelineId": "<string>",
      "createdAt": 123,
      "updatedAt": 123,
      "objectType": "DEAL",
      "label": "<string>",
      "displayOrder": 123,
      "active": true,
      "default": true,
      "stages": [
        {
          "stageId": "<string>",
          "createdAt": 123,
          "updatedAt": 123,
          "label": "<string>",
          "displayOrder": 123,
          "active": true,
          "metadata": {
            "probability": 0.5
          }
        }
      ]
    }
  ]
}

Path Parameters

​
object_type
enum<string>
required

The object type that you want the pipelines for. Must be one of: deals, tickets

Available options:
deals,
tickets

Query Parameters

​
includeInactive
enum<string>
default:EXCLUDE_DELETED

Whether or not to include inactive pipelines. Inactive pipelines and stages cannot be used when creating or updating objects.

Available options:
EXCLUDE_DELETED,
INCLUDE_DELETED

Response

200 - application/json

Successful response with pipelines for the specified object type

The response is of type object.