Get Stage Diagram

GET

Gets a stage diagram.

Query parameters

idstringOptionalformat: "id"

The ID of the stage diagram to get.

is_custom_leaf_typebooleanOptional

Whether the leaf type corresponds to a custom object. Specify this along with leaf_type to get the default custom object stage diagram.

leaf_typestringOptionalformat: "text"

The leaf type. Should be specified to retrieve the default stage diagram for the leaf type. If not provided, then id is used.

Response

Success.

stage_diagramobject

Errors

GET

1 curl https://api.devrev.ai/stage-diagrams.get \
2      -H "Authorization: Bearer <token>"

200stageDiagramsGetExample

1 {
2   "stage_diagram": {
3     "id": "foo",
4     "stages": [
5       {
6         "is_deprecated": true,
7         "is_start": true,
8         "stage": {
9           "id": "foo",
10           "display_id": "foo",
11           "name": "foo"
12         },
13         "transitions": [
14           {
15             "target_stage": {
16               "id": "foo",
17               "display_id": "foo",
18               "name": "foo"
19             }
20           }
21         ]
22       }
23     ],
24     "created_by": {
25       "display_id": "foo",
26       "id": "foo",
27       "display_name": "foo",
28       "display_picture": {
29         "display_id": "foo",
30         "id": "foo",
31         "file": {
32           "type": "foo",
33           "name": "foo",
34           "size": 42
35         }
36       },
37       "email": "foo",
38       "full_name": "foo",
39       "state": "active"
40     },
41     "created_date": "2023-01-01T12:00:00.000Z",
42     "display_id": "foo",
43     "is_custom_leaf_type": true,
44     "is_default": true,
45     "leaf_type": "foo",
46     "modified_by": {
47       "display_id": "foo",
48       "id": "foo",
49       "display_name": "foo",
50       "display_picture": {
51         "display_id": "foo",
52         "id": "foo",
53         "file": {
54           "type": "foo",
55           "name": "foo",
56           "size": 42
57         }
58       },
59       "email": "foo",
60       "full_name": "foo",
61       "state": "active"
62     },
63     "modified_date": "2023-01-01T12:00:00.000Z",
64     "name": "foo"
65   }
66 }

Get Stage Diagram (POST)

Up Next

Built with

1	curl https://api.devrev.ai/stage-diagrams.get \
2	-H "Authorization: Bearer <token>"

1	{
2	"stage_diagram": {
3	"id": "foo",
4	"stages": [
5	{
6	"is_deprecated": true,
7	"is_start": true,
8	"stage": {
9	"id": "foo",
10	"display_id": "foo",
11	"name": "foo"
12	},
13	"transitions": [
14	{
15	"target_stage": {
16	"id": "foo",
17	"display_id": "foo",
18	"name": "foo"
19	}
20	}
21	]
22	}
23	],
24	"created_by": {
25	"display_id": "foo",
26	"id": "foo",
27	"display_name": "foo",
28	"display_picture": {
29	"display_id": "foo",
30	"id": "foo",
31	"file": {
32	"type": "foo",
33	"name": "foo",
34	"size": 42
35	}
36	},
37	"email": "foo",
38	"full_name": "foo",
39	"state": "active"
40	},
41	"created_date": "2023-01-01T12:00:00.000Z",
42	"display_id": "foo",
43	"is_custom_leaf_type": true,
44	"is_default": true,
45	"leaf_type": "foo",
46	"modified_by": {
47	"display_id": "foo",
48	"id": "foo",
49	"display_name": "foo",
50	"display_picture": {
51	"display_id": "foo",
52	"id": "foo",
53	"file": {
54	"type": "foo",
55	"name": "foo",
56	"size": 42
57	}
58	},
59	"email": "foo",
60	"full_name": "foo",
61	"state": "active"
62	},
63	"modified_date": "2023-01-01T12:00:00.000Z",
64	"name": "foo"
65	}
66	}