Skip to content
AcrivaDocs

ListFileInstances

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

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
tenant
required
string

Tenant slug

fileId
required
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
items
required
Array<object>
object
instance
required
object
instanceId
required
string format: uuid
definitionId
required
string format: uuid
definitionVersion
required
integer format: int32
template
required
Allowed values: InvoiceApproval ContractReview MailDistribution HrFileIntake Custom
definitionName
required
string
documentId
required
string format: uuid
documentVersion
required
integer format: int32
state
required
Allowed values: Running Approved Rejected Completed Cancelled Failed
currentStep
required
null | string
stepLabel
required
null | string
startedBy
required
null | string format: uuid
startedAt
required
string format: date-time
endedAt
required
null | string format: date-time
endingComment
required
One of:
null
lastReturnComment
required
One of:
null
documentTitle
required
string
total
required
integer format: int32
Example
{
  "items": [
    {
      "instance": {
        "template": "InvoiceApproval",
        "state": "Running"
      }
    }
  ]
}

403

Section titled “403”

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Section titled “404”

Not Found

429

Section titled “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
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}