Get a deal

GET

https://api.brevo.com/v3/crm/deals/:id

GET

/v3/crm/deals/:id

1 curl https://api.brevo.com/v3/crm/deals/id \
2      -H "api-key: <apiKey>"

Try it

1 {
2   "attributes": {
3     "amount": 12,
4     "created_at": "2022-05-30T07:42:05.671Z",
5     "deal_name": "testname",
6     "deal_owner": "6093d2425a9b436e9519d034",
7     "deal_stage": "9e577ff7-8e42-4ab3-be26-2b5e01b42518",
8     "last_activity_date": "2022-06-06T08:38:36.000Z",
9     "last_updated_date": "2022-06-06T08:38:36.761Z",
10     "next_activity_date": null,
11     "number_of_activities": 0,
12     "number_of_contacts": 1,
13     "pipeline": "6093d296ad1e9c5cf2140a58",
14     "stage_updated_at": "2022-05-30T07:42:05.671Z"
15   },
16   "id": "629475917295261d9b1f4403",
17   "linkedCompaniesIds": [
18     "61a5ce58c5d4795761045990",
19     "61a5ce58c5d4795761045991",
20     "61a5ce58c5d4795761045992"
21   ],
22   "linkedContactsIds": [
23     1,
24     2,
25     3
26   ]
27 }

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

idstringRequired

Response

Returns the deal by id

attributesobject or null

Deal attributes with values

idstring or null

Unique deal id

linkedCompaniesIdslist of strings or null

Companies ids for companies linked to this deal

linkedContactsIdslist of integers or null

Contact ids for contacts linked to this deal

Authentication

Path parameters

Response

Errors