Related Lists Meta Data
Purpose
To get the related list data of a particular module.
Request URL
https://recruit.zoho.com/recruit/v2/settings/related_lists?module={module_api_name}
module_api_name - The API name of the module
Request Method
GET
Scope
scope=ZohoRecruit.settings.related_lists.read
(or)
scope=ZohoRecruit.settings.related_lists.all
(or)
scope=ZohoRecruit.settings.all
| Possible module names | Possible Operation Types |
|---|---|
candidate, jobopenings, interview, client, contact, department, task, event, vendor, campaign, referral, review, submission, and custommodule | ALL - Full access to custom view data |
Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| module (mandatory) | String | Specify the API name of the required module. For example, Candidates, Contacts, Clients, Interviews, and so on. The related list of the specified module will be retrieved. |
Possible Errors
| HTTP Status | Error Code | Message | Reason |
|---|---|---|---|
| 400 | INVALID_MODULE | The module name given seems to be invalid | Invalid module name or no tab permission, or the module could have been removed from the organized module |
| 400 | INVALID_MODULE | The given module is not supported in API | The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are supported.) |
Note:
The "href" attribute in the response must be used in the URL to call the related list API. For example, the URL for calling the related list API must be:
https://recruit.zoho.com/recruit/v2/Candidates/{module_id}/Notes
Sample Request
Copiedcurl "https://recruit.zoho.com/recruit/v2/settings/related_lists?module=Candidates"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Sample Response
Copied{
"related_lists": [
{
"sequence_number": "1",
"list_label": "Candidates",
"api_name": "Notes",
"module": "Notes",
"name": "Notes",
"id": "486812000000067365",
"href": "Candidates/{ENTITYID}/Notes",
"type": "default"
},
{
"sequence_number": "1",
"list_label": "Ratings And Reviews",
"api_name": "Ratings_And_Reviews",
"module": null,
"name": "Ratings And Reviews",
"id": "486812000000286001",
"href": null,
"type": "default"
},
{
"sequence_number": "2",
"list_label": "Candidates",
"api_name": "Attachments",
"module": "Attachments",
"name": "Attachments",
"id": "486812000000067368",
"href": "Candidates/{ENTITYID}/Attachments",
"type": "default"
},
{
"sequence_number": "3",
"list_label": "Activity",
"api_name": "Activity",
"module": null,
"name": "Activity",
"id": "486812000000090001",
"href": null,
"type": "default"
},
{
"sequence_number": "6",
"list_label": "Candidates",
"api_name": "Job Openings",
"module": "Job_Openings",
"name": "Job Openings",
"id": "486812000000067371",
"href": "Candidates/{ENTITYID}/Job Openings",
"type": "default"
},
{
"sequence_number": "7",
"list_label": "Interviews",
"api_name": "Interviews",
"module": "Interviews",
"name": "Interviews",
"id": "486812000000067374",
"href": "Candidates/{ENTITYID}/Interviews",
"type": "default"
},
{
"sequence_number": "8",
"list_label": "Candidates",
"api_name": "Emails",
"module": "Emails",
"name": "Emails",
"id": "486812000000067377",
"href": null,
"type": "default"
},
{
"sequence_number": "9",
"list_label": "Client Submission",
"api_name": "Client_Submission",
"module": null,
"name": "Client Submission",
"id": "486812000000067380",
"href": null,
"type": "default"
},
{
"sequence_number": "10",
"list_label": "SMS",
"api_name": "SMS",
"module": null,
"name": "SMS",
"id": "486812000000067383",
"href": null,
"type": "default"
},
{
"sequence_number": "10",
"list_label": "Answered Assessments",
"api_name": "Answered_Assessments",
"module": "Questionnaires",
"name": "Answered Assessments",
"id": "486812000000172096",
"href": "Candidates/{ENTITYID}/Answered_Assessments",
"type": "default"
},
{
"sequence_number": "11",
"api_name": "Invited_Events",
"module": "Events",
"name": "Invited Events",
"id": "486812000000067386",
"href": "Candidates/{ENTITYID}/Invited_Events",
"type": "default"
},
{
"sequence_number": "12",
"list_label": "Candidates",
"api_name": "Campaigns",
"module": "Campaigns",
"name": "Campaigns",
"id": "486812000000067389",
"href": "Candidates/{ENTITYID}/Campaigns",
"type": "default"
},
{
"sequence_number": "13",
"list_label": "Open Activities",
"api_name": "Activities",
"module": "To_Dos",
"name": "Activities",
"id": "486812000000067392",
"href": "Candidates/{ENTITYID}/Activities",
"type": "default"
},
{
"sequence_number": "14",
"list_label": "Closed Activities",
"api_name": "Activities_History",
"module": "To_Dos",
"name": "Activities History",
"id": "486812000000067395",
"href": "Candidates/{ENTITYID}/Activities_History",
"type": "default"
},
{
"sequence_number": "16",
"list_label": "Related List Name 2",
"api_name": "Related_List_Name_2",
"module": "Candidates",
"name": "Related List Name 2",
"id": "486812000000267003",
"href": "Candidates/{ENTITYID}/Related_List_Name_2",
"type": "custom_lookup"
},
{
"sequence_number": "17",
"list_label": "ZohoSign Documents",
"api_name": "ZohoSign_Documents",
"module": "zohosign.ZohoSign_Documents",
"name": "ZohoSign Documents",
"id": "486812000000315070",
"href": null,
"type": "custom_lookup"
},
{
"sequence_number": "18",
"list_label": "DocuSign Envelopes",
"api_name": "DocuSign_Envelopes",
"module": "docusign1.Envelopes",
"name": "DocuSign Envelopes",
"id": "486812000000317637",
"href": null,
"type": "custom_lookup"
}
]
}