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": "e4015eb9-162a-4405-9b5d-66ca2ec2cc17", "ParentId": "967d6b68-7ca0-40f9-8454-5000ff31f71e", "Fields": { "sample string 1": {}, "sample string 3": {} }, "LinkedEntities": { "Contacts": [ "2064b999-b3b7-48d2-a9c5-e2dc449222f1", "a874ae60-37b1-41b0-934a-b3460d6b8d66" ], "Companies": [ "8a8c75dd-0b7c-4aaf-a766-7a5d2f8b98df", "e2593a9b-8d7b-4108-875e-b1218f01f8fe" ], "Groups": [ "06095e85-8d02-4c42-9107-a301382a963d", "44b4e1e4-14b7-4a91-8fa4-91ea47aa9575" ], "Opportunities": [ "e99788b4-cf5d-4dd1-b55e-cef284618d7b", "b6b3b165-1dff-4ed2-b580-7e25a84475c4" ] } }, { "Id": "e4015eb9-162a-4405-9b5d-66ca2ec2cc17", "ParentId": "967d6b68-7ca0-40f9-8454-5000ff31f71e", "Fields": { "sample string 1": {}, "sample string 3": {} }, "LinkedEntities": { "Contacts": [ "2064b999-b3b7-48d2-a9c5-e2dc449222f1", "a874ae60-37b1-41b0-934a-b3460d6b8d66" ], "Companies": [ "8a8c75dd-0b7c-4aaf-a766-7a5d2f8b98df", "e2593a9b-8d7b-4108-875e-b1218f01f8fe" ], "Groups": [ "06095e85-8d02-4c42-9107-a301382a963d", "44b4e1e4-14b7-4a91-8fa4-91ea47aa9575" ], "Opportunities": [ "e99788b4-cf5d-4dd1-b55e-cef284618d7b", "b6b3b165-1dff-4ed2-b580-7e25a84475c4" ] } } ]