Get all Companies | Brevo API Documentation

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.companies.getAllCompanies({});
}
main();

{
  "items": [
    {
      "attributes": {
        "created_at": "2022-01-13T19:04:24.376+05:30",
        "domain": "xyz",
        "last_updated_at": "2022-04-01T18:47:48.283+05:30",
        "name": "text",
        "number_of_contacts": 0,
        "owner": "62260474111b1101704a9d85",
        "owner_assign_date": "2022-04-01T18:21:13.379+05:30",
        "phone_number": 8171844192,
        "revenue": 10
      },
      "id": "629475917295261d9b1f4403",
      "linkedContactsIds": [
        1,
        2,
        3
      ],
      "linkedDealsIds": [
        "61a5ce58c5d4795761045990",
        "61a5ce58c5d4795761045991",
        "61a5ce58c5d4795761045992"
      ]
    }
  ]
}

Retrieve a paginated list of companies with optional filtering, sorting, and search capabilities. Results are sorted by creation date in descending order by default, and can be filtered by attributes, linked contacts, linked deals, or modification/creation timestamps.

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.companies.getAllCompanies({});
}
main();

{
  "items": [
    {
      "attributes": {
        "created_at": "2022-01-13T19:04:24.376+05:30",
        "domain": "xyz",
        "last_updated_at": "2022-04-01T18:47:48.283+05:30",
        "name": "text",
        "number_of_contacts": 0,
        "owner": "62260474111b1101704a9d85",
        "owner_assign_date": "2022-04-01T18:21:13.379+05:30",
        "phone_number": 8171844192,
        "revenue": 10
      },
      "id": "629475917295261d9b1f4403",
      "linkedContactsIds": [
        1,
        2,
        3
      ],
      "linkedDealsIds": [
        "61a5ce58c5d4795761045990",
        "61a5ce58c5d4795761045991",
        "61a5ce58c5d4795761045992"
      ]
    }
  ]
}

Authentication

api-keystring

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

Query parameters

filters[attributes.name]stringOptional

Filter by attributes. If you have a filter for the owner on your side please send it as filters[attributes.owner] and utilize the account email for the filtering.

linkedContactsIdslongOptional

Filter by linked contacts ids

linkedDealsIdsstringOptionalformat: "objectID"

Filter by linked Deals ids

modifiedSincestringOptional

Filter (urlencoded) the companies modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

createdSincestringOptional

Filter (urlencoded) the companies created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

pagelongOptional

Index of the first document of the page

limitlongOptional

Number of documents per page

sortenumOptional

Sort the results in the ascending/descending order. Default order is descending by creation if sort is not passed

Allowed values:

sortBystringOptional

The field used to sort field names.

Response

Returns companies list with filters

itemslist of objects

List of companies

Errors

400

Bad Request Error

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.getAllCompanies({});
8	}
9	main();

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