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": "9648f2c2-5fe7-4976-9fe9-623ce7a06031", "ParentId": "0dc424a7-f784-4a3b-a3f4-4c783fdcff2d", "Fields": { "sample string 1": {}, "sample string 3": {} }, "LinkedEntities": { "Contacts": [ "e436402a-f866-4617-af1b-1aedddd9099c", "3f5bc180-12eb-425c-b2a9-993649e5cdf5" ], "Companies": [ "a9f71cda-5ddc-49ad-980d-5b684035f3ce", "2710e786-e8a8-4028-804d-1b67d69cd685" ], "Groups": [ "661837bc-6808-4e5f-bc01-dea5869331e5", "f7dc52a5-519e-4963-8d56-956c4c92b0cd" ], "Opportunities": [ "ecb53c65-f3b1-45df-be52-396852ae95ad", "0abed32b-2c01-4b67-a968-b8bf83ad91be" ] } }, { "Id": "9648f2c2-5fe7-4976-9fe9-623ce7a06031", "ParentId": "0dc424a7-f784-4a3b-a3f4-4c783fdcff2d", "Fields": { "sample string 1": {}, "sample string 3": {} }, "LinkedEntities": { "Contacts": [ "e436402a-f866-4617-af1b-1aedddd9099c", "3f5bc180-12eb-425c-b2a9-993649e5cdf5" ], "Companies": [ "a9f71cda-5ddc-49ad-980d-5b684035f3ce", "2710e786-e8a8-4028-804d-1b67d69cd685" ], "Groups": [ "661837bc-6808-4e5f-bc01-dea5869331e5", "f7dc52a5-519e-4963-8d56-956c4c92b0cd" ], "Opportunities": [ "ecb53c65-f3b1-45df-be52-396852ae95ad", "0abed32b-2c01-4b67-a968-b8bf83ad91be" ] } } ]