Get a company

GET

https://api.brevo.com/v3/companies/:id

GET

/v3/companies/: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.companies.getACompany("id");
8 }
9 main();

1 {
2   "attributes": {
3     "created_at": "2022-01-13T19:04:24.376+05:30",
4     "domain": "xyz",
5     "last_updated_at": "2022-04-01T18:47:48.283+05:30",
6     "name": "text",
7     "number_of_contacts": 0,
8     "owner": "62260474111b1101704a9d85",
9     "owner_assign_date": "2022-04-01T18:21:13.379+05:30",
10     "phone_number": 8171844192,
11     "revenue": 10
12   },
13   "id": "629475917295261d9b1f4403",
14   "linkedContactsIds": [
15     1,
16     2,
17     3
18   ],
19   "linkedDealsIds": [
20     "61a5ce58c5d4795761045990",
21     "61a5ce58c5d4795761045991",
22     "61a5ce58c5d4795761045992"
23   ]
24 }

Retrieve the full details of a single company by its identifier, including its attributes, linked contacts, and linked deals. Returns a 404 error if the company does not exist, or a 403 error if the user lacks permission to view the company.

Authentication

api-keystring

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

Path parameters

idstringRequired

Get Company Details

Response

Returns the Company

attributesobjectOptional

Company attributes with values

idstringOptional

Unique company id

linkedContactsIdslist of integersOptional

Contact ids for contacts linked to this company

linkedDealsIdslist of stringsOptional

Deal ids for deals linked to this company

Errors

400

Bad Request Error

404

Not Found Error