Skip to content

Get Desk Play Execution

GET
/desk/plays/executions/{execution_id}

Live state of one play run.

Pass decision_id only if you want the card updated when the run reaches a terminal state; that is what the desk’s own status chip does as it polls.

Authorizations

Parameters

Path Parameters

execution_id
required

Workflow execution id.

string

Workflow execution id.

Query Parameters

decision_id
Any of:
string

Card this run belongs to. When given, a TERMINAL status is persisted onto the card - so this read has a write side, and omitting it keeps the read pure.

action_id
Any of:
string

Play this run belongs to.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for one desk object.

Open on purpose - see the module docstring. A rebuilder gets every field the desk returns, including ones added after this contract version.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string