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": "08b7a1b9-94c8-4edb-a5b6-9ae1e855aa74", "ParentId": "4465658b-f8c2-4dc2-864b-1fd20371d817", "Fields": { "sample string 1": {}, "sample string 3": {} }, "LinkedEntities": { "Contacts": [ "e7d3741c-a28e-4189-a7a1-964de247138e", "90629d75-1a6f-49f3-b6b3-35ec3dbb317f" ], "Companies": [ "e78ac6cb-8031-4ae1-9fc4-f8b4670fa14f", "744afeaa-c54e-4c82-8e9e-2338baaf96c2" ], "Groups": [ "a8768a60-b462-4088-a9f8-52e0bfa02b34", "0740abd0-2ddc-4c7a-8a67-9fcd41d879d8" ], "Opportunities": [ "b6915c25-1118-4517-a119-da5fb92d561f", "7485b522-feb2-4401-9b9a-3489282d37cb" ] } }, { "Id": "08b7a1b9-94c8-4edb-a5b6-9ae1e855aa74", "ParentId": "4465658b-f8c2-4dc2-864b-1fd20371d817", "Fields": { "sample string 1": {}, "sample string 3": {} }, "LinkedEntities": { "Contacts": [ "e7d3741c-a28e-4189-a7a1-964de247138e", "90629d75-1a6f-49f3-b6b3-35ec3dbb317f" ], "Companies": [ "e78ac6cb-8031-4ae1-9fc4-f8b4670fa14f", "744afeaa-c54e-4c82-8e9e-2338baaf96c2" ], "Groups": [ "a8768a60-b462-4088-a9f8-52e0bfa02b34", "0740abd0-2ddc-4c7a-8a67-9fcd41d879d8" ], "Opportunities": [ "b6915c25-1118-4517-a119-da5fb92d561f", "7485b522-feb2-4401-9b9a-3489282d37cb" ] } } ]