Skip to content
em sa em sa

Get Board

GET
/api/pipeline/board
 
curl --request GET \
  --url 'https://example.com/api/pipeline/board?org_id=example' \
  --header 'Authorization: Bearer <token>'

Full board view — deals grouped by stage columns.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
org_id
required
Org Id

Organization UUID

string

Organization UUID

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
PipelineBoardResponse
object
stages
required
Stages
Array<object>
PipelineStageResponse
object
id
required
Id
string
name
required
Name
string
position
required
Position
integer
color
required
Color
string
is_terminal
required
Is Terminal
boolean
deal_count
Deal Count
integer
0
columns
required
Columns
object
key
additional properties
Array<object>
object
key
additional properties
any
total_deals
required
Total Deals
integer
Example 
{
  "stages": [
    {
      "deal_count": 0
    }
  ]
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}