task

Query tasks for assessments in the organization

Changed on
get/v1/org/{orgId}/task/query

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/task/query
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

userIdstring

Task User id

assessmentIdstring

Assessment id

status'PENDING' | 'DONE' | 'EXPIRED' | 'SKIPPED'

Task.Status. (PENDING/DONE)

type'FORM_SUBMIT' | 'FORM_RESPONSE_APPROVE' | 'FORM_RESPONSE_RESUBMIT' | 'CHANGE_APPROVE' | 'TIMEOFF_APPROVE' | 'SCENARIO_CHANGES_APPROVE' | 'SCENARIO_CHANGES_CREATE' | 'ORG_IMPORT' | 'COMP_REVIEW_APPROVAL_SUBMIT' | 'SCENARIO_APPROVAL_SUBMIT' | 'APPROVAL_CHAIN_UPDATE_FALLBACK_APPROVER' | 'ACTION' | 'SIGNATURE' | 'GOAL_PROGRESS' | 'TODO'

Task.Type. (FORM_SUBMIT/CHANGE_APPROVE)

entityIdstring

Entity Id

targetIdstring

Target Id (deprecated, use targetIds)

targetIdsstring

Comma-separated target ids to filter by

limitinteger

Number of results to return

fieldsstring

Fields to retrieve, comma-separated

formatstring

Data format to use; default is json, can also use json-extended or json-readable

fromstring

Job id to start paginating from

returnAccessstring

Return access information -- pass a list of actions to check, for example: create,update,delete

returnFormCompletionLinksboolean

Return links that employees would use to complete a task if true else return links that direct to the form settings

taskIdstring

Task id

createAtFromstring

Created at from (inclusive)

createAtUntilstring

Created at until (exclusive)

Response

Return tasks for assessments in the organization

dataobject[] required
nextstring
totalRowobject

Example response

{
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}

Changes