List Deals

GET

/api/v1/deals

• API de Produção

List deals with filters and pagination.

New filters:

• pipeline_id: Filter by pipeline (customizable pipelines)
• stage_id: Filter by stage (customizable stages)

Legacy filter (deprecated):

• stage: Filter by old enum stage (will be removed in future)

Authorizations

• HTTPBearer

Parameters

Query Parameters

page

Page

integer

default: 1 >= 1

per_page

Per Page

integer

default: 20 >= 1 <= 100

pipeline_id

Any of:

integer

integer

null

null

stage_id

Any of:

integer

integer

null

null

stage

Any of:

DealStage

DealStage

Sales pipeline stages

string

Allowed values: lead contact proposal negotiation closed_won closed_lost

null

null

priority

Any of:

DealPriority

DealPriority

Deal priority levels

string

Allowed values: low medium high urgent

null

null

user_id

Any of:

integer

integer

null

null

contact_id

Any of:

integer

integer

null

null

company_id

Any of:

integer

integer

null

null

min_value

Any of:

number

number

null

null

max_value

Any of:

number

number

null

null

Header Parameters

x-tenant-id

Any of:

integer

integer

null

null

Responses

200

Successful Response

DealListResponse

Schema for paginated deal list

object

total

required

Total

integer

page

required

Page

integer

per_page

required

Per Page

integer

deals

required

Deals

Array<object>

DealResponse

Schema for deal response

object

title

required

Title

string

>= 1 characters <= 500 characters

description

Any of:

string

string

null

null

value

required

Value

Deal value, must be greater than 0

string

currency

Currency

string

default: BRL >= 3 characters <= 3 characters

probability

Probability

Closing probability 0-100%

integer

0 <= 100

expected_close_date

Any of:

string

string format: date

null

null

stage

string

Allowed values: lead contact proposal negotiation closed_won closed_lost

priority

string

Allowed values: low medium high urgent

contact_id

Any of:

integer

integer

null

null

company_id

Any of:

integer

integer

null

null

user_id

Any of:

integer

integer

null

null

products

Any of:

Array<object>

Array<object>

object

null

null

lost_reason

Any of:

string

string

<= 500 characters

null

null

source

Any of:

string

string

<= 100 characters

null

null

id

required

Id

integer

created_at

required

Created At

string format: date-time

updated_at

Any of:

string

string format: date-time

null

null

closed_at

Any of:

string

string format: date-time

null

null

pipeline_id

Any of:

integer

integer

null

null

stage_id

Any of:

integer

integer

null

null

weighted_value

required

Weighted Value

number

health_score

required

Health Score

integer

is_closed

required

Is Closed

boolean

is_won

required

Is Won

boolean

is_lost

required

Is Lost

boolean

contact_name

Any of:

string

string

null

null

company_name

Any of:

string

string

null

null

user_name

Any of:

string

string

null

null

custom_fields

Any of:

object

object

null

null

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string