The step object

Attributes

  • id integer

The step identifier.

  • order integer

An integer representing the order number of a step in a workflow.

  • type string

The type of step can be sign or review.

  • status string

The step status can be not_started, started, approved or declined.

  • expiryDate integer

An optional timestamp of the expiration date.

  • actions array

An array of actions linked to the step.

Example

{
    "id": 1,
    "order": 1,
    "type": "sign",
    "status": "started",
    "expiryDate": null,
    "actions": [
        {
            "id": 1,
            "stepNumber": 1,
            "role": 1,
            "type": "sign",
            "status": "started",
            "recipientId": 1,
            "recipientEmail": "jane.doe@example.com"
        }
    ]
}