Submitted by
iCIMSUNIFIL on May 07, 2020
Permalink
Submitted by
iCIMSUNIFIL on May 07, 2020
Permalink
Get all Recruiting Workflow Statuses
Also, keep in mind the second GET request will need to be performed for each Bin ID returned in the response of your initial request.
There are two steps:
Method: GET
URL:https://api.icims.com/customers/{customerID}/v2/lists/lists.status.submit
The response from the first GET will include all of the Bins in the client platform and their associated IDs. Ex truncated below:
Response:
{
"children": [{
"hidden": false,
"_links": {
"self": {
"href": "https://api.icims.com/customers/xxxx/v2/lists/lists.status.submit/C25806?size=50"
}
},
"readOnly": false,
"id": "C25806",
"listnodeid": "25806",
"value": "Test Bin"
},
{
"hidden": false,
"_links": {
"self": {
"href": "https://api.icims.com/customers/xxxx/v2/lists/lists.status.submit/D10000?size=50"
}
},
"readOnly": true,
"id": "D10000",
"listnodeid": "20041",
"value": "Incomplete"
},
{
"hidden": false,
"_links": {
"self": {
"href": "https://api.icims.com/customers/xxxx/v2/lists/lists.status.submit/D10200?size=50"
}
},
"readOnly": true,
"id": "D10200",
"listnodeid": "2008",
"value": "New Submissions"
}
Perform a second GET request using the IDs in the initial response to obtain the Workflow Status IDs and names (Response truncated below):
Method: GET
URL:
https://api.icims.com/customers/xxxx/v2/lists/lists.status.submit/D10200
Response:
{
"hidden": false,
"children": [{
"hidden": false,
"_links": {
"self": {
"href": "https://api.icims.com/customers/xxxx/v2/lists/lists.status.submit/D10200/D10100?size=50"
}
},
"actionTemplate": null,
"submittalStopPortalApplication": false,
"stagesForStatuses": null,
"readOnly": true,
"submittalOffer": false,
"submittalInterview": false,
"entranceCriteria": null,
"submittalReject": false,
"vmtext": "No Change",
"autoLaunchRequired": false,
"action": null,
"forcedStatusList": null,
"id": "D10100",
"delayEmail": false,
"listnodeid": "2010",
"value": "External Portal",
"actionPrompt": null,
"submittalHire": false
},
{
"hidden": false,
"_links": {
"self": {
"href": "https://api.icims.com/customers/xxxx/v2/lists/lists.status.submit/D10200/C12295?size=50"
}
},
"actionTemplate": null,
"submittalStopPortalApplication": false,
"stagesForStatuses": null,
"readOnly": true,
"submittalOffer": false,
"submittalInterview": false,
"entranceCriteria": null,
"submittalReject": false,
"vmtext": "No Change",
"autoLaunchRequired": false,
"action": null,
"forcedStatusList": null,
"id": "C12295",
"delayEmail": false,
"listnodeid": "12295",
"value": "Internal Portal",
"actionPrompt": null,
"submittalHire": false
},
{
"hidden": false,
"_links": {
"self": {
"href": "https://api.icims.com/customers/xxxx/v2/lists/lists.status.submit/D10200/D10105?size=50"
}
{
"hidden": false,
"_links": {
"self": {
"href": "https://api.icims.com/customers/xxxx/v2/lists/lists.status.submit/D10200/D10104?size=50"
}
},
"actionTemplate": null,
"submittalStopPortalApplication": false,
"stagesForStatuses": null,
"readOnly": false,
"submittalOffer": false,
"submittalInterview": false,
"entranceCriteria": null,
"submittalReject": false,
"vmtext": "No Change",
"autoLaunchRequired": false,
"action": null,
"forcedStatusList": null,
"id": "D10104",
"delayEmail": false,
"listnodeid": "2012",
"value": "Agency Submission",
"actionPrompt": null,
"submittalHire": false
},
{
"hidden": false,
"_links": {
"self": {
"href": "https://api.icims.com/customers/xxxx/v2/lists/lists.status.submit/D10200/C12296?size=50"
}
},
"actionTemplate": null,
"submittalStopPortalApplication": false,
"stagesForStatuses": null,
"readOnly": false,
"submittalOffer": false,
"submittalInterview": false,
"entranceCriteria": null,
"submittalReject": false,
"vmtext": "Referred",
"autoLaunchRequired": false,
"action": null,
"forcedStatusList": null,
"id": "C12296",
"delayEmail": false,
"listnodeid": "12296",
"value": "Employee Referral",
"actionPrompt": null,
"submittalHire": false
},
{
"hidden": true,
"_links": {
"self": {
"href": "https://api.icims.com/customers/xxxx/v2/lists/lists.status.submit/D10200/D10102?size=50"
}