API Reference

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

get
https://api.brevo.com/v3/objects//records

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

Enterprise access only

  • Custom objects are only available to Enterprise plans.
  • This feature is in beta. These are subject to change.
Path Params
string
required

object type for the attribute

Query Params
int64
required
0 to 1000

Number of records returned per page

int64
required
≥ 1

Page number for pagination. It's used to fetch the object records on a provided page number. Must be a valid positive integer.

string
enum
Defaults to desc

Sort order, must be 'asc' or 'desc'. Default to 'desc' if not provided.

Allowed:
string
enum

Whether to include associations, must be 'true' or 'false'. Default to 'false' if not provided.

Allowed:
Responses

400

Bad request (e.g., invalid object_type, invalid page number provided)

403

Custom objects are not available on this account.

424

primary attribute not found

500

Internal server error

Updated 6 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago