HRIS
- Overview
- Use Cases
Common Guides
API Reference
- Companies
- Custom Field Definitions
- Employees
- GETList Employees
- POSTCreates an employee
- GETGet Employee
- PATCHUpdates an employee
- POSTInvite Employee
- Time Off
- Documents
- Work Eligibility
- Time Off Balances
- Employments
- Skills
- Time Off Policies
- Tasks
- GET
- Documents
- Employments
- Locations
- Time Off
- Time Entries
- Benefits
- Groups
- Jobs
- Time Off Policies
Tasks
Complete Employee Task
PATCH
/
unified
/
hris
/
employees
/
{id}
/
tasks
/
{subResourceId}
Copy
Ask AI
curl --request PATCH \
--url https://api.stackone.com/unified/hris/employees/{id}/tasks/{subResourceId} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'x-account-id: <x-account-id>' \
--data '{
"comment": "All required documents have been submitted"
}'
Copy
Ask AI
{
"data": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"employee_id": "cx280928937",
"name": "Complete onboarding documents",
"description": "Please complete all required onboarding documents in the employee portal",
"type": {
"value": "action",
"source_value": "<string>"
},
"status": {
"value": "open",
"source_value": "<string>"
},
"due_date": "2024-03-20T23:59:59.000Z",
"completion_date": "2024-03-19T15:30:00.000Z",
"assigned_by_employee_id": "cx280928938",
"assigned_by_employee_name": "John Smith",
"link_to_task": "https://provider.com/tasks/123",
"extracted_links": [
"https://provider.com/docs/1",
"https://provider.com/forms/2"
],
"next_task_id": "cx280928939",
"parent_process_name": "Onboarding Tasks",
"comments": [
{
"author_employee_id": "<string>",
"comment": "Approved based on in-person assessment",
"created_at": "2024-03-15T10:00:00.000Z"
}
],
"attachments": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "My Document",
"path": "/path/to/file",
"category": "templates, forms, backups, etc.",
"contents": [
{
"url": "https://example.com/file.pdf",
"unified_url": "https://api.stackone.com/unified/hris/employees/12345/documents/67890/download",
"file_format": {
"value": "pdf",
"source_value": "application/pdf"
}
}
],
"category_id": "6530",
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-02T01:01:01.000Z",
"remote_url": "https://example.com/file.pdf",
"file_format": {
"value": "pdf",
"source_value": "application/pdf"
}
}
],
"created_at": "2024-03-15T10:00:00.000Z",
"updated_at": "2024-03-19T15:30:00.000Z"
}
],
"raw": [
{
"method": "<string>",
"url": "<string>",
"body": "<string>",
"response": {}
}
]
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Headers
The account identifier
Query Parameters
Body
application/json
Response
200
application/json
The task has been successfully completed
The response is of type object
.
Was this page helpful?
Copy
Ask AI
curl --request PATCH \
--url https://api.stackone.com/unified/hris/employees/{id}/tasks/{subResourceId} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'x-account-id: <x-account-id>' \
--data '{
"comment": "All required documents have been submitted"
}'
Copy
Ask AI
{
"data": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"employee_id": "cx280928937",
"name": "Complete onboarding documents",
"description": "Please complete all required onboarding documents in the employee portal",
"type": {
"value": "action",
"source_value": "<string>"
},
"status": {
"value": "open",
"source_value": "<string>"
},
"due_date": "2024-03-20T23:59:59.000Z",
"completion_date": "2024-03-19T15:30:00.000Z",
"assigned_by_employee_id": "cx280928938",
"assigned_by_employee_name": "John Smith",
"link_to_task": "https://provider.com/tasks/123",
"extracted_links": [
"https://provider.com/docs/1",
"https://provider.com/forms/2"
],
"next_task_id": "cx280928939",
"parent_process_name": "Onboarding Tasks",
"comments": [
{
"author_employee_id": "<string>",
"comment": "Approved based on in-person assessment",
"created_at": "2024-03-15T10:00:00.000Z"
}
],
"attachments": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "My Document",
"path": "/path/to/file",
"category": "templates, forms, backups, etc.",
"contents": [
{
"url": "https://example.com/file.pdf",
"unified_url": "https://api.stackone.com/unified/hris/employees/12345/documents/67890/download",
"file_format": {
"value": "pdf",
"source_value": "application/pdf"
}
}
],
"category_id": "6530",
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-02T01:01:01.000Z",
"remote_url": "https://example.com/file.pdf",
"file_format": {
"value": "pdf",
"source_value": "application/pdf"
}
}
],
"created_at": "2024-03-15T10:00:00.000Z",
"updated_at": "2024-03-19T15:30:00.000Z"
}
],
"raw": [
{
"method": "<string>",
"url": "<string>",
"body": "<string>",
"response": {}
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.