Changelog

Get the records associated with an object record

New endpoint GET /v3/objects/{object_type}/associated-records returns the records associated with a single source record. Associations of every type come back together in one paginated list, most recently created association first.

• Identify the source record with exactly one of id, ext_id, email or sms. email and sms are only accepted when object_type is contact.
• Filter the response with type, up to 5 associated object types per call, for example ?type=contact&type=garage.
• Results are returned 20 per page. Increase offset by 20 until has_more is false.
• Contacts in the response carry all of their attributes, with attribute keys in lowercase.

Example

$
curl --request GET \
>
     --url 'https://api.brevo.com/v3/objects/contact/associated-records?email=jane.doe@example.com' \
>
     --header 'accept: application/json' \
>
     --header 'api-key: YOUR_API_KEY'

Reference:

Get the records associated with an object record

Guide updated:

Custom objects management