Introduction
- Getting started
Email API
Transactional SMS
Transactional WhatsApp
Marketing Campaigns
Contact Management
Events
Object Management
Accounts and Settings
Sales CRM
Conversations
Ecommerce
Loyalty

Get a deal

GET

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

GET

/v3/crm/deals/:id

1 import { BrevoClient } from "@getbrevo/brevo";
2 
3 async function main() {
4     const client = new BrevoClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.deals.getADeal("id");
8 }
9 main();

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     "number_of_activities": 0,
11     "number_of_contacts": 1,
12     "pipeline": "6093d296ad1e9c5cf2140a58",
13     "stage_updated_at": "2022-05-30T07:42:05.671Z"
14   },
15   "id": "629475917295261d9b1f4403",
16   "linkedCompaniesIds": [
17     "61a5ce58c5d4795761045990",
18     "61a5ce58c5d4795761045991",
19     "61a5ce58c5d4795761045992"
20   ],
21   "linkedContactsIds": [
22     1,
23     2,
24     3
25   ]
26 }

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

Deal attributes with values

idstring

Unique deal id

linkedCompaniesIdslist of strings

Companies ids for companies linked to this deal

linkedContactsIdslist of integers

Contact ids for contacts linked to this deal

Errors

400

Bad Request Error

404

Not Found Error