Email Support
API Docs
Start typing to search…

List deals

get
https://app.rotabull.com/api/v1/deals

Get deals. A deal is composed of an RFQ and possibly a Quote. The list of Deals can be filtered with both path parameters and query parameters. The query parameters are optional.

Will return an empty 200 response if there are no results.

Query Params
string

Additional filters. Example: part_number:~12345|received_date:>YYYY-MM-DD|deal_source:iEmail.

For more examples of additional filters, please see the following page: https://support.rotabull.com/reference/search-and-filters

string
enum
Defaults to all

The filter to apply to the deal results (defaults to "all").

Allowed:
string

The start date or datetime of a range to search, in which a deal was created. Format: YYYY-MM-DD HH:MM:SS or ISO 8601 (YYYY-MM-DDTHH:MM:SS, YYYY-MM-DDTHH:MM:SSZ)

string

The end date or datetime of a range to search, in which a deal was created. Format: YYYY-MM-DD HH:MM:SS or ISO 8601 (YYYY-MM-DDTHH:MM:SS, YYYY-MM-DDTHH:MM:SSZ)

integer

Team ID.

integer
Defaults to 20

Maximum number of results to return. 20 is the default if not specified. 300 is the maximum allowed.

string

The latest Deal UID encoded in Base64

string

Field and direction. 'inserted_at' sorts deals earliest to latest. '-inserted_at' sorts deals latest to earliest (this is the default if no sort is provided). If filter is set to "quoted", 'quote.inserted_at' sorts quoted deals earliest to latest, and '-quote.inserted_at' sorts quoted deals latest to earliest.

integer

Priority of the RFQ. Score from 1 (lowest priority) - 3 (highest priority).

boolean
Defaults to true

Include the smart quote status for each deal. Defaults to 'true'. Setting to 'false' may improve the performance of this API call.

boolean
Defaults to false

Include the RFQ draft fields for each deal. Defaults to 'false'.

Responses

Callback

Updated 5 months ago

Language
Credentials
Header
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago