Pular para o conteúdo

Get Pipeline

GET
/api/v1/pipelines/{pipeline_id}

Get a specific pipeline by ID.

pipeline_id
required
Pipeline Id
integer
x-tenant-id
Any of:
integer

Successful Response

PipelineResponse

Schema for Pipeline response.

object
name
required
Name

Pipeline name

string
>= 1 characters <= 200 characters
description
Any of:
string
is_default
Is Default

Whether this is the default pipeline

boolean
is_active
Is Active

Whether this pipeline is active

boolean
default: true
id
required
Id
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
stages
Stages
Array<object>
default:
PipelineStageResponse

Schema for PipelineStage response.

object
name
required
Name

Stage name

string
>= 1 characters <= 200 characters
description
Any of:
string
order_index
Order Index

Sort order (0-based)

integer
0
color
Any of:
string
<= 20 characters
icon
Any of:
string
<= 50 characters
probability_default
Probability Default

Default win probability %

integer
0 <= 100
is_closed_stage
Is Closed Stage

Whether this is a final stage

boolean
is_won
Is Won

Whether this stage represents a win

boolean
id
required
Id
integer
pipeline_id
required
Pipeline Id
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string