Usage Info

Retrieve a list of all signed agreements for specific workflow_id.

Request

Parameters

Parameter	Type	Required	Description
workflow_id	string	Yes	The unique identifier of the Workflow to retrieve defense documents for.

Example

{
  "workflow_id": "w_7h1EpxerrZQyLnRC1EQ9Ck",
}

Response

Data

Parameter	Type	Description
agreements	array of objects	The agreements parameter defined in the table below.

Agreement Parameters

Type	Parameter	Description
string	agreement_id	The identifier for the signed Agreement.
string	agreement_name	The name of the signed Agreement.
string	signer_email	The email of a signer accepting the agreement.
string	signed_at	The date-time when the agreement was accepted. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6zNzQZHSf26V83BO3uW6dS",
    "version": "2025-03-24"
  },
  "data": {
    "agreements": [
      {
        "agreement_id": "43b7816d-62af-4820-9e0d-ca95201bb8dd",
				"agreement_name": "Agreement Name",
        "signer_email": "[email protected]",
        "signed_at": "2025-11-13T22:37:02.703Z"
      }
    ]
  }
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided. Invalid values provided.
ENTITY_NOT_FOUND	400	The `workflow_id` provided does not exist.