List deals

Retrieves a paginated list of deals.

Query Parameters

ParameterTypeDescription
pageintegerPage number (default: 1)
itemsPerPageintegerItems per page (default: 10)
archivedbooleanFilter by archived status
templatebooleanFilter template deals
searchstringFull-text search query (see below)

Full-Text Search

The search parameter performs a PostgreSQL full-text search with multi-language support (French, English).

Searchable fields:

FieldPriorityDescription
nameHighDeal name
numberHighDeal reference number
contactFullNameMediumContact person name
customer.firstNameNormalCustomer first name
customer.lastNameNormalCustomer last name
customer.emailNormalCustomer email
customer.customerCompany.nameNormalCustomer company name

Example:

?search=acme project

Filtering

This endpoint supports advanced filtering. See the Filter System Documentation for the complete list of operators and usage examples.

Quick examples:

?filters[name][contains]=project
?filters[value][gte]=1000
?filters[customer.firstName][eq]=John
?filters[customFields.priority][eq]=high

Response

Returns a paginated array of deals with the same fields as GET /api/deals/{id}.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
integer
boolean
boolean
string
Responses
200

Successful response

401

Unauthorized

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!