Deals
Get all deals
get/crm/deals
Query parameters
filters[attributes.deal_name]string
Filter by attributes. If you have a filter for the owner on your end, please send it as filters[attributes.deal_owner] and utilize the account email for the filtering.
filters[linkedCompaniesIds]string
Filter by linked companies ids
filters[linkedContactsIds]string
Filter by linked companies ids
offsetinteger
Index of the first document of the page
limitinteger
Number of documents per page
sort'asc' | 'desc'
Sort the results in the ascending/descending order. Default order is descending by creation if sort is not passed
sortBystring
The field used to sort field names.
Response
Returns deals list with filters
Example response
{
"items": [
{
"linkedCompaniesIds": [
"61a5ce58c5d4795761045990",
"61a5ce58c5d4795761045991",
"61a5ce58c5d4795761045992"
],
"linkedContactsIds": [
1,
2,
3
],
"attributes": {
"deal_name": "testname",
"deal_owner": "6093d2425a9b436e9519d034",
"amount": 12,
"pipeline": "6093d296ad1e9c5cf2140a58",
"deal_stage": "9e577ff7-8e42-4ab3-be26-2b5e01b42518",
"stage_updated_at": "2022-05-30T07:42:05.671Z",
"created_at": "2022-05-30T07:42:05.671Z",
"number_of_contacts": 1,
"last_updated_date": "2022-06-06T08:38:36.761Z",
"last_activity_date": "2022-06-06T08:38:36.000Z",
"number_of_activities": 0
},
"id": "629475917295261d9b1f4403"
},
{
"linkedCompaniesIds": [
"61a5ce58c5d4795761045990",
"61a5ce58c5d4795761045991",
"61a5ce58c5d4795761045992"
],
"linkedContactsIds": [
1,
2,
3
],
"attributes": {
"deal_name": "testname",
"deal_owner": "6093d2425a9b436e9519d034",
"amount": 12,
"pipeline": "6093d296ad1e9c5cf2140a58",
"deal_stage": "9e577ff7-8e42-4ab3-be26-2b5e01b42518",
"stage_updated_at": "2022-05-30T07:42:05.671Z",
"created_at": "2022-05-30T07:42:05.671Z",
"number_of_contacts": 1,
"last_updated_date": "2022-06-06T08:38:36.761Z",
"last_activity_date": "2022-06-06T08:38:36.000Z",
"number_of_activities": 0
},
"id": "629475917295261d9b1f4403"
}
]
}