The Workflows Endpoint allows vendors to interact with various workflows, which connect a baseProfile and an associatedProfile, in the iCIMS Talent Platform. For example, a Recruiting Worfklow is the connection between a Job Profile (the baseProfile) and a Person Profile (the associatedProfile).
Workflow Types
The list below contains all current workflow types supported by the iCIMS Talent Platform, as well as each profile's workflowType, which is necessary to access the profile via the API. (Refer to Add new workflow entry, below, for more information.)
Note that not all clients have all workflow types enabled.
- Recruiting Workflow: applicantworkflows
- Sourcing Workflow: sourceworkflows
- Onboarding Workflow: onboardworkflows
- Event Attendees: connecteventworkflows
Note: Recruiting Workflows were formerly called Applicant Workflows; this terminology remains in iCIMS API, as seen in the code examples below.
Add new workflow entry
A new workflow entry is a new association between the baseProfile and associatedProfile. The API expects a Profile JSON object of the workflow and must always contain a baseProfile and an associatedProfile.
URL: https://api.icims.com/customers/{customerId}/{workflowType}
{workflowType}
The identifier for recruiting workflows, onboard workflows, or for any future custom workflows.
| Action | Definition |
|---|---|
| Get: | Not Supported |
| Post: |
Add a new recruiting workflow entry https://api.icims.com/customers/1234/applicantworkflows POST HTTP/1.1
{ "baseprofile": 1008, "source": "Identify Feature", "status": { "id": "D10100", "value": "Recently Applied" }, "associatedprofile": 2468 }
Response: Add a new Onboard workflow entry POST /onboardworkflows/ { Response: |
| Patch: | Not Supported |
| Delete | Not Supported |
Retrieve, update, and/or delete workflow information
Retrieve basic information of a specific workflow.
All workflows have their own set of standard fields that are available (see the separate sections for each workflow type for their fields) along with the read-only fields id,createddate, createdby (except for Recruiting Workflow),updateddate, and updatedby. Custom fields are included with the attribute name field along with a numeric internal identifier for the field. For example, a custom field could look like field1234.
Use the query parameter fields to specify specific fields to retrieve. When the fields parameter is not specified, the following fields are returned per workflow:
- Recruiting Workflow:
- baseprofile
- associatedprofile
- status
- source
- sourcename
- Sourcing Workflow:
- baseprofile
- associatedprofile
- status
- sourceorigin
- source
- sourcename
- Onboard Workflow:
- baseprofile
- associatedprofile
- status
Retrieve the history log for a specific Recruiting Workflow
Querying the submittalstatuslog field returns the history of the customer organization's recruiting workflow updates, limited to the 100 most recent results. Includes details about the recruiting workflow status and the user who completed the update.
URL: https://api.icims.com/{customerId}/applicantworkflows/{workflowId}?fields=submittalstatuslog
Update workflow information
Expects a JSON object of the workflow in the same form as when retrieving with only the fields to be updated. Note that you cannot patch the baseprofile or the associatedprofile fields, as they can only be specified with creating a workflow.
Delete workflow entry (i.e., unassociate baseProfile and associatedProfile)
This is only supported for Recruiting Workflows.
URL: https://api.icims.com/customers/{customerId}/{workflowType}/{workflowId}
{workflowID} - Numeric identifier of the workflow.
Note: An additional endpoint is available to GET and PATCH Recruiting Workflows:
https://api.icims.com/customers/{customerId}/applicantworkflows/person/{personid}/job/{jobid}
{personid} - Numeric identifier of the Person profile.
{jobid} - Numeric identifier of the Job profile.
| Action | Definition |
|---|---|
| Get: |
Retrieve basic information from a recruiting workflow. https://api.icims.com/customers/1234/applicantworkflows/13 HTTP/1.1 200 OK { "id": 13, "baseprofile": { "id": 3, "value": "Accountant", "profile": "https: //api.icims.com/customers/1234/jobs/3/" }, "associatedprofile": { "id": 5, "value": "JohnSmith", "profile": "https: //api.icims.com/customers/1234/people/5/" }, "status": { "id": "D5432", "value": "InterviewScheduled" }, "source": "iCIMS.com", "sourcename": "Internal" }, } Retrieve the history log for a specific recruiting workflow https://api.icims.com/customers/1234/applicantworkflows/3839?fields=submittalstatuslog { "submittalstatuslog": [ { "updatedBy": { "profile": "https://api.icims.com/customers/1234/people/1", "id": 1, "value": "iAdmin (demo301)" }, "updatedDate": "2022-06-21 10:41:11", "status": { "id": "C25587", "formattedvalue": "Hired - Hired", "value": "Hired - Hired" } } ], "links": [ { "rel": "self", "title": "The current profile being viewed.", "url": "https://api.icims.com/customers/1234/applicantworkflows/3839" } ] } Retrieve basic information from an Onboard workflow GET /onboardworkflows/ { |
| Post: | Not Supported |
| Patch |
Update recruiting (applicant) workflow information PATCH HTTP/1.1 { "source": "dice.com" }
Response: Update Onboard workflow information PATCH /onboardworkflows/ { "baseprofile": 1, "status": { "id": "D37002023001" }, "associatedprofile": 100 }
RETURN HTTP / 1.1 204 No Content Location: https: //api.icims.com/customers/1234/onboardworkflows/1 |
| Delete: |
Delete workflow entry (i.e. unassociate baseProfile and associatedProfile) This is only supported for recruiting (applicant) workflows, not Onboard workflows Response: HTTP/1.1 204 No Content |