Get Trade Tracking Pipeline by pipelineId
GET /api/v1/trade-tracking-pipeline/{pipeline}
Description
Retrieve details of a trade tracking pipeline by pipelineId.
Path Parameters
| Name | Type | Description |
|---|---|---|
pipelineId | string | The ID of the pipeline (path) |
Request Headers
| Name | Type | Description |
|---|---|---|
tenantId | string | The tenant ID (header) |
userId | string | The user ID (header) |
Example
GET /api/v1/trade-tracking-pipeline/{pipelineId}
tenantId: string
userId: string
Response Code: 200 - OK
Description
Successful retrieval of the trade tracking pipeline details.
Response Fields
| Field | Type | Description |
|---|---|---|
pipelineId | string | The ID of the pipeline |
name | string | The name of the pipeline |
description | string | A description of the pipeline |
status | string | The status of the pipeline |
Example
{
"pipelineId": "pipeline123",
"name": "Sample Pipeline",
"description": "This is a sample pipeline",
"status": "active"
}
Headers
| Content-Type | Value |
|---|---|
| tenantId | string |
| userId | string |
🔑 Authentication bearer
| Param | Value | Type |
|---|---|---|
| token | {{accessCode}} | string |
LANGUAGE
CURL REQUEST
curl --request GET \
--url /api/v1/trade-tracking-pipeline/{pipeline} \
--header 'accept: application/json' \
--header 'content-type: application/json'
RESPONSE
Click Try It! to start a request and see the response here!