Get association key by key name

GET 
/associations/key/:key_name

Using this api you can get standard / user defined association by key

Request

Version stringrequired

API Version

Available optionsv3

key_name stringrequired

locationId stringrequired

application/json

Successful response

application/json

Schema

Schema

locationIdstringrequired
idstringrequired
keystringrequired

First Objects Association Label (custom_objects.children)

firstObjectLabelobjectrequired

First Objects Association Label (custom_objects.children)

firstObjectKeyobjectrequired

First Objects Key

secondObjectLabelobjectrequired

Second Object Association Label (contact)

secondObjectKeyobjectrequired

Second Objects Key

associationTypeobjectrequired

Association Type can be USER_DEFINED or SYSTEM_DEFINED

Example (auto)

{
  "locationId": "string",
  "id": "ve9EPM428h8vShlRW1KT",
  "key": "student",
  "firstObjectLabel": "student",
  "firstObjectKey": "custom_objects.children",
  "secondObjectLabel": "Teacher",
  "secondObjectKey": "contact",
  "associationType": "USER_DEFINED"
}