> This page is for Unified. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.merge.dev/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.merge.dev/_mcp/server. # /custom-object-classes/{custom_object_class_id}/association-types GET https://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/association-types Returns a list of `AssociationType` objects. Reference: https://docs.merge.dev/merge-unified/crm/custom-objects/association-types/custom-object-classes-association-types-list ## Authentication - `Authorization` header (bearer token, required) — Token-based authentication with required prefix "Bearer" ## Servers - `https://api.merge.dev/api` (Production, default) - `https://api-eu.merge.dev/api` (ProductionEU) - `https://api-ap.merge.dev/api` (ProductionAPSE1) ## Request ### Path parameters - `custom_object_class_id` (string, required) ### Query parameters - `created_after` (datetime, optional) — If provided, will only return objects created after this datetime. - `created_before` (datetime, optional) — If provided, will only return objects created before this datetime. - `cursor` (string, optional) — The pagination cursor value. - `expand` (list of enum, optional) — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - Allowed values: `target_object_classes` - `include_deleted_data` (boolean, optional) — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - `include_remote_data` (boolean, optional) — Whether to include the original data Merge fetched from the third-party to produce these models. - `include_shell_data` (boolean, optional) — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - `modified_after` (datetime, optional) — If provided, only objects synced by Merge after this date time will be returned. - `modified_before` (datetime, optional) — If provided, only objects synced by Merge before this date time will be returned. - `page_size` (integer, optional) — Number of results to return per page. The maximum limit is 100. - `remote_id` (string, optional) — The API provider's ID for the given object. ### Headers - `X-Account-Token` (string, required) — Token identifying the end user. ## Response ### 200 - `next` (string, optional, nullable) - `previous` (string, optional, nullable) - `results` (list of AssociationType, optional) ## Types ### AssociationType # The AssociationType Object ### Description The `Association Type` object represents the relationship between two objects. ### Usage Example TODO - `id` (string, optional) - `remote_id` (string, optional, nullable) — The third-party API ID of the matching object. - `created_at` (datetime, optional) — The datetime that this object was created by Merge. - `modified_at` (datetime, optional) — The datetime that this object was modified by Merge. - `source_object_class` (map from string to any, optional) — The class of the source object (Custom Object or Common Model) for the association type. - `target_object_classes` (list of AssociationSubType, optional) - `remote_key_name` (string, optional, nullable) - `display_name` (string, optional, nullable) - `cardinality` (enum, optional, nullable) - Allowed values: `ONE_TO_ONE`, `MANY_TO_ONE`, `MANY_TO_MANY`, `ONE_TO_MANY` - `is_required` (boolean, optional) ### AssociationSubType - `id` (string, optional, nullable) - `created_at` (datetime, optional) — The datetime that this object was created by Merge. - `modified_at` (datetime, optional) — The datetime that this object was modified by Merge. - `origin_type` (string, optional, nullable) ## Examples **Response** ```json { "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ", "results": [ { "id": "5bb73c32-3c6c-4757-ab7d-7d3540a1be31", "remote_id": "93", "created_at": "2021-09-15T00:00:00Z", "modified_at": "2021-10-16T00:00:00Z", "source_object_class": { "id": "ff1ff4cb-a66b-47dc-8e2a-50388049e602", "origin_type": "CUSTOM_OBJECT" }, "target_object_classes": [ { "id": "Opportunity", "origin_type": "COMMON_MODEL" } ], "remote_key_name": "order_to_opportunity", "display_name": "Order to Opportunity", "cardinality": "ONE_TO_MANY", "is_required": true } ] } ``` **SDK Code** ```python import requests url = "https://api.merge.dev/api/crm/v1/custom-object-classes/custom_object_class_id/association-types" querystring = {"include_remote_data":"true"} headers = { "X-Account-Token": "X-Account-Token", "Authorization": "Bearer " } response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://api.merge.dev/api/crm/v1/custom-object-classes/custom_object_class_id/association-types?include_remote_data=true'; const options = { method: 'GET', headers: {'X-Account-Token': 'X-Account-Token', Authorization: 'Bearer '} }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.merge.dev/api/crm/v1/custom-object-classes/custom_object_class_id/association-types?include_remote_data=true" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-Account-Token", "X-Account-Token") req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.merge.dev/api/crm/v1/custom-object-classes/custom_object_class_id/association-types?include_remote_data=true") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["X-Account-Token"] = 'X-Account-Token' request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.merge.dev/api/crm/v1/custom-object-classes/custom_object_class_id/association-types?include_remote_data=true") .header("X-Account-Token", "X-Account-Token") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.merge.dev/api/crm/v1/custom-object-classes/custom_object_class_id/association-types?include_remote_data=true', [ 'headers' => [ 'Authorization' => 'Bearer ', 'X-Account-Token' => 'X-Account-Token', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.merge.dev/api/crm/v1/custom-object-classes/custom_object_class_id/association-types?include_remote_data=true"); var request = new RestRequest(Method.GET); request.AddHeader("X-Account-Token", "X-Account-Token"); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "X-Account-Token": "X-Account-Token", "Authorization": "Bearer " ] let request = NSMutableURLRequest(url: NSURL(string: "https://api.merge.dev/api/crm/v1/custom-object-classes/custom_object_class_id/association-types?include_remote_data=true")! 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() ```