Vixiees API

Sections

Theme switcher

Retrieves deals

Header Parameters

X-Api-Keystring

Query Parameters

pageinteger

Page number for pagination

Minimum
1
Default value
1
limitinteger

Number of records per page

Minimum
1
Maximum
100
Default value
25
order_bystring

Field to order results by

Default value
created_at
sortstring

Sort direction (asc or desc)

Default value
desc
Enum values:
ascdesc
contact_idstring

Filter deals by the ID of their contact

assignee_idstring

Filter deals by the ID of their assigned user

statusstring

Filter deals by status

Enum values:
openwonlost
wonboolean

Filter deals by whether they are won

closedboolean

Filter deals by whether they are closed

amount_minnumber

Filter deals with an amount greater than or equal to this value

amount_maxnumber

Filter deals with an amount less than or equal to this value

created_at_fromstring

Filter deals created at or after this date

created_at_tostring

Filter deals created at or before this date

updated_at_fromstring

Filter deals updated at or after this date

updated_at_tostring

Filter deals updated at or before this date

close_date_fromstring

Filter deals with a close date at or after this date

close_date_tostring

Filter deals with a close date at or before this date

Response

200
Object

deals found

Response Attributes

resultsarray

Show child attributes

page_infoobject

Show child attributes

400
Object

unsupported filter param

Response Attributes

errorsobject Required

Show child attributes

401
Object

unauthorized

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?