Skip to content
/
Get Pipeline by id

Get Pipeline by id

Request

Fetches pipeline by id to support sales forecasting and resource planning.

Security
ApiKey
Path
idstring, (uuid)required

ID of the resource

curl -i -X GET \
  'https://developer.getparallax.com/_mock/api-documentation/swagger/v1/pipelines/{id}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring, (uuid)

The unique identifier of the Pipeline in Parallax.

namestring

The name of the Pipeline, typically reflecting the sales funnel or opportunity workflow.

currency_codestring

The ISO currency code associated with the Pipeline, used for financial values tied to deals.

is_enabledboolean

Indicates whether syncs for this Pipeline are enabled; differs from IsArchived.

archivedboolean

Indicates whether the Pipeline is archived and no longer active in Parallax.

Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "currency_code": "string",
  "is_enabled": true,
  "archived": true
}