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 MutableEntityExtended

Name	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": "5c2dfd48-17ad-42c2-987a-571de22c711c",
    "ParentId": "464533bc-5195-4ae1-bc3e-33c4762f1b80",
    "Fields": {
      "sample string 1": {},
      "sample string 3": {}
    },
    "LinkedEntities": {
      "Contacts": [
        "59cd89c8-0852-4659-914c-91a28d1afc02",
        "31d1f806-2de1-4ba1-9c89-31316413ded3"
      ],
      "Companies": [
        "869923f3-7adc-408f-871b-4f9d358e7db2",
        "6bdc1c25-6018-40e8-bc17-665f4588f7b6"
      ],
      "Groups": [
        "af73f881-c9ef-4cb3-beb3-e3f5728cf792",
        "d4aba665-a36a-45e2-b5d6-850789e8a73e"
      ],
      "Opportunities": [
        "58cf6ef5-82cc-48f3-a104-767abd4288da",
        "6d50945e-c7b5-435b-84f0-19379f26dd0b"
      ]
    }
  },
  {
    "Id": "5c2dfd48-17ad-42c2-987a-571de22c711c",
    "ParentId": "464533bc-5195-4ae1-bc3e-33c4762f1b80",
    "Fields": {
      "sample string 1": {},
      "sample string 3": {}
    },
    "LinkedEntities": {
      "Contacts": [
        "59cd89c8-0852-4659-914c-91a28d1afc02",
        "31d1f806-2de1-4ba1-9c89-31316413ded3"
      ],
      "Companies": [
        "869923f3-7adc-408f-871b-4f9d358e7db2",
        "6bdc1c25-6018-40e8-bc17-665f4588f7b6"
      ],
      "Groups": [
        "af73f881-c9ef-4cb3-beb3-e3f5728cf792",
        "d4aba665-a36a-45e2-b5d6-850789e8a73e"
      ],
      "Opportunities": [
        "58cf6ef5-82cc-48f3-a104-767abd4288da",
        "6d50945e-c7b5-435b-84f0-19379f26dd0b"
      ]
    }
  }
]