> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.brevo.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.brevo.com/_mcp/server.

# Get the records associated with an object record

GET https://api.brevo.com/v3/objects/{object_type}/associated-records

Custom objects are only available to Enterprise plans.
This feature is in beta. These are subject to change.
Returns the records associated with a single source record. Associations of every type are returned together in one paginated list, ordered by association creation time with the most recently created association first.

**Identifying the source record**
Provide exactly one of `id`, `ext_id`, `email` or `sms`. Passing none of them, or more than one, returns `400`. `email` and `sms` are only accepted when `object_type` is `contact`; using either with any other object type returns `400`.

**Object types**
Use the object type exactly as it is defined in your account, for example `vehicle` for a custom object of that name, or `contact` for contacts. An object type that does not exist in your account returns `400`.

**Filtering by associated object type**
Use `type` to restrict the response to one or more associated object types, for example `?type=contact&type=garage`. Up to 5 types can be requested per call; more returns `400`. When `type` is omitted, associations of every type are returned.

**Pagination**
Results are returned 20 per page. The page size is fixed and cannot be changed. Increase `offset` by 20 to walk through the pages until `has_more` is `false`. An `offset` beyond the last record returns an empty `items` array with `has_more` set to `false`.

**Working with contacts**

* `contact` is supported both as the source `object_type` and as an associated object type.
* An `id`, `ext_id`, `email` or `sms` that matches no contact returns `404`.
* If several contacts share the same `ext_id`, `email` or `sms`, identify the contact by `id` to be sure of which one is used.
* Contacts returned in `items` carry all of the contact's attributes, with attribute keys in lowercase — `email`, `first_name`, `last_name`, `sms`, `ext_id`, and any other contact attribute lowercased.
* For contacts, `ext_id`, `created_at` and `updated_at` are not returned on `object`. A contact's external ID is available as `attributes.ext_id` when it is set.

Reference: https://developers.brevo.com/reference/custom-objects/get-associated-records

## Authentication

- `api-key` header (required) — The API key should be passed in the request headers as `api-key` for authentication.

## Request

### Path parameters

- `object_type` (string, required) — Object type of the source record, exactly as defined in your account. Accepts any object type defined in the account, for example a custom object type or `contact`.

### Query parameters

- `id` (long, optional) — Internal Brevo ID of the source record. Must be a positive integer. Provide exactly one of `id`, `ext_id`, `email` or `sms`.
- `ext_id` (string, optional) — External ID of the source record in your system. Provide exactly one of `id`, `ext_id`, `email` or `sms`.
- `email` (string, optional) — Email address of the source contact. Only accepted when `object_type` is `contact`. Provide exactly one of `id`, `ext_id`, `email` or `sms`.
- `sms` (string, optional) — Phone number of the source contact, including the country code. It may be given with or without a leading `+`; percent-encode the `+` as `%2B`, because a literal `+` in a query string is read as a space. Only accepted when `object_type` is `contact`. Provide exactly one of `id`, `ext_id`, `email` or `sms`.
- `type` (list of string, optional) — Restricts the response to the given associated object types. Repeat the parameter to request several types, for example `?type=contact&type=garage`. Maximum 5 types per call. Associations of every type are returned when omitted.
- `offset` (long, optional, default: 0) — Number of records to skip before the first record of the page. Defaults to 0. Increase by 20 to fetch the next page.

## Response

### 200

A page of records associated with the source record.

- `has_more` (boolean, optional) — `true` when at least one more associated record exists after this page.
- `items` (list of object, optional) — Associated records for this page, up to 20 per page. Fewer when the last page is reached, empty when the source record has no matching associations.
  - `object` (object, optional) — The associated record. `ext_id`, `attributes`, `created_at` and `updated_at` are omitted when they are not available for the record.
    - `attributes` (object, optional) — Key-value pairs of attribute data for the associated record. Each key is the attribute **key** (e.g., `company_name`, `engine_type`), not the attribute label (e.g., "Company Name", "Engine Type"). For `category` or `multiple_category` attributes, the value is the option **key** (not the option label or option ID). For contacts, attribute keys are returned in lowercase, for example `email`, `first_name`, `last_name`, `sms` and `ext_id`.
    - `created_at` (datetime, optional) — Timestamp when the associated record was created. Not returned for contacts.
    - `ext_id` (string, optional) — External ID of the associated record in your system. Not returned for contacts, whose external ID is available as `attributes.ext_id`.
    - `id` (long, optional) — Internal ID of the associated record generated by Brevo.
    - `updated_at` (datetime, optional) — Timestamp when the associated record was last updated. Not returned for contacts.
  - `type` (string, optional) — Object type of the associated record.
- `offset` (long, optional) — The offset that was requested.

## Examples

**Response**

```json
{
  "has_more": true,
  "items": [
    {
      "object": {
        "attributes": {
          "city": "Paris",
          "name": "Downtown Motors"
        },
        "created_at": "2026-07-22T10:20:30Z",
        "ext_id": "f7e8d9c0ba",
        "id": 12345,
        "updated_at": "2026-07-22T10:20:30Z"
      },
      "type": "garage"
    },
    {
      "object": {
        "attributes": {
          "email": "jane.doe@example.com",
          "ext_id": "crm-4471",
          "first_name": "Jane",
          "last_name": "Doe"
        },
        "id": 402
      },
      "type": "contact"
    }
  ],
  "offset": 0
}
```

**SDK Code**

```typescript First page mixing a custom object record and a contact
import { BrevoClient } from "@getbrevo/brevo";

async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.customObjects.getAssociatedRecords({
        objectType: "vehicle",
        type: [
            "contact",
            "garage",
        ],
    });
}
main();

```

```python First page mixing a custom object record and a contact
from brevo import Brevo

client = Brevo(
    api_key="YOUR_API_KEY_HERE",
)

client.custom_objects.get_associated_records(
    object_type="vehicle",
    type=[
        "contact",
        "garage"
    ],
)

```

```php First page mixing a custom object record and a contact
<?php

namespace Example;

use Brevo\Brevo;
use Brevo\CustomObjects\Requests\GetAssociatedRecordsRequest;

$client = new Brevo(
    apiKey: 'YOUR_API_KEY_HERE',
);
$client->customObjects->getAssociatedRecords(
    'vehicle',
    new GetAssociatedRecordsRequest([
        'type' => [
            'contact',
            'garage',
        ],
    ]),
);

```

```go First page mixing a custom object record and a contact
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.brevo.com/v3/objects/vehicle/associated-records?type=%5B%22contact%22%2C%22garage%22%5D"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby First page mixing a custom object record and a contact
require 'uri'
require 'net/http'

url = URI("https://api.brevo.com/v3/objects/vehicle/associated-records?type=%5B%22contact%22%2C%22garage%22%5D")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java First page mixing a custom object record and a contact
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.brevo.com/v3/objects/vehicle/associated-records?type=%5B%22contact%22%2C%22garage%22%5D")
  .header("api-key", "<apiKey>")
  .asString();
```

```csharp First page mixing a custom object record and a contact
using RestSharp;

var client = new RestClient("https://api.brevo.com/v3/objects/vehicle/associated-records?type=%5B%22contact%22%2C%22garage%22%5D");
var request = new RestRequest(Method.GET);
request.AddHeader("api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift First page mixing a custom object record and a contact
import Foundation

let headers = ["api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.brevo.com/v3/objects/vehicle/associated-records?type=%5B%22contact%22%2C%22garage%22%5D")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```