List Stage Diagrams (POST)

POST

Lists stage diagrams.

Request

This endpoint expects an object.

cursorstringOptionalformat: "text"

The cursor to resume iteration from, otherwise if not provided, then iteration starts from the beginning.

is_custom_leaf_typebooleanOptional

Whether only custom object stage diagrams should be filtered.

leaf_typelist of stringsOptional

The list of leaf types.

limitintegerOptional

The maximum number of items.

namelist of stringsOptional

The list of stage diagram names.

sort_bylist of stringsOptional

The list of fields to sort the items by and how to sort them.

Response

Success.

resultlist of objects

The stage diagram.

cursorstringOptionalformat: "text"

The cursor to resume iteration from, otherwise if not provided, then iteration starts from the beginning.

POST

1 curl -X POST https://api.devrev.ai/stage-diagrams.list \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

200Successful

1 {
2   "result": [
3     {
4       "id": "id",
5       "stages": [
6         {
7           "is_deprecated": true,
8           "is_start": true,
9           "stage": {
10             "id": "id",
11             "display_id": "display_id",
12             "name": "name"
13           },
14           "transitions": [
15             {
16               "target_stage": {}
17             },
18             {
19               "target_stage": {}
20             }
21           ]
22         },
23         {
24           "is_deprecated": true,
25           "is_start": true,
26           "stage": {
27             "id": "id",
28             "display_id": "display_id",
29             "name": "name"
30           },
31           "transitions": [
32             {
33               "target_stage": {}
34             },
35             {
36               "target_stage": {}
37             }
38           ]
39         }
40       ],
41       "created_by": {
42         "type": "dev_user",
43         "id": "id",
44         "display_id": "display_id",
45         "display_name": "display_name",
46         "display_picture": {
47           "id": "id",
48           "file": {}
49         },
50         "email": "email",
51         "full_name": "full_name",
52         "state": "active"
53       },
54       "created_date": "created_date",
55       "display_id": "display_id",
56       "is_custom_leaf_type": true,
57       "is_default": true,
58       "leaf_type": "leaf_type",
59       "modified_by": {
60         "type": "dev_user",
61         "id": "id",
62         "display_id": "display_id",
63         "display_name": "display_name",
64         "display_picture": {
65           "id": "id",
66           "file": {}
67         },
68         "email": "email",
69         "full_name": "full_name",
70         "state": "active"
71       },
72       "modified_date": "modified_date",
73       "name": "name"
74     },
75     {
76       "id": "id",
77       "stages": [
78         {
79           "is_deprecated": true,
80           "is_start": true,
81           "stage": {
82             "id": "id",
83             "display_id": "display_id",
84             "name": "name"
85           },
86           "transitions": [
87             {
88               "target_stage": {}
89             },
90             {
91               "target_stage": {}
92             }
93           ]
94         },
95         {
96           "is_deprecated": true,
97           "is_start": true,
98           "stage": {
99             "id": "id",
100             "display_id": "display_id",
101             "name": "name"
102           },
103           "transitions": [
104             {
105               "target_stage": {}
106             },
107             {
108               "target_stage": {}
109             }
110           ]
111         }
112       ],
113       "created_by": {
114         "type": "dev_user",
115         "id": "id",
116         "display_id": "display_id",
117         "display_name": "display_name",
118         "display_picture": {
119           "id": "id",
120           "file": {}
121         },
122         "email": "email",
123         "full_name": "full_name",
124         "state": "active"
125       },
126       "created_date": "created_date",
127       "display_id": "display_id",
128       "is_custom_leaf_type": true,
129       "is_default": true,
130       "leaf_type": "leaf_type",
131       "modified_by": {
132         "type": "dev_user",
133         "id": "id",
134         "display_id": "display_id",
135         "display_name": "display_name",
136         "display_picture": {
137           "id": "id",
138           "file": {}
139         },
140         "email": "email",
141         "full_name": "full_name",
142         "state": "active"
143       },
144       "modified_date": "modified_date",
145       "name": "name"
146     }
147   ],
148   "cursor": "cursor"
149 }

Update Stage Diagram

Up Next

Built with

1	curl -X POST https://api.devrev.ai/stage-diagrams.list \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"result": [
3	{
4	"id": "id",
5	"stages": [
6	{
7	"is_deprecated": true,
8	"is_start": true,
9	"stage": {
10	"id": "id",
11	"display_id": "display_id",
12	"name": "name"
13	},
14	"transitions": [
15	{
16	"target_stage": {}
17	},
18	{
19	"target_stage": {}
20	}
21	]
22	},
23	{
24	"is_deprecated": true,
25	"is_start": true,
26	"stage": {
27	"id": "id",
28	"display_id": "display_id",
29	"name": "name"
30	},
31	"transitions": [
32	{
33	"target_stage": {}
34	},
35	{
36	"target_stage": {}
37	}
38	]
39	}
40	],
41	"created_by": {
42	"type": "dev_user",
43	"id": "id",
44	"display_id": "display_id",
45	"display_name": "display_name",
46	"display_picture": {
47	"id": "id",
48	"file": {}
49	},
50	"email": "email",
51	"full_name": "full_name",
52	"state": "active"
53	},
54	"created_date": "created_date",
55	"display_id": "display_id",
56	"is_custom_leaf_type": true,
57	"is_default": true,
58	"leaf_type": "leaf_type",
59	"modified_by": {
60	"type": "dev_user",
61	"id": "id",
62	"display_id": "display_id",
63	"display_name": "display_name",
64	"display_picture": {
65	"id": "id",
66	"file": {}
67	},
68	"email": "email",
69	"full_name": "full_name",
70	"state": "active"
71	},
72	"modified_date": "modified_date",
73	"name": "name"
74	},
75	{
76	"id": "id",
77	"stages": [
78	{
79	"is_deprecated": true,
80	"is_start": true,
81	"stage": {
82	"id": "id",
83	"display_id": "display_id",
84	"name": "name"
85	},
86	"transitions": [
87	{
88	"target_stage": {}
89	},
90	{
91	"target_stage": {}
92	}
93	]
94	},
95	{
96	"is_deprecated": true,
97	"is_start": true,
98	"stage": {
99	"id": "id",
100	"display_id": "display_id",
101	"name": "name"
102	},
103	"transitions": [
104	{
105	"target_stage": {}
106	},
107	{
108	"target_stage": {}
109	}
110	]
111	}
112	],
113	"created_by": {
114	"type": "dev_user",
115	"id": "id",
116	"display_id": "display_id",
117	"display_name": "display_name",
118	"display_picture": {
119	"id": "id",
120	"file": {}
121	},
122	"email": "email",
123	"full_name": "full_name",
124	"state": "active"
125	},
126	"created_date": "created_date",
127	"display_id": "display_id",
128	"is_custom_leaf_type": true,
129	"is_default": true,
130	"leaf_type": "leaf_type",
131	"modified_by": {
132	"type": "dev_user",
133	"id": "id",
134	"display_id": "display_id",
135	"display_name": "display_name",
136	"display_picture": {
137	"id": "id",
138	"file": {}
139	},
140	"email": "email",
141	"full_name": "full_name",
142	"state": "active"
143	},
144	"modified_date": "modified_date",
145	"name": "name"
146	}
147	],
148	"cursor": "cursor"
149	}