Get Stage Diagram (Beta) — DevRev

Gets a stage diagram.

Query parameters

idstringOptional

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_typestringOptional

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

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

1 { 2 "stage_diagram": { 3 "id": "id", 4 "stages": [ 5 {} 6 ], 7 "created_by": { 8 "type": "sys_user", 9 "id": "created_by", 10 "display_id": "created_by", 11 "display_name": "created_by", 12 "display_picture": { 13 "id": "id" 14 }, 15 "email": "created_by", 16 "full_name": "created_by", 17 "state": "active" 18 }, 19 "created_date": "2023-01-01T12:00:00Z", 20 "display_id": "display_id", 21 "is_custom_leaf_type": true, 22 "is_default": true, 23 "leaf_type": "leaf_type", 24 "modified_by": { 25 "type": "sys_user", 26 "id": "modified_by", 27 "display_id": "modified_by", 28 "display_name": "modified_by", 29 "display_picture": { 30 "id": "id" 31 }, 32 "email": "modified_by", 33 "full_name": "modified_by", 34 "state": "active" 35 }, 36 "modified_date": "2023-01-01T12:00:00Z", 37 "name": "name" 38 } 39 }

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

1	{
2	"stage_diagram": {
3	"id": "id",
4	"stages": [
5	{}
6	],
7	"created_by": {
8	"type": "sys_user",
9	"id": "created_by",
10	"display_id": "created_by",
11	"display_name": "created_by",
12	"display_picture": {
13	"id": "id"
14	},
15	"email": "created_by",
16	"full_name": "created_by",
17	"state": "active"
18	},
19	"created_date": "2023-01-01T12:00:00Z",
20	"display_id": "display_id",
21	"is_custom_leaf_type": true,
22	"is_default": true,
23	"leaf_type": "leaf_type",
24	"modified_by": {
25	"type": "sys_user",
26	"id": "modified_by",
27	"display_id": "modified_by",
28	"display_name": "modified_by",
29	"display_picture": {
30	"id": "id"
31	},
32	"email": "modified_by",
33	"full_name": "modified_by",
34	"state": "active"
35	},
36	"modified_date": "2023-01-01T12:00:00Z",
37	"name": "name"
38	}
39	}