Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

iCIMS Workflows API

Manage candidate workflows linking jobs and people.

iCIMS Workflows API is one of 3 APIs that iCIMS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workflows. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 4 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.icims.com.

6 operations 4 paths 1 schemas 1 DELETE3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Server
https://api.icims.com
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

iCIMS Workflows API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Workflows 6

Manage candidate workflows linking jobs and people.

POST
/customers/{customerId}/{workflowType}
Create a workflow
createWorkflow 2 params body → 201
GET
/customers/{customerId}/{workflowType}/{workflowId}
Get a workflow
getWorkflow 3 params → 200
PATCH
/customers/{customerId}/{workflowType}/{workflowId}
Update a workflow
updateWorkflow 3 params body → 200
DELETE
/customers/{customerId}/{workflowType}/{workflowId}
Delete a workflow
deleteWorkflow 3 params → 204
GET
/customers/{customerId}/applicantworkflows/person/{personId}/job/{jobId}
Get applicant workflow for a person and job
getApplicantWorkflowByPersonAndJob 3 params → 200
GET
/customers/{customerId}/applicantworkflows/{workflowId}/submittalstatuslog
Get the submittal status log for an applicant workflow
getApplicantWorkflowSubmittalStatusLog 2 params → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. Each schema is shown below with its type and property counts.

Resource
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

icims-workflows-api-openapi.yml Raw ↑

Other APIs iCIMS publishes across the network.

iCIMS Apply Framework API
iCIMS Marketplace Integrations API