v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB

Workflows

List All Workflow Signers

Returns a list of workflow signers and the status of their signature.

OAuth Scope required: public.workflows.readSignatures

get/workflows/{id}/signatures

Path parameters

idstring required

The unique identifier or Ironclad ID of a workflow.

Headers

x-as-user-emailstring

Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-idstring

Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Response

200

workflowIdstring

titlestring

Example response

{
  "workflowId": "6dac47a10b1242d1f7df688d",
  "title": "Goldendoodle Adoption Contract",
  "signers": [
    {
      "name": "Jimothy Kim",
      "email": "jimothykim@example.com",
      "roleName": "Counterparty Signer",
      "delegates": [
        {
          "name": "Kim Lam",
          "email": "kimlam@example.com"
        }
      ]
    }
  ]
}