For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Help CenterAPI KeysStatusSign In
GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelog
  • Introduction
    • Getting started
  • Email API
  • Transactional SMS
  • Transactional WhatsApp
  • Marketing Campaigns
  • Contact Management
  • Events
    • GETGet events
    • POSTCreate an event
    • POSTCreate events in batch
  • Object Management
      • POSTCreate/Update object records in bulk
      • GETGet the list of object records and total records count for an object.
      • POSTDelete multiple object records (up to 1000) asynchronously
  • Accounts and Settings
  • Sales CRM
  • Conversations
  • Ecommerce
  • Loyalty
LogoLogo
Help CenterAPI KeysStatusSign In
Object ManagementCustom Objects

Get the list of object records and total records count for an object.

GET
https://api.brevo.com/v3/objects/:object_type/records
GET
/v3/objects/:object_type/records
1import { BrevoClient } from "@getbrevo/brevo";
2
3async function main() {
4    const client = new BrevoClient({
5        apiKey: "YOUR_API_KEY_HERE",
6    });
7    await client.customObjects.getrecords("vehicle", {
8        limit: 1,
9        pageNum: 1,
10    });
11}
12main();
1{
2  "count": 350,
3  "records": [
4    {
5      "associations": [
6        {
7          "object_type": "garage",
8          "records": [
9            {
10              "identifiers": {
11                "id": 12345
12              }
13            }
14          ]
15        }
16      ],
17      "attributes": {
18        "make": "Toyota",
19        "model": "Corolla",
20        "color": "Black",
21        "year": 2020,
22        "engine_type": "hybrid"
23      },
24      "createdAt": "2025-07-22T10:20:30Z",
25      "identifiers": {
26        "ext_id": "507f1f77bc",
27        "id": 16789
28      },
29      "updatedAt": "2025-07-22T10:20:30Z"
30    }
31  ]
32}
<Note title="Enterprise access only">Custom objects are only available to Enterprise plans. This feature is in beta. These are subject to change.</Note> This API retrieves a list of object records along with their associated records and provides the total count of records for the specified object. **Note**: Contact as object type is not supported in this endpoint.
Was this page helpful?
Previous

Delete multiple object records (up to 1000) asynchronously

Next
Built with

Enterprise access only
Custom objects are only available to Enterprise plans. This feature is in beta. These are subject to change.
This API retrieves a list of object records along with their associated records and provides the total count of records for the specified object. Note: Contact as object type is not supported in this endpoint.

Authentication

api-keystring

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

Path parameters

object_typestringRequired
Object type for the records to retrieve. Must be a previously created custom object type. Contact as object type is not supported in this endpoint.

Query parameters

limitlongRequired0-1000
Number of records returned per page
page_numlongRequired>=1
Page number for pagination. It's used to fetch the object records on a provided page number. Must be a valid positive integer.
sortenumOptionalDefaults to desc
Sort order, must be 'asc' or 'desc'. Default to 'desc' if not provided.
Allowed values:
associationenumOptional
Whether to include associations, must be 'true' or 'false'. Default to 'false' if not provided.
Allowed values:

Response

A list of object records for an object type. If association param is set true it will return 5 associated records per association for an object type.
countlong
Total number of object records for an object type.
recordslist of objects

Errors

400
Bad Request Error
403
Forbidden Error
424
Failed Dependency Error
500
Internal Server Error