Back to Collection Items
<?php
$queryParams->UpdateString('module','Leads');$http->AuthToken = '<access_token>';$resp->GetBodySb($sbResponseBody);$jResp->LoadSb($sbResponseBody);$jResp->EmitCompact = 0;$jResp->I = $i;$sequence_number = $jResp->stringOf('related_lists[i].sequence_number');$display_label = $jResp->stringOf('related_lists[i].display_label');$api_name = $jResp->stringOf('related_lists[i].api_name');$module = $jResp->stringOf('related_lists[i].module');$name = $jResp->stringOf('related_lists[i].name');$action = $jResp->stringOf('related_lists[i].action');$id = $jResp->stringOf('related_lists[i].id');$href = $jResp->stringOf('related_lists[i].href');$v_type = $jResp->stringOf('related_lists[i].type');$connectedmodule = $jResp->stringOf('related_lists[i].connectedmodule');$linkingmodule = $jResp->stringOf('related_lists[i].linkingmodule');$i = $i + 1;
?>
Curl Command
curl -G -d "module=Leads"
-H "Authorization: Bearer <access_token>"
https://domain.com/crm/v2/settings/related_lists
Postman Collection Item JSON
{
"name": "Leads",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/settings/related_lists?module=Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"related_lists"
],
"query": [
{
"key": "module",
"value": "Leads"
}
]
},
"description": "To get the metadata of the Leads Module."
},
"response": [
{
"name": "P1: module",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/settings/related_lists?module=Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"related_lists"
],
"query": [
{
"key": "module",
"value": "Leads"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 09:00:35 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-store, no-cache, must-revalidate, private"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-13T09:52:40+00:00"
},
{
"key": "clientVersion",
"value": "4031107"
},
{
"key": "clientsubVersion",
"value": "113b962796fc62946d9303284a64efab"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "vary",
"value": "accept-encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=15768000"
}
],
"cookie": [
],
"body": "{\n \"related_lists\": [\n {\n \"sequence_number\": \"1\",\n \"display_label\": \"Notes\",\n \"api_name\": \"Notes\",\n \"module\": \"Notes\",\n \"name\": \"Notes\",\n \"action\": null,\n \"id\": \"738964000000002730\",\n \"href\": \"Leads/{ENTITYID}/Notes\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"1\",\n \"display_label\": \"Lead Status History\",\n \"api_name\": \"Lead_Status_History\",\n \"module\": \"Lead_Status_History\",\n \"name\": \"Lead Status History\",\n \"action\": \"picklist_tracker\",\n \"id\": \"738964000001920298\",\n \"href\": \"Leads/{ENTITYID}/Lead_Status_History\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"2\",\n \"display_label\": \"Attachments\",\n \"api_name\": \"Attachments\",\n \"module\": \"Attachments\",\n \"name\": \"Attachments\",\n \"action\": null,\n \"id\": \"738964000000002724\",\n \"href\": \"Leads/{ENTITYID}/Attachments\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"3\",\n \"display_label\": \"Products\",\n \"api_name\": \"Products\",\n \"module\": \"Products\",\n \"name\": \"Products\",\n \"action\": null,\n \"id\": \"738964000000002726\",\n \"href\": \"Leads/{ENTITYID}/Products\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"4\",\n \"display_label\": \"Open Activities\",\n \"api_name\": \"Activities\",\n \"module\": \"Activities\",\n \"name\": \"Activities\",\n \"action\": null,\n \"id\": \"738964000000002722\",\n \"href\": \"Leads/{ENTITYID}/Activities\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"5\",\n \"display_label\": \"Closed Activities\",\n \"api_name\": \"Activities_History\",\n \"module\": \"Activities\",\n \"name\": \"Activities History\",\n \"action\": null,\n \"id\": \"738964000000002720\",\n \"href\": \"Leads/{ENTITYID}/Activities_History\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"6\",\n \"display_label\": \"Invited Meetings\",\n \"api_name\": \"Invited_Events\",\n \"module\": \"Events\",\n \"name\": \"Invited Events\",\n \"action\": null,\n \"id\": \"738964000000044001\",\n \"href\": \"Leads/{ENTITYID}/Invited_Events\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"7\",\n \"display_label\": \"Emails\",\n \"api_name\": \"Emails\",\n \"module\": \"Emails\",\n \"name\": \"Emails\",\n \"action\": null,\n \"id\": \"738964000000002728\",\n \"href\": null,\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"8\",\n \"display_label\": \"Campaigns\",\n \"api_name\": \"Campaigns\",\n \"module\": \"Campaigns\",\n \"name\": \"Campaigns\",\n \"action\": null,\n \"id\": \"738964000000023017\",\n \"href\": \"Leads/{ENTITYID}/Campaigns\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"9\",\n \"display_label\": \"Social\",\n \"api_name\": \"Social\",\n \"module\": \"Social\",\n \"name\": \"Social\",\n \"action\": null,\n \"id\": \"738964000000048003\",\n \"href\": null,\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"10\",\n \"display_label\": \"Checklists\",\n \"api_name\": \"CheckLists\",\n \"module\": \"CheckLists\",\n \"name\": \"CheckLists\",\n \"action\": null,\n \"id\": \"738964000000156005\",\n \"href\": \"Leads/{ENTITYID}/CheckLists\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"12\",\n \"display_label\": \"Deals\",\n \"api_name\": \"Deals8\",\n \"module\": \"Deals_X_Leads\",\n \"name\": \"Deals\",\n \"action\": null,\n \"id\": \"738964000001921504\",\n \"href\": \"Leads/{ENTITYID}/Deals8\",\n \"type\": \"multiselectlookup\",\n \"connectedmodule\": \"Potentials\",\n \"linkingmodule\": \"LinkingModule8\"\n }\n ]\n}"
},
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/settings/related_lists?module=Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"related_lists"
],
"query": [
{
"key": "module",
"value": "Leads"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:29:11 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-store, no-cache, must-revalidate, private"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-11T12:57:36+00:00"
},
{
"key": "clientVersion",
"value": "4023320"
},
{
"key": "clientsubVersion",
"value": "4d8b6ee4f7d1d284c930a4e807480c5c"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "vary",
"value": "accept-encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=15768000"
}
],
"cookie": [
],
"body": "{\n \"related_lists\": [\n {\n \"sequence_number\": \"1\",\n \"display_label\": \"Notes\",\n \"api_name\": \"Notes\",\n \"module\": \"Notes\",\n \"name\": \"Notes\",\n \"action\": null,\n \"id\": \"738964000000002730\",\n \"href\": \"Leads/{ENTITYID}/Notes\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"1\",\n \"display_label\": \"Lead Status History\",\n \"api_name\": \"Lead_Status_History\",\n \"module\": \"Lead_Status_History\",\n \"name\": \"Lead Status History\",\n \"action\": \"picklist_tracker\",\n \"id\": \"738964000001920298\",\n \"href\": \"Leads/{ENTITYID}/Lead_Status_History\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"2\",\n \"display_label\": \"Attachments\",\n \"api_name\": \"Attachments\",\n \"module\": \"Attachments\",\n \"name\": \"Attachments\",\n \"action\": null,\n \"id\": \"738964000000002724\",\n \"href\": \"Leads/{ENTITYID}/Attachments\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"3\",\n \"display_label\": \"Products\",\n \"api_name\": \"Products\",\n \"module\": \"Products\",\n \"name\": \"Products\",\n \"action\": null,\n \"id\": \"738964000000002726\",\n \"href\": \"Leads/{ENTITYID}/Products\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"4\",\n \"display_label\": \"Open Activities\",\n \"api_name\": \"Activities\",\n \"module\": \"Activities\",\n \"name\": \"Activities\",\n \"action\": null,\n \"id\": \"738964000000002722\",\n \"href\": \"Leads/{ENTITYID}/Activities\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"5\",\n \"display_label\": \"Closed Activities\",\n \"api_name\": \"Activities_History\",\n \"module\": \"Activities\",\n \"name\": \"Activities History\",\n \"action\": null,\n \"id\": \"738964000000002720\",\n \"href\": \"Leads/{ENTITYID}/Activities_History\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"6\",\n \"display_label\": \"Invited Meetings\",\n \"api_name\": \"Invited_Events\",\n \"module\": \"Events\",\n \"name\": \"Invited Events\",\n \"action\": null,\n \"id\": \"738964000000044001\",\n \"href\": \"Leads/{ENTITYID}/Invited_Events\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"7\",\n \"display_label\": \"Emails\",\n \"api_name\": \"Emails\",\n \"module\": \"Emails\",\n \"name\": \"Emails\",\n \"action\": null,\n \"id\": \"738964000000002728\",\n \"href\": null,\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"8\",\n \"display_label\": \"Campaigns\",\n \"api_name\": \"Campaigns\",\n \"module\": \"Campaigns\",\n \"name\": \"Campaigns\",\n \"action\": null,\n \"id\": \"738964000000023017\",\n \"href\": \"Leads/{ENTITYID}/Campaigns\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"9\",\n \"display_label\": \"Social\",\n \"api_name\": \"Social\",\n \"module\": \"Social\",\n \"name\": \"Social\",\n \"action\": null,\n \"id\": \"738964000000048003\",\n \"href\": null,\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"10\",\n \"display_label\": \"Checklists\",\n \"api_name\": \"CheckLists\",\n \"module\": \"CheckLists\",\n \"name\": \"CheckLists\",\n \"action\": null,\n \"id\": \"738964000000156005\",\n \"href\": \"Leads/{ENTITYID}/CheckLists\",\n \"type\": \"default\"\n },\n {\n \"sequence_number\": \"12\",\n \"display_label\": \"Deals\",\n \"api_name\": \"Deals8\",\n \"module\": \"Deals_X_Leads\",\n \"name\": \"Deals\",\n \"action\": null,\n \"id\": \"738964000001921504\",\n \"href\": \"Leads/{ENTITYID}/Deals8\",\n \"type\": \"multiselectlookup\",\n \"connectedmodule\": \"Potentials\",\n \"linkingmodule\": \"LinkingModule8\"\n }\n ]\n}"
},
{
"name": "INVALID_MODULE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/settings/related_lists?module=Lead",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"related_lists"
],
"query": [
{
"key": "module",
"value": "Lead"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:29:27 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "110"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-store, no-cache, must-revalidate, private"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-11T12:57:36+00:00"
},
{
"key": "clientVersion",
"value": "4023320"
},
{
"key": "clientsubVersion",
"value": "4d8b6ee4f7d1d284c930a4e807480c5c"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_MODULE\",\n \"details\": {},\n \"message\": \"the module name given seems to be invalid\",\n \"status\": \"error\"\n}"
},
{
"name": "INVALID_URL_PATTERN",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/settings/related_list?module=Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"related_list"
],
"query": [
{
"key": "module",
"value": "Leads"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:29:38 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "131"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-store, no-cache, must-revalidate, private"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-11T12:57:36+00:00"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_URL_PATTERN\",\n \"details\": {},\n \"message\": \"Please check if the URL trying to access is a correct one\",\n \"status\": \"error\"\n}"
},
{
"name": "INVALID_REQUEST_METHOD",
"originalRequest": {
"method": "COPY",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/settings/related_lists?module=Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"related_lists"
],
"query": [
{
"key": "module",
"value": "Leads"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:29:57 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "124"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Frame-Options",
"value": "deny"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_REQUEST_METHOD\",\n \"details\": {},\n \"message\": \"The http request method type is not a valid one\",\n \"status\": \"error\"\n}"
},
{
"name": "AUTHENTICATION_FAILURE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/settings/related_lists?module=Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"related_lists"
],
"query": [
{
"key": "module",
"value": "Leads"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:30:11 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "98"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"AUTHENTICATION_FAILURE\",\n \"details\": {},\n \"message\": \"Authentication failed\",\n \"status\": \"error\"\n}"
},
{
"name": "REQUIRED_PARAM_MISSING",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/settings/related_lists",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"related_lists"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:30:32 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "133"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"REQUIRED_PARAM_MISSING\",\n \"details\": {\n \"param\": \"module\"\n },\n \"message\": \"One of the expected parameter is missing\",\n \"status\": \"error\"\n}"
},
{
"name": "OAUTH_SCOPE_MISMATCH",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/settings/related_lists?module=Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"related_lists"
],
"query": [
{
"key": "module",
"value": "Leads"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 08:29:39 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "113"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"OAUTH_SCOPE_MISMATCH\",\n \"details\": {},\n \"message\": \"invalid oauth scope to access this URL\",\n \"status\": \"error\"\n}"
}
]
}
