Desk

Get Desk Play Execution

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.

get/desk/plays/executions/{execution_id}

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/desk/plays/executions/{execution_id}
  • Auth: HTTP bearer

Path parameters

execution_idstring required

Workflow execution id.

Query parameters

decision_idstring nullable

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_idstring nullable

Play this run belongs to.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataDeskPayload 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.

Changes

No recorded changes to this operation across all 2 revisions of this API.