GET
/
unified
/
hris
/
employees
/
{id}
/
tasks
/
{subResourceId}
Get Employee Task
curl --request GET \
  --url https://api.stackone.com/unified/hris/employees/{id}/tasks/{subResourceId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'
{
  "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

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

​
x-account-id
string
required

The account identifier

Path Parameters

​
id
string
required
​
subResourceId
string
required

Query Parameters

​
raw
boolean | null

Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

​
proxy
object | null

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

​
fields
string | null

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

Example:

"id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at"

​
expand
string | null

The comma separated list of fields that will be expanded in the response

Example:

"attachments"

Response

200
application/json

The task with the given identifier for the employee was retrieved.

The response is of type object.