GET api/CustomTables?customTableName={customTableName}&mainEntityType={mainEntityType}&entityId={entityId}
Get the linked custom table sub entities for a Contact, Company, Group, or Opportunity. Supported Headers: Filter, Sort, SortDesc, SelectField
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
customTableName |
Custom Table Name |
string |
Required |
mainEntityType |
The main entity type. This is the table the custom record is linked to. |
MainEntityType |
Required |
entityId |
Main Entity Id. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of MutableEntityExtendedName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
ParentId |
This field will only include data when working with Group records. |
globally unique identifier |
None. |
Fields | Dictionary of string [key] and Object [value] |
None. |
|
LinkedEntities | LinkedEntities |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Id": "0606250c-956e-452f-8b56-197e93bd2b35", "ParentId": "49a22f5f-a484-46cd-8391-853e224b4ed2", "Fields": { "sample string 1": {}, "sample string 3": {} }, "LinkedEntities": { "Contacts": [ "0ac09891-b219-438b-b56e-14812555aeee", "8b98bf1d-8427-4bde-9d0d-1b69bb92f314" ], "Companies": [ "21c2d573-3c18-4861-adea-695f00c4009d", "72b00f5f-5fd6-46a6-aa88-2d51a01ce6f4" ], "Groups": [ "877587d3-1792-487c-b29e-42cec5b48d61", "a2c8b699-85e1-4991-a822-eada46e9b83c" ], "Opportunities": [ "8142e3bb-3c4b-4a9b-ab7b-05ead57e6ad0", "7fc439ab-f7ec-4ad5-848a-628c0b50f8c7" ] } }, { "Id": "0606250c-956e-452f-8b56-197e93bd2b35", "ParentId": "49a22f5f-a484-46cd-8391-853e224b4ed2", "Fields": { "sample string 1": {}, "sample string 3": {} }, "LinkedEntities": { "Contacts": [ "0ac09891-b219-438b-b56e-14812555aeee", "8b98bf1d-8427-4bde-9d0d-1b69bb92f314" ], "Companies": [ "21c2d573-3c18-4861-adea-695f00c4009d", "72b00f5f-5fd6-46a6-aa88-2d51a01ce6f4" ], "Groups": [ "877587d3-1792-487c-b29e-42cec5b48d61", "a2c8b699-85e1-4991-a822-eada46e9b83c" ], "Opportunities": [ "8142e3bb-3c4b-4a9b-ab7b-05ead57e6ad0", "7fc439ab-f7ec-4ad5-848a-628c0b50f8c7" ] } } ]