Skip to content
HIPE Logo Developers - HIPE

Get opportunity pipelines

Prerequisites

Get the opportunity pipelines

To get the opportunity pipelines available in HIPE, you will need to make a GET request to the /api/pipelines endpoint. You need to specify the type of the pipeline you want to get in our case the opportunity.

Terminal window
curl --location 'https://{ YOUR INSTANCE }-hipe.packitoo.com/api/pipelines?type=opportunity' \
--header 'X-ACCESS-TOKEN: { YOUR ACCESS TOKEN }'

find more information in the API reference

Get the opportunity steps

Since you have the wanted opportunity pipeline, you can get the related steps by making a GET request to the /api/pipelines/{ pipelineId } endpoint.

In the response you will find the steps array with the steps of the opportunity pipeline.

{
    ...
    "steps": [
        ...
        {
            ...
            "id": "uuid",
            "name": string,
            "position": number
            ...
        }
        ...
    ]
    ...
}

You can found the other parameters in the API reference.