Skip to content
AcrivaDocs

ListMyTasks

GET
/api/v1/t/{tenant}/workflows/tasks
curl --request GET \
  --url 'https://example.com/api/v1/t/example/workflows/tasks?sort=Oldest'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
tenant
required
string

Tenant slug

Query Parameters

Section titled “Query Parameters”
page
integer format: int32
pageSize
integer format: int32
sort
Allowed values: Oldest DueDate
q
string

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
items
required
Array<object>
object
taskId
required
string format: uuid
instanceId
required
string format: uuid
documentId
required
string format: uuid
documentTitle
required
string
kind
required
Allowed values: Approve Review Acknowledge Fix Capture SignatureFieldReview
template
required
Allowed values: InvoiceApproval ContractReview MailDistribution HrFileIntake Custom
stepName
required
string
stepLabel
required
null | string
requestedBy
required
null | string format: uuid
requestedByName
required
null | string
intendedForUserId
required
null | string format: uuid
escalated
required
boolean
assignedAt
required
string format: date-time
dueAt
required
null | string format: date-time
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
collectiveApprovalEligible
required
boolean
definitionName
required
null | string
page
required
integer format: int32
pageSize
required
integer format: int32
total
required
integer format: int32
collectiveApprovalCap
required
null | number format: double
Example
{
  "items": [
    {
      "kind": "Approve",
      "template": "InvoiceApproval"
    }
  ]
}

400

Section titled “400”

Bad Request

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
errors
object
key
additional properties
Array<string>
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

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

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