GetInstanceHistory

GET

/api/v1/t/{tenant}/workflows/instances/{instanceId}/history

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

Parameters

Path Parameters

tenant

required

string

Tenant slug

instanceId

required

string format: uuid

Responses

200

OK

Media typeapplication/json

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

Example

[
  {
    "kind": "Started",
    "outcome": "Approved",
    "state": "Running",
    "reason": "StepBudgetExceeded",
    "signature": {
      "signers": [
        {
          "source": "Member",
          "outcome": "Signed"
        }
      ],
      "fieldSources": [
        "AcroForm"
      ],
      "level": "Ses",
      "fieldMode": "TypeTemplate",
      "fieldsReason": "ReviewRequested",
      "outcome": "Signed"
    }
  }
]

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"
}