Work Flow Jobs

Gets a list of workflow jobs

get

This endpoint is used to fetch all the workflow jobs in the current organization

Authorizations

Query parameters

items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/workflow_jobs/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": "text",
    "schedule_details": "text",
    "next_action_time_obj": "text",
    "last_action_time_obj": "text",
    "created_by_name": "text",
    "modified_by_name": "text",
    "business_hr_profile_name": "text",
    "execute_now_triggered": "text",
    "created_by_profile": "text",
    "modified_by_profile": "text",
    "job_id": "text",
    "organization": "text",
    "name": "text",
    "description": "text",
    "jobname": "text",
    "progress": true,
    "last_action": "2025-08-30T22:28:45.468Z",
    "next_action": "2025-08-30T22:28:45.468Z",
    "startdate": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "enddate": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "starttime": "2025-08-30",
    "endtime": "2025-08-30",
    "is_enabled": true,
    "is_deleted": true,
    "creation_time": "2025-08-30T22:28:45.468Z",
    "modified_time": "2025-08-30T22:28:45.468Z",
    "created_by": "text",
    "modified_by": "text",
    "business_hr_profile": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "schedule_data": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "tzone": "text"
  }
]

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

schedule_detailsstringRead-onlyRequired

next_action_time_objstringRead-onlyRequired

last_action_time_objstringRead-onlyRequired

created_by_namestringRead-onlyRequired

modified_by_namestringRead-onlyRequired

business_hr_profile_namestringRead-onlyRequired

execute_now_triggeredstringRead-onlyRequired

created_by_profilestringRead-onlyRequired

modified_by_profilestringRead-onlyRequired

job_idstring · max: 25Required

organizationstring · max: 25Required

namestringRequired

descriptionstringOptional

jobnamestringOptional

progressbooleanOptional

last_actionstring · date-timeOptional

next_actionstring · date-timeOptional

starttimestring · dateOptional

endtimestring · dateOptional

is_enabledbooleanOptional

is_deletedbooleanOptional

creation_timestring · date-timeOptional

modified_timestring · date-timeOptional

created_bystringOptional

modified_bystringOptional

tzonestringOptional

Responses

201Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/workflow_jobs/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 631

{
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-08-30T22:28:45.468Z",
  "next_action": "2025-08-30T22:28:45.468Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-08-30",
  "endtime": "2025-08-30",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-08-30T22:28:45.468Z",
  "modified_time": "2025-08-30T22:28:45.468Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

201Success

{
  "id": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "business_hr_profile_name": "text",
  "execute_now_triggered": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-08-30T22:28:45.468Z",
  "next_action": "2025-08-30T22:28:45.468Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-08-30",
  "endtime": "2025-08-30",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-08-30T22:28:45.468Z",
  "modified_time": "2025-08-30T22:28:45.468Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}

Gets a workflow job details with the given id

get

This endpoint is used to fetch a workflow jobs in the current organization

Authorizations

Path parameters

idstringRequired

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/workflow_jobs/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "business_hr_profile_name": "text",
  "execute_now_triggered": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-08-30T22:28:45.468Z",
  "next_action": "2025-08-30T22:28:45.468Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-08-30",
  "endtime": "2025-08-30",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-08-30T22:28:45.468Z",
  "modified_time": "2025-08-30T22:28:45.468Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}

put

API endpoint that allows users to be viewed or edited.

Authorizations

Path parameters

idstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

schedule_detailsstringRead-onlyRequired

next_action_time_objstringRead-onlyRequired

last_action_time_objstringRead-onlyRequired

created_by_namestringRead-onlyRequired

modified_by_namestringRead-onlyRequired

business_hr_profile_namestringRead-onlyRequired

execute_now_triggeredstringRead-onlyRequired

created_by_profilestringRead-onlyRequired

modified_by_profilestringRead-onlyRequired

job_idstring · max: 25Required

organizationstring · max: 25Required

namestringRequired

descriptionstringOptional

jobnamestringOptional

progressbooleanOptional

last_actionstring · date-timeOptional

next_actionstring · date-timeOptional

starttimestring · dateOptional

endtimestring · dateOptional

is_enabledbooleanOptional

is_deletedbooleanOptional

creation_timestring · date-timeOptional

modified_timestring · date-timeOptional

created_bystringOptional

modified_bystringOptional

tzonestringOptional

Responses

200Success

application/json

put

HTTPcURLJavaScriptPython

PUT /ux/nccm/workflow_jobs/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 631

{
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-08-30T22:28:45.468Z",
  "next_action": "2025-08-30T22:28:45.468Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-08-30",
  "endtime": "2025-08-30",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-08-30T22:28:45.468Z",
  "modified_time": "2025-08-30T22:28:45.468Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "business_hr_profile_name": "text",
  "execute_now_triggered": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-08-30T22:28:45.468Z",
  "next_action": "2025-08-30T22:28:45.468Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-08-30",
  "endtime": "2025-08-30",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-08-30T22:28:45.468Z",
  "modified_time": "2025-08-30T22:28:45.468Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}

Deletes the workflow job with given id

delete

This endpoint is used to delete an existing workflow job for the current organization

Authorizations

Path parameters

idstringRequired

Responses

204

No response body

No content

delete

HTTPcURLJavaScriptPython

DELETE /ux/nccm/workflow_jobs/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

Trigger Workflow Jobs

post

This endpoint is used to trigger workflow jobs in the current organization

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

schedule_detailsstringRead-onlyRequired

next_action_time_objstringRead-onlyRequired

last_action_time_objstringRead-onlyRequired

created_by_namestringRead-onlyRequired

modified_by_namestringRead-onlyRequired

business_hr_profile_namestringRead-onlyRequired

execute_now_triggeredstringRead-onlyRequired

created_by_profilestringRead-onlyRequired

modified_by_profilestringRead-onlyRequired

job_idstring · max: 25Required

organizationstring · max: 25Required

namestringRequired

descriptionstringOptional

jobnamestringOptional

progressbooleanOptional

last_actionstring · date-timeOptional

next_actionstring · date-timeOptional

starttimestring · dateOptional

endtimestring · dateOptional

is_enabledbooleanOptional

is_deletedbooleanOptional

creation_timestring · date-timeOptional

modified_timestring · date-timeOptional

created_bystringOptional

modified_bystringOptional

tzonestringOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/workflow_jobs/execute-workflow-job/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 631

{
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-08-30T22:28:45.468Z",
  "next_action": "2025-08-30T22:28:45.468Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-08-30",
  "endtime": "2025-08-30",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-08-30T22:28:45.468Z",
  "modified_time": "2025-08-30T22:28:45.468Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "business_hr_profile_name": "text",
  "execute_now_triggered": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-08-30T22:28:45.468Z",
  "next_action": "2025-08-30T22:28:45.468Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-08-30",
  "endtime": "2025-08-30",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-08-30T22:28:45.468Z",
  "modified_time": "2025-08-30T22:28:45.468Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}

Diagnosis Workflow Job Features

get

This endpoint is used to diagnosis feature of workflow jobs in the current organization

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/workflow_jobs/feature-diagnosis/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "business_hr_profile_name": "text",
  "execute_now_triggered": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-08-30T22:28:45.468Z",
  "next_action": "2025-08-30T22:28:45.468Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-08-30",
  "endtime": "2025-08-30",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-08-30T22:28:45.468Z",
  "modified_time": "2025-08-30T22:28:45.468Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}

Workflow Job Features Diagnosis Options

get

This endpoint is used to diagnosis feature options of workflow jobs in the current organization

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/workflow_jobs/feature-diagnosis-opts/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "business_hr_profile_name": "text",
  "execute_now_triggered": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-08-30T22:28:45.468Z",
  "next_action": "2025-08-30T22:28:45.468Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-08-30",
  "endtime": "2025-08-30",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-08-30T22:28:45.468Z",
  "modified_time": "2025-08-30T22:28:45.468Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}

Change or delete Workflow Jobs

post

This endpoint is used to change state or delete workflow jobs in the current organization

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRead-onlyRequired

schedule_detailsstringRead-onlyRequired

next_action_time_objstringRead-onlyRequired

last_action_time_objstringRead-onlyRequired

created_by_namestringRead-onlyRequired

modified_by_namestringRead-onlyRequired

business_hr_profile_namestringRead-onlyRequired

execute_now_triggeredstringRead-onlyRequired

created_by_profilestringRead-onlyRequired

modified_by_profilestringRead-onlyRequired

job_idstring · max: 25Required

organizationstring · max: 25Required

namestringRequired

descriptionstringOptional

jobnamestringOptional

progressbooleanOptional

last_actionstring · date-timeOptional

next_actionstring · date-timeOptional

starttimestring · dateOptional

endtimestring · dateOptional

is_enabledbooleanOptional

is_deletedbooleanOptional

creation_timestring · date-timeOptional

modified_timestring · date-timeOptional

created_bystringOptional

modified_bystringOptional

tzonestringOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/nccm/workflow_jobs/multi-change/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 631

{
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-08-30T22:28:45.468Z",
  "next_action": "2025-08-30T22:28:45.468Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-08-30",
  "endtime": "2025-08-30",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-08-30T22:28:45.468Z",
  "modified_time": "2025-08-30T22:28:45.468Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "business_hr_profile_name": "text",
  "execute_now_triggered": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-08-30T22:28:45.468Z",
  "next_action": "2025-08-30T22:28:45.468Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-08-30",
  "endtime": "2025-08-30",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-08-30T22:28:45.468Z",
  "modified_time": "2025-08-30T22:28:45.468Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}

Gets a workflow job options with the given id

get

This endpoint is used to fetch a workflow jobs options in the current organization

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/nccm/workflow_jobs/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "schedule_details": "text",
  "next_action_time_obj": "text",
  "last_action_time_obj": "text",
  "created_by_name": "text",
  "modified_by_name": "text",
  "business_hr_profile_name": "text",
  "execute_now_triggered": "text",
  "created_by_profile": "text",
  "modified_by_profile": "text",
  "job_id": "text",
  "organization": "text",
  "name": "text",
  "description": "text",
  "jobname": "text",
  "progress": true,
  "last_action": "2025-08-30T22:28:45.468Z",
  "next_action": "2025-08-30T22:28:45.468Z",
  "startdate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "enddate": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "starttime": "2025-08-30",
  "endtime": "2025-08-30",
  "is_enabled": true,
  "is_deleted": true,
  "creation_time": "2025-08-30T22:28:45.468Z",
  "modified_time": "2025-08-30T22:28:45.468Z",
  "created_by": "text",
  "modified_by": "text",
  "business_hr_profile": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "schedule_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "tzone": "text"
}