/custom-object-classes/{custom_object_class_id}/association-types/{id}

curl -G https://api.merge.dev/api/crm/v1/custom-object-classes/custom_object_class_id/association-types/id \
     -H "X-Account-Token: X-Account-Token" \
     -H "Authorization: Bearer <token>" \
     -d expand=target_object_classes

{
  "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
}

Returns an AssociationType object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

custom_object_class_idstringRequiredformat: "uuid"

idstringRequiredformat: "uuid"

Query parameters

expandlist of enumsOptional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

Allowed values:

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

Response

idstringOptionalRead-onlyformat: "uuid"

remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only

The datetime that this object was created by Merge.

modified_atdatetimeOptionalRead-only

The datetime that this object was modified by Merge.

source_object_classmap from strings to anyOptionalRead-only

The class of the source object (Custom Object or Common Model) for the association type.

target_object_classeslist of objectsOptionalRead-only

remote_key_namestring or nullOptional

display_namestring or nullOptional

cardinalityenum or nullOptional

is_requiredbooleanOptional