Get all pipelines for a specified object type

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Headers

Products:

CRM and Service Hub

This endpoint is used to get all pipelines for either deals or tickets. (These are currently the only supported object types for this endpoint.)

Use case for this endpoint: It can be used to sync all of a particular company's deal pipelines to an external system.

Note: This endpoint requires either the contacts scope (to fetch deals pipelines) or the tickets scope.

Required parameters	How to use	Description
OAuth access token or private app access token	Authorization: Bearer {token} header	Used to authenticate the request. Please see this page for more details about authentication.
Object type	/:object_type Used in the request URL	The object type that you want the pipelines for. Must be one of: deals tickets

Required parameters

How to use

Description

OAuth access token or private app access token

Authorization: Bearer {token} header

Used to authenticate the request. Please see this page for more details about authentication.

Object type

/:object_type
Used in the request URL

The object type that you want the pipelines for.

Must be one of:

Optional parameters	How to use	Description
Include inactive	&includeInactive= Used in the request URL	Whether or not to include inactive pipelines. Inactive pipelines and stages cannot be used when creating or updating objects. Must be one of: EXCLUDE_DELETED (default) INCLUDE_DELETED

Optional parameters

How to use

Description

Include inactive

&includeInactive=
Used in the request URL

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

Must be one of:

Developers