GetTask

GET

/api/v1/t/{tenant}/workflows/tasks/{taskId}

curl --request GET \
  --url https://example.com/api/v1/t/example/workflows/tasks/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Parameters

Path Parameters

tenant

required

string

Tenant slug

taskId

required

string format: uuid

Responses

200

OK

Media typeapplication/json

object

taskId

required

string format: uuid

instanceId

required

string format: uuid

documentId

required

string format: uuid

documentTitle

required

string

documentVersion

required

integer format: int32

kind

required

Allowed values: Approve Review Acknowledge Fix Capture SignatureFieldReview

state

required

Allowed values: Open Completed Cancelled

outcome

required

One of:

null

null

unknown

Allowed values: Approved Rejected Returned Done

template

required

Allowed values: InvoiceApproval ContractReview MailDistribution HrFileIntake Custom

stepName

required

string

stepLabel

required

null | string

assigneeUserId

required

null | string format: uuid

assigneeRoleId

required

null | string format: uuid

intendedForUserId

required

null | string format: uuid

escalatedToUserId

required

null | string format: uuid

escalatedToRoleId

required

null | string format: uuid

requestedBy

required

null | string format: uuid

requestedByName

required

null | string

canAct

required

boolean

excludedByFourEyes

required

boolean

assignedAt

required

string format: date-time

remindAt

required

null | string format: date-time

escalateAt

required

null | string format: date-time

dueAt

required

null | string format: date-time

completedBy

required

null | string format: uuid

completedAt

required

null | string format: date-time

hints

required

Array<object>

object

id

required

string format: uuid

kind

required

Allowed values: SuggestedApprover PossibleDuplicate ScriptNote Summary Plausibility AiAnswer Skonto MandatoryDetails OrderMatch ContractMatch

stepName

required

string

suggestedUserId

required

null | string format: uuid

duplicateDocumentId

required

null | string format: uuid

createdAt

required

string format: date-time

text

null | string

restricted

boolean

summaryVersion

null | integer format: int32

summaryLanguage

null | string

comments

required

Array<object>

object

id

required

string format: uuid

authorId

required

string format: uuid

authorName

required

string

text

required

string

createdAt

required

string format: date-time

history

required

Array<object>

object

id

required

string format: uuid

sequence

required

integer format: int32

kind

required

Allowed values: Started StepEntered TaskAssigned TaskDelegated TaskReminded TaskEscalated TaskCompleted HintAdded StepFailed Ended EscalationSkipped ApproverChosen StepSkipped TaskWithdrawn WebhookDelivered SignatureRequested SignatureFieldsReviewed SignatureSignerEnded SignatureEnded

stepName

required

null | string

stepLabel

required

null | string

taskId

required

null | string format: uuid

actorId

required

null | string format: uuid

actorName

required

null | string

userId

required

null | string format: uuid

roleId

required

null | string format: uuid

outcome

required

One of:

null

null

unknown

Allowed values: Approved Rejected Returned Done

state

required

One of:

null

null

unknown

Allowed values: Running Approved Rejected Completed Cancelled Failed

reason

required

One of:

null

null

unknown

Allowed values: StepBudgetExceeded DocumentTypeChanged CancelledByPerson AssigneeAbsent SubstituteAbsent NotOnConfidentialList RequesterCannotFix NoRequester StepActivityFailed AdvanceFailed EscalationTargetAbsent EscalationTargetExcluded CostCenterOfAllocation CostCenterOfVendor NoCostCenter NoCostCenterResponsible AiStepConfidential AiStepNoCredits AiStepAiDisabled AiStepGatewayUnavailable AiStepNoText AiStepInvalidAnswer AiStepTimedOut AiStepNothingToCheck ParallelApproved ParallelRejected ParallelReturned ParallelSameVote SetFieldSourceEmpty SetFieldRefused StartWorkflowChainTooDeep StartWorkflowAlreadyRunning StartWorkflowNotStartable ExternalEmailNoRecipient ExternalEmailRecipientUnconfirmed ExternalEmailConfidential ExternalEmailLimitReached ExternalEmailTemplateMissing ExternalEmailFailed ExternalEmailTenantLimit ExternalEmailTrial WebhookConfidential WebhookLimitReached WebhookEndpointMissing WebhookTenantLimit WebhookFailed FileByFieldNoFile FileNotCreatable WebhookDocumentUnavailable ApprovalLimitLevel ApprovalLimitSubstitute ApprovalLimitNoRow ApprovalLimitNobody ApprovalLimitNoAmount ApprovalLimitNoTable TaskDeadlineMissing SignatureNotEnabled SignatureQuota SignatureConfidential SignatureSignerUnresolved SignatureSignerWithoutAccess SignatureNoPdf SignatureTooLarge SignatureDocumentInSignature SignatureCancelled SignatureFailed SignatureTimedOut SignatureReviewCancelled SignatureNoReviewer SignatureNoRequester SignatureDocumentDeleted SignatureSealUnavailable

occurredAt

required

string format: date-time

comment

required

null | string

linkedDocument

One of:

null

null

object

object

documentId

required

null | string format: uuid

title

required

null | string

stepName

required

string

stepLabel

required

null | string

linkedAt

required

string format: date-time

restricted

required

boolean

signature

One of:

null

null

object

object

signers

required

Array<object>

object

position

required

integer format: int32

label

required

string

source

required

Allowed values: Member Requester External

outcome

One of:

null

null

unknown

Allowed values: Signed Declined Expired Cancelled

fieldSources

required

Array

Allowed values: AcroForm Anchor Keyword Ai Template Manual

level

One of:

null

null

unknown

Allowed values: Ses Aes Qes

fieldMode

One of:

null

null

unknown

Allowed values: TypeTemplate Detect ReviewBeforeSend

fieldsReason

One of:

null

null

unknown

Allowed values: ReviewRequested NoTemplate TemplateDoesNotFit SignerWithoutField DetectionFailed SignerUnconfirmed

outcome

One of:

null

null

unknown

Allowed values: Signed Declined Expired Cancelled Failed

pickFile

required

boolean

documentTypeId

required

null | string format: uuid

grossAmount

required

null | number format: double

currency

required

null | string

vendorName

required

null | string

invoice

required

One of:

null

null

object

object

netTotal

required

null | number format: double

taxTotal

required

null | number format: double

taxLines

required

Array<object>

object

rate

required

number format: double

net

required

number format: double

tax

required

number format: double

dueDate

required

null | string format: date

skontoPercent

required

null | number format: double

skontoUntil

required

null | string format: date

costCenter

required

One of:

null

null

object

object

id

required

string format: uuid

number

required

string

name

required

string

glAccount

required

One of:

null

null

object

object

id

required

string format: uuid

number

required

string

name

required

string

definitionName

required

null | string

requiredFields

One of:

null

null

object

object

fields

required

Array<string>

requireComment

required

boolean

missing

required

Array<string>

parallel

One of:

null

null

object

object

mode

required

Allowed values: All Any Quorum

quorum

required

integer format: int32

approvals

required

integer format: int32

rejections

required

integer format: int32

open

required

integer format: int32

votes

required

Array<object>

object

taskId

required

string format: uuid

assigneeUserId

required

null | string format: uuid

assigneeRoleId

required

null | string format: uuid

assigneeName

required

null | string

state

required

Allowed values: Open Completed Cancelled

outcome

required

One of:

null

null

unknown

Allowed values: Approved Rejected Returned Done

completedByName

required

null | string

completedAt

required

null | string format: date-time

isThisTask

required

boolean

linkedDocuments

Array<object> | null

object

documentId

required

null | string format: uuid

title

required

null | string

stepName

required

string

stepLabel

required

null | string

linkedAt

required

string format: date-time

restricted

required

boolean

deadline

One of:

null

null

object

object

date

required

string format: date

valueKey

required

null | string

fieldKey

required

null | string

signatureReview

One of:

null

null

object

object

requestId

required

string format: uuid

reason

required

One of:

null

null

unknown

Allowed values: ReviewRequested NoTemplate TemplateDoesNotFit SignerWithoutField DetectionFailed SignerUnconfirmed

canEdit

required

boolean

notice

required

null | string

Example

{
  "kind": "Approve",
  "state": "Open",
  "outcome": "Approved",
  "template": "InvoiceApproval",
  "hints": [
    {
      "kind": "SuggestedApprover",
      "restricted": false
    }
  ],
  "history": [
    {
      "kind": "Started",
      "outcome": "Approved",
      "state": "Running",
      "reason": "StepBudgetExceeded",
      "signature": {
        "signers": [
          {
            "source": "Member",
            "outcome": "Signed"
          }
        ],
        "fieldSources": [
          "AcroForm"
        ],
        "level": "Ses",
        "fieldMode": "TypeTemplate",
        "fieldsReason": "ReviewRequested",
        "outcome": "Signed"
      }
    }
  ],
  "parallel": {
    "mode": "All",
    "votes": [
      {
        "state": "Open",
        "outcome": "Approved"
      }
    ]
  },
  "signatureReview": {
    "reason": "ReviewRequested"
  }
}

403

Forbidden

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

429

Too Many Requests

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}