Get all pipelines for a specified object type

GET /crm-pipelines/v1/pipelines/:object_type

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

CRM and Service Hub

Get all of the pipelines for the specified object type. This currently supports pipelines for deals and tickets.
Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header or hapikey={key} query parameter. 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

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