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": "abeeb8f5-c80b-4b36-8187-56805fea37c1", "ParentId": "76ecea1a-6c94-4b5f-89b9-80997e56d29e", "Fields": { "sample string 1": {}, "sample string 3": {} }, "LinkedEntities": { "Contacts": [ "4d05b416-2dad-4616-a1fe-056b221b6008", "2092de04-c4d3-42fc-b95e-68ae942fe445" ], "Companies": [ "42e28e05-146a-44bf-9e9d-78f9e59e9ace", "20397161-851f-4a66-95a7-16f0df8f7e7f" ], "Groups": [ "ad98f7b8-d025-43d5-8984-fb43453badbd", "c5069b4f-1192-4391-8bec-55c984481cd7" ], "Opportunities": [ "ba3afd5b-c932-4702-8f97-76c62e24b358", "efab25cf-6f54-4546-899f-bdf79461160c" ] } }, { "Id": "abeeb8f5-c80b-4b36-8187-56805fea37c1", "ParentId": "76ecea1a-6c94-4b5f-89b9-80997e56d29e", "Fields": { "sample string 1": {}, "sample string 3": {} }, "LinkedEntities": { "Contacts": [ "4d05b416-2dad-4616-a1fe-056b221b6008", "2092de04-c4d3-42fc-b95e-68ae942fe445" ], "Companies": [ "42e28e05-146a-44bf-9e9d-78f9e59e9ace", "20397161-851f-4a66-95a7-16f0df8f7e7f" ], "Groups": [ "ad98f7b8-d025-43d5-8984-fb43453badbd", "c5069b4f-1192-4391-8bec-55c984481cd7" ], "Opportunities": [ "ba3afd5b-c932-4702-8f97-76c62e24b358", "efab25cf-6f54-4546-899f-bdf79461160c" ] } } ]