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": "31b2ac35-06b3-4dd0-a484-7e4b15d94f72", "ParentId": "26487249-6f6c-4cfd-9951-6c1b26e77822", "Fields": { "sample string 1": {}, "sample string 3": {} }, "LinkedEntities": { "Contacts": [ "6fddc2b9-1123-4039-9b8a-c68bc01e7b75", "4504ae9a-34a2-4e28-9bc3-341ca1e398fd" ], "Companies": [ "6a283921-f0a9-4aa2-98df-7e3c6ee5c410", "607aac2e-db98-432b-be2c-54ccf05478f7" ], "Groups": [ "af528606-9d29-4da4-ba99-382de80212c7", "68e62bdc-4735-443d-8d18-87d66b44145e" ], "Opportunities": [ "7294561b-810f-4d04-9e44-ced5eb0f0b57", "07cb92ed-9f4c-43b0-81a4-8e25e6afb53e" ] } }, { "Id": "31b2ac35-06b3-4dd0-a484-7e4b15d94f72", "ParentId": "26487249-6f6c-4cfd-9951-6c1b26e77822", "Fields": { "sample string 1": {}, "sample string 3": {} }, "LinkedEntities": { "Contacts": [ "6fddc2b9-1123-4039-9b8a-c68bc01e7b75", "4504ae9a-34a2-4e28-9bc3-341ca1e398fd" ], "Companies": [ "6a283921-f0a9-4aa2-98df-7e3c6ee5c410", "607aac2e-db98-432b-be2c-54ccf05478f7" ], "Groups": [ "af528606-9d29-4da4-ba99-382de80212c7", "68e62bdc-4735-443d-8d18-87d66b44145e" ], "Opportunities": [ "7294561b-810f-4d04-9e44-ced5eb0f0b57", "07cb92ed-9f4c-43b0-81a4-8e25e6afb53e" ] } } ]