younifyd
Menu

Get /crm/v3/pipelines/{object Type} Get All

Retrieve all pipelines

GET/crm/v3/pipelines/{objectType}

Use it in a workflow

  1. Add a step and choose the HubSpot connector.
  2. Pick the Get /crm/v3/pipelines/{object Type} Get All action (under Pipelines).
  3. Fill in the fields below, then reference the result from later steps as {{getCrmV3PipelinesObjectTypeGetAll.response.data}}.

Request

Path parameters

objectTypestringrequired

Response

Returns 200 with an object. Read it in later steps with {{getCrmV3PipelinesObjectTypeGetAll.response.data.<field>}}.

resultsarray<object>
archivedbooleanrequired

Whether the pipeline is archived.

archivedAtstring (date-time)

The date the pipeline was archived. `archivedAt` will only be present if the pipeline is archived.

createdAtstring (date-time)required

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

displayOrderinteger (int32)required

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

idstringrequired

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

labelstringrequired

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

stagesarray<object>required9 fields

The stages associated with the pipeline. They can be retrieved and updated via the pipeline stages endpoints.

updatedAtstring (date-time)required

The date the pipeline was last updated.

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

Need more? See the HubSpot guide for connection setup and behaviour shared by every action.