Get company attributes | Brevo API Documentation

Retrieve the list of all attributes defined for companies, including both system-default and custom attributes. Each attribute includes its label, internal name, type, required status, and available options for select-type attributes.

Authentication

api-keystring

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

Response

Returns list of company attributes

internalNamestring

Internal name of the attribute

attributeTypeNamestring

Type of the attribute

labelstring

Display label of the attribute

attributeOptionslist of objects

Options for single-select or multi-choice attributes

isRequiredboolean

Whether this attribute is required

isValueReadonlyboolean

Whether this attribute value is read-only

Errors

400

Bad Request Error

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

Returns list of company attributes

Internal name of the attribute

Type of the attribute

Display label of the attribute

Options for single-select or multi-choice attributes

Whether this attribute is required

Whether this attribute value is read-only

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

1	[
2	{
3	"internalName": "name",
4	"attributeTypeName": "text",
5	"label": "Company Name",
6	"attributeOptions": [
7	{
8	"key": "custom key",
9	"value": "custom label"
10	}
11	],
12	"isRequired": true,
13	"isValueReadonly": false
14	}
15	]

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

1	[
2	{
3	"internalName": "name",
4	"attributeTypeName": "text",
5	"label": "Company Name",
6	"attributeOptions": [
7	{
8	"key": "custom key",
9	"value": "custom label"
10	}
11	],
12	"isRequired": true,
13	"isValueReadonly": false
14	}
15	]