Get pipeline by ID

This method allows getting a single pipeline object by its ID.

Limitations
The method is available for all account users.

Authorization type
OAuth 2.0 with Access Token/ Long-lived token.

Data type header when the request is successful
Content-Type: application/hal+json

Data type header in case of an error
Content-Type: application/problem+json

Response parameters

ParameterData typeDescription
idintPipeline ID
namestringPipeline name
sortintPipeline sorting
is_mainboolDefines whether the pipeline is main for the account
is_unsorted_onboolDefines whether Incoming Leads are enabled
is_archiveboolDefines whether the pipeline is archived
account_idstringAccount ID the pipeline is located in
_embedded[statuses]arrayPipeline Stage data
Path Params
int32
required

Pipeline ID

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json