Get Workflow Run

curl --location --request GET 'https://api-prod.extend.app/workflow_runs/:workflowRunId' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_TOKEN>'

{
  "success": true,
  "workflowRun": {
    "object": "workflow_run",
    "id": "workflow_run_1234",
    "status": "PROCESSED",
    "metadata": {
      "internal_id": "id_1234"
    },
    "files": [
      {
        "object": "file",
        "id": "file_1234",
        "name": "example_file_name.pdf",
      }
    ],
    "initialRunAt": "2023-01-01T09:41:00.000Z",
    "reviewedBy": "user_1234",
    "reviewedAt": "2023-01-10T05:39:14.500Z",
    "startTime": "2023-01-01T09:41:00.000Z",
    "endTime": "2023-01-10T05:39:24.500Z",
    "outputs": [
      {
        "object": "document_processor_run",
        "id": "dpr_1234",
        "edited": true,
        "type": "EXTRACT",
        "initialOutput": {
          // Output object - see “Processor output types” for details
        },
        "reviewedOutput": {
          // Output object - see “Processor output types” for details
        },
        "output": { 
          // Output object - see “Processor output types” for details
        }
      }
    ],
    "workflow": {
      "object": "workflow",
      "id": "workflow_1234",
      "version": "1",
      "name": "test_workflow"
    }
  }
}

Path

workflowRunId

string

The ID of the WorkflowRun that was outputted after a Workflow was run through the API.

Response

success

boolean

A true or false value for whether the request was successful.

workflowRun

WorkflowRun

An object representing a WorkflowRun. See the WorkflowRun object for the shape of the data.

$	curl --location --request GET 'https://api-prod.extend.app/workflow_runs/:workflowRunId' \
>	--header 'Content-Type: application/json' \
>	--header 'Authorization: Bearer <API_TOKEN>'

1	{
2	"success": true,
3	"workflowRun": {
4	"object": "workflow_run",
5	"id": "workflow_run_1234",
6	"status": "PROCESSED",
7	"metadata": {
8	"internal_id": "id_1234"
9	},
10	"files": [
11	{
12	"object": "file",
13	"id": "file_1234",
14	"name": "example_file_name.pdf",
15	}
16	],
17	"initialRunAt": "2023-01-01T09:41:00.000Z",
18	"reviewedBy": "user_1234",
19	"reviewedAt": "2023-01-10T05:39:14.500Z",
20	"startTime": "2023-01-01T09:41:00.000Z",
21	"endTime": "2023-01-10T05:39:24.500Z",
22	"outputs": [
23	{
24	"object": "document_processor_run",
25	"id": "dpr_1234",
26	"edited": true,
27	"type": "EXTRACT",
28	"initialOutput": {
29	// Output object - see “Processor output types” for details
30	},
31	"reviewedOutput": {
32	// Output object - see “Processor output types” for details
33	},
34	"output": {
35	// Output object - see “Processor output types” for details
36	}
37	}
38	],
39	"workflow": {
40	"object": "workflow",
41	"id": "workflow_1234",
42	"version": "1",
43	"name": "test_workflow"
44	}
45	}
46	}