List Articles

GET

Lists a collection of articles.

Query parameters

applies_to_partslist of stringsOptional

Filters for articles belonging to any of the provided parts.

article_typelist of enumsOptional

Filter for the type of articles. If this is not provided, then articles that are not content blocks are returned.

Allowed values: articlecontent_block

authored_bylist of stringsOptional

Filters for articles authored by any of the provided users.

created_bylist of stringsOptional

Filters for articles created by any of the provided users.

cursorstringOptional

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

limitintegerOptional

The maximum number of articles to return. The default is ‘50’.

modeenumRequired

The iteration mode to use, otherwise if not set, then “after” is used.

Allowed values: afterbefore

modified_bylist of stringsOptional

Filters for articles modified by any of the provided users.

owned_bylist of stringsOptional

Filters for articles owned by any of the provided users.

scopelist of longsOptional

Filter for the scope of the articles.

shared_with.memberstringOptional

ID of the group/member with whom the item is shared.

shared_with.rolestringOptional

Role ID of the group/member with whom the item is shared.

tagslist of stringsOptional

Filters for article with any of the provided tags.

Response

List articles response.

articleslist of objects

The article entries matching the request.

totalinteger

Total number of article items for the request.

next_cursorstringOptional

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptional

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

GET

1 curl -G https://api.devrev.ai/articles.list \
2      -H "Authorization: Bearer <token>" \
3      -d mode=after

200Retrieved

1 {
2   "articles": [
3     {
4       "applies_to_parts": [
5         {
6           "type": "capability",
7           "id": "id",
8           "name": "name",
9           "owned_by": [
10             {
11               "type": "dev_user",
12               "display_picture": {
13                 "file": {}
14               },
15               "id": "id",
16               "state": "active",
17               "display_name": "display_name",
18               "email": "email",
19               "full_name": "full_name"
20             },
21             {
22               "type": "dev_user",
23               "display_picture": {
24                 "file": {}
25               },
26               "id": "id",
27               "state": "active",
28               "display_name": "display_name",
29               "email": "email",
30               "full_name": "full_name"
31             }
32           ],
33           "display_id": "display_id"
34         },
35         {
36           "type": "capability",
37           "id": "id",
38           "name": "name",
39           "owned_by": [
40             {
41               "type": "dev_user",
42               "display_picture": {
43                 "file": {}
44               },
45               "id": "id",
46               "state": "active",
47               "display_name": "display_name",
48               "email": "email",
49               "full_name": "full_name"
50             },
51             {
52               "type": "dev_user",
53               "display_picture": {
54                 "file": {}
55               },
56               "id": "id",
57               "state": "active",
58               "display_name": "display_name",
59               "email": "email",
60               "full_name": "full_name"
61             }
62           ],
63           "display_id": "display_id"
64         }
65       ],
66       "article_type": "article",
67       "created_by": {
68         "type": "dev_user",
69         "display_picture": {
70           "file": {
71             "type": "type",
72             "name": "name"
73           },
74           "id": "id",
75           "display_id": "display_id"
76         },
77         "id": "id",
78         "state": "active",
79         "display_id": "display_id",
80         "display_name": "display_name",
81         "email": "email",
82         "full_name": "full_name"
83       },
84       "id": "id",
85       "modified_by": {
86         "type": "dev_user",
87         "display_picture": {
88           "file": {
89             "type": "type",
90             "name": "name"
91           },
92           "id": "id",
93           "display_id": "display_id"
94         },
95         "id": "id",
96         "state": "active",
97         "display_id": "display_id",
98         "display_name": "display_name",
99         "email": "email",
100         "full_name": "full_name"
101       },
102       "owned_by": [
103         {
104           "type": "dev_user",
105           "display_picture": {
106             "file": {
107               "type": "type",
108               "name": "name"
109             },
110             "id": "id",
111             "display_id": "display_id"
112           },
113           "id": "id",
114           "state": "active",
115           "display_id": "display_id",
116           "display_name": "display_name",
117           "email": "email",
118           "full_name": "full_name"
119         },
120         {
121           "type": "dev_user",
122           "display_picture": {
123             "file": {
124               "type": "type",
125               "name": "name"
126             },
127             "id": "id",
128             "display_id": "display_id"
129           },
130           "id": "id",
131           "state": "active",
132           "display_id": "display_id",
133           "display_name": "display_name",
134           "email": "email",
135           "full_name": "full_name"
136         }
137       ],
138       "parent": {
139         "id": "id",
140         "display_id": "display_id"
141       },
142       "resource": {
143         "artifacts": [
144           {
145             "file": {
146               "type": "type",
147               "name": "name"
148             },
149             "id": "id",
150             "display_id": "display_id"
151           },
152           {
153             "file": {
154               "type": "type",
155               "name": "name"
156             },
157             "id": "id",
158             "display_id": "display_id"
159           }
160         ],
161         "url": "url"
162       },
163       "scope": {
164         "id": 1000000,
165         "label": "label",
166         "ordinal": 1000000
167       },
168       "authored_by": [
169         {
170           "type": "dev_user",
171           "display_picture": {
172             "file": {
173               "type": "type",
174               "name": "name"
175             },
176             "id": "id",
177             "display_id": "display_id"
178           },
179           "id": "id",
180           "state": "active",
181           "display_id": "display_id",
182           "display_name": "display_name",
183           "email": "email",
184           "full_name": "full_name"
185         },
186         {
187           "type": "dev_user",
188           "display_picture": {
189             "file": {
190               "type": "type",
191               "name": "name"
192             },
193             "id": "id",
194             "display_id": "display_id"
195           },
196           "id": "id",
197           "state": "active",
198           "display_id": "display_id",
199           "display_name": "display_name",
200           "email": "email",
201           "full_name": "full_name"
202         }
203       ],
204       "created_date": "created_date",
205       "description": "description",
206       "display_id": "display_id",
207       "extracted_content": [
208         {
209           "file": {
210             "type": "type",
211             "name": "name"
212           },
213           "id": "id",
214           "display_id": "display_id"
215         },
216         {
217           "file": {
218             "type": "type",
219             "name": "name"
220           },
221           "id": "id",
222           "display_id": "display_id"
223         }
224       ],
225       "modified_date": "modified_date",
226       "num_downvotes": 1,
227       "num_upvotes": 1,
228       "rank": "rank",
229       "title": "title"
230     },
231     {
232       "applies_to_parts": [
233         {
234           "type": "capability",
235           "id": "id",
236           "name": "name",
237           "owned_by": [
238             {
239               "type": "dev_user",
240               "display_picture": {
241                 "file": {}
242               },
243               "id": "id",
244               "state": "active",
245               "display_name": "display_name",
246               "email": "email",
247               "full_name": "full_name"
248             },
249             {
250               "type": "dev_user",
251               "display_picture": {
252                 "file": {}
253               },
254               "id": "id",
255               "state": "active",
256               "display_name": "display_name",
257               "email": "email",
258               "full_name": "full_name"
259             }
260           ],
261           "display_id": "display_id"
262         },
263         {
264           "type": "capability",
265           "id": "id",
266           "name": "name",
267           "owned_by": [
268             {
269               "type": "dev_user",
270               "display_picture": {
271                 "file": {}
272               },
273               "id": "id",
274               "state": "active",
275               "display_name": "display_name",
276               "email": "email",
277               "full_name": "full_name"
278             },
279             {
280               "type": "dev_user",
281               "display_picture": {
282                 "file": {}
283               },
284               "id": "id",
285               "state": "active",
286               "display_name": "display_name",
287               "email": "email",
288               "full_name": "full_name"
289             }
290           ],
291           "display_id": "display_id"
292         }
293       ],
294       "article_type": "article",
295       "created_by": {
296         "type": "dev_user",
297         "display_picture": {
298           "file": {
299             "type": "type",
300             "name": "name"
301           },
302           "id": "id",
303           "display_id": "display_id"
304         },
305         "id": "id",
306         "state": "active",
307         "display_id": "display_id",
308         "display_name": "display_name",
309         "email": "email",
310         "full_name": "full_name"
311       },
312       "id": "id",
313       "modified_by": {
314         "type": "dev_user",
315         "display_picture": {
316           "file": {
317             "type": "type",
318             "name": "name"
319           },
320           "id": "id",
321           "display_id": "display_id"
322         },
323         "id": "id",
324         "state": "active",
325         "display_id": "display_id",
326         "display_name": "display_name",
327         "email": "email",
328         "full_name": "full_name"
329       },
330       "owned_by": [
331         {
332           "type": "dev_user",
333           "display_picture": {
334             "file": {
335               "type": "type",
336               "name": "name"
337             },
338             "id": "id",
339             "display_id": "display_id"
340           },
341           "id": "id",
342           "state": "active",
343           "display_id": "display_id",
344           "display_name": "display_name",
345           "email": "email",
346           "full_name": "full_name"
347         },
348         {
349           "type": "dev_user",
350           "display_picture": {
351             "file": {
352               "type": "type",
353               "name": "name"
354             },
355             "id": "id",
356             "display_id": "display_id"
357           },
358           "id": "id",
359           "state": "active",
360           "display_id": "display_id",
361           "display_name": "display_name",
362           "email": "email",
363           "full_name": "full_name"
364         }
365       ],
366       "parent": {
367         "id": "id",
368         "display_id": "display_id"
369       },
370       "resource": {
371         "artifacts": [
372           {
373             "file": {
374               "type": "type",
375               "name": "name"
376             },
377             "id": "id",
378             "display_id": "display_id"
379           },
380           {
381             "file": {
382               "type": "type",
383               "name": "name"
384             },
385             "id": "id",
386             "display_id": "display_id"
387           }
388         ],
389         "url": "url"
390       },
391       "scope": {
392         "id": 1000000,
393         "label": "label",
394         "ordinal": 1000000
395       },
396       "authored_by": [
397         {
398           "type": "dev_user",
399           "display_picture": {
400             "file": {
401               "type": "type",
402               "name": "name"
403             },
404             "id": "id",
405             "display_id": "display_id"
406           },
407           "id": "id",
408           "state": "active",
409           "display_id": "display_id",
410           "display_name": "display_name",
411           "email": "email",
412           "full_name": "full_name"
413         },
414         {
415           "type": "dev_user",
416           "display_picture": {
417             "file": {
418               "type": "type",
419               "name": "name"
420             },
421             "id": "id",
422             "display_id": "display_id"
423           },
424           "id": "id",
425           "state": "active",
426           "display_id": "display_id",
427           "display_name": "display_name",
428           "email": "email",
429           "full_name": "full_name"
430         }
431       ],
432       "created_date": "created_date",
433       "description": "description",
434       "display_id": "display_id",
435       "extracted_content": [
436         {
437           "file": {
438             "type": "type",
439             "name": "name"
440           },
441           "id": "id",
442           "display_id": "display_id"
443         },
444         {
445           "file": {
446             "type": "type",
447             "name": "name"
448           },
449           "id": "id",
450           "display_id": "display_id"
451         }
452       ],
453       "modified_date": "modified_date",
454       "num_downvotes": 1,
455       "num_upvotes": 1,
456       "rank": "rank",
457       "title": "title"
458     }
459   ],
460   "total": 1,
461   "next_cursor": "next_cursor",
462   "prev_cursor": "prev_cursor"
463 }

List Articles (POST)

Up Next

Built with

1	curl -G https://api.devrev.ai/articles.list \
2	-H "Authorization: Bearer <token>" \
3	-d mode=after

1	{
2	"articles": [
3	{
4	"applies_to_parts": [
5	{
6	"type": "capability",
7	"id": "id",
8	"name": "name",
9	"owned_by": [
10	{
11	"type": "dev_user",
12	"display_picture": {
13	"file": {}
14	},
15	"id": "id",
16	"state": "active",
17	"display_name": "display_name",
18	"email": "email",
19	"full_name": "full_name"
20	},
21	{
22	"type": "dev_user",
23	"display_picture": {
24	"file": {}
25	},
26	"id": "id",
27	"state": "active",
28	"display_name": "display_name",
29	"email": "email",
30	"full_name": "full_name"
31	}
32	],
33	"display_id": "display_id"
34	},
35	{
36	"type": "capability",
37	"id": "id",
38	"name": "name",
39	"owned_by": [
40	{
41	"type": "dev_user",
42	"display_picture": {
43	"file": {}
44	},
45	"id": "id",
46	"state": "active",
47	"display_name": "display_name",
48	"email": "email",
49	"full_name": "full_name"
50	},
51	{
52	"type": "dev_user",
53	"display_picture": {
54	"file": {}
55	},
56	"id": "id",
57	"state": "active",
58	"display_name": "display_name",
59	"email": "email",
60	"full_name": "full_name"
61	}
62	],
63	"display_id": "display_id"
64	}
65	],
66	"article_type": "article",
67	"created_by": {
68	"type": "dev_user",
69	"display_picture": {
70	"file": {
71	"type": "type",
72	"name": "name"
73	},
74	"id": "id",
75	"display_id": "display_id"
76	},
77	"id": "id",
78	"state": "active",
79	"display_id": "display_id",
80	"display_name": "display_name",
81	"email": "email",
82	"full_name": "full_name"
83	},
84	"id": "id",
85	"modified_by": {
86	"type": "dev_user",
87	"display_picture": {
88	"file": {
89	"type": "type",
90	"name": "name"
91	},
92	"id": "id",
93	"display_id": "display_id"
94	},
95	"id": "id",
96	"state": "active",
97	"display_id": "display_id",
98	"display_name": "display_name",
99	"email": "email",
100	"full_name": "full_name"
101	},
102	"owned_by": [
103	{
104	"type": "dev_user",
105	"display_picture": {
106	"file": {
107	"type": "type",
108	"name": "name"
109	},
110	"id": "id",
111	"display_id": "display_id"
112	},
113	"id": "id",
114	"state": "active",
115	"display_id": "display_id",
116	"display_name": "display_name",
117	"email": "email",
118	"full_name": "full_name"
119	},
120	{
121	"type": "dev_user",
122	"display_picture": {
123	"file": {
124	"type": "type",
125	"name": "name"
126	},
127	"id": "id",
128	"display_id": "display_id"
129	},
130	"id": "id",
131	"state": "active",
132	"display_id": "display_id",
133	"display_name": "display_name",
134	"email": "email",
135	"full_name": "full_name"
136	}
137	],
138	"parent": {
139	"id": "id",
140	"display_id": "display_id"
141	},
142	"resource": {
143	"artifacts": [
144	{
145	"file": {
146	"type": "type",
147	"name": "name"
148	},
149	"id": "id",
150	"display_id": "display_id"
151	},
152	{
153	"file": {
154	"type": "type",
155	"name": "name"
156	},
157	"id": "id",
158	"display_id": "display_id"
159	}
160	],
161	"url": "url"
162	},
163	"scope": {
164	"id": 1000000,
165	"label": "label",
166	"ordinal": 1000000
167	},
168	"authored_by": [
169	{
170	"type": "dev_user",
171	"display_picture": {
172	"file": {
173	"type": "type",
174	"name": "name"
175	},
176	"id": "id",
177	"display_id": "display_id"
178	},
179	"id": "id",
180	"state": "active",
181	"display_id": "display_id",
182	"display_name": "display_name",
183	"email": "email",
184	"full_name": "full_name"
185	},
186	{
187	"type": "dev_user",
188	"display_picture": {
189	"file": {
190	"type": "type",
191	"name": "name"
192	},
193	"id": "id",
194	"display_id": "display_id"
195	},
196	"id": "id",
197	"state": "active",
198	"display_id": "display_id",
199	"display_name": "display_name",
200	"email": "email",
201	"full_name": "full_name"
202	}
203	],
204	"created_date": "created_date",
205	"description": "description",
206	"display_id": "display_id",
207	"extracted_content": [
208	{
209	"file": {
210	"type": "type",
211	"name": "name"
212	},
213	"id": "id",
214	"display_id": "display_id"
215	},
216	{
217	"file": {
218	"type": "type",
219	"name": "name"
220	},
221	"id": "id",
222	"display_id": "display_id"
223	}
224	],
225	"modified_date": "modified_date",
226	"num_downvotes": 1,
227	"num_upvotes": 1,
228	"rank": "rank",
229	"title": "title"
230	},
231	{
232	"applies_to_parts": [
233	{
234	"type": "capability",
235	"id": "id",
236	"name": "name",
237	"owned_by": [
238	{
239	"type": "dev_user",
240	"display_picture": {
241	"file": {}
242	},
243	"id": "id",
244	"state": "active",
245	"display_name": "display_name",
246	"email": "email",
247	"full_name": "full_name"
248	},
249	{
250	"type": "dev_user",
251	"display_picture": {
252	"file": {}
253	},
254	"id": "id",
255	"state": "active",
256	"display_name": "display_name",
257	"email": "email",
258	"full_name": "full_name"
259	}
260	],
261	"display_id": "display_id"
262	},
263	{
264	"type": "capability",
265	"id": "id",
266	"name": "name",
267	"owned_by": [
268	{
269	"type": "dev_user",
270	"display_picture": {
271	"file": {}
272	},
273	"id": "id",
274	"state": "active",
275	"display_name": "display_name",
276	"email": "email",
277	"full_name": "full_name"
278	},
279	{
280	"type": "dev_user",
281	"display_picture": {
282	"file": {}
283	},
284	"id": "id",
285	"state": "active",
286	"display_name": "display_name",
287	"email": "email",
288	"full_name": "full_name"
289	}
290	],
291	"display_id": "display_id"
292	}
293	],
294	"article_type": "article",
295	"created_by": {
296	"type": "dev_user",
297	"display_picture": {
298	"file": {
299	"type": "type",
300	"name": "name"
301	},
302	"id": "id",
303	"display_id": "display_id"
304	},
305	"id": "id",
306	"state": "active",
307	"display_id": "display_id",
308	"display_name": "display_name",
309	"email": "email",
310	"full_name": "full_name"
311	},
312	"id": "id",
313	"modified_by": {
314	"type": "dev_user",
315	"display_picture": {
316	"file": {
317	"type": "type",
318	"name": "name"
319	},
320	"id": "id",
321	"display_id": "display_id"
322	},
323	"id": "id",
324	"state": "active",
325	"display_id": "display_id",
326	"display_name": "display_name",
327	"email": "email",
328	"full_name": "full_name"
329	},
330	"owned_by": [
331	{
332	"type": "dev_user",
333	"display_picture": {
334	"file": {
335	"type": "type",
336	"name": "name"
337	},
338	"id": "id",
339	"display_id": "display_id"
340	},
341	"id": "id",
342	"state": "active",
343	"display_id": "display_id",
344	"display_name": "display_name",
345	"email": "email",
346	"full_name": "full_name"
347	},
348	{
349	"type": "dev_user",
350	"display_picture": {
351	"file": {
352	"type": "type",
353	"name": "name"
354	},
355	"id": "id",
356	"display_id": "display_id"
357	},
358	"id": "id",
359	"state": "active",
360	"display_id": "display_id",
361	"display_name": "display_name",
362	"email": "email",
363	"full_name": "full_name"
364	}
365	],
366	"parent": {
367	"id": "id",
368	"display_id": "display_id"
369	},
370	"resource": {
371	"artifacts": [
372	{
373	"file": {
374	"type": "type",
375	"name": "name"
376	},
377	"id": "id",
378	"display_id": "display_id"
379	},
380	{
381	"file": {
382	"type": "type",
383	"name": "name"
384	},
385	"id": "id",
386	"display_id": "display_id"
387	}
388	],
389	"url": "url"
390	},
391	"scope": {
392	"id": 1000000,
393	"label": "label",
394	"ordinal": 1000000
395	},
396	"authored_by": [
397	{
398	"type": "dev_user",
399	"display_picture": {
400	"file": {
401	"type": "type",
402	"name": "name"
403	},
404	"id": "id",
405	"display_id": "display_id"
406	},
407	"id": "id",
408	"state": "active",
409	"display_id": "display_id",
410	"display_name": "display_name",
411	"email": "email",
412	"full_name": "full_name"
413	},
414	{
415	"type": "dev_user",
416	"display_picture": {
417	"file": {
418	"type": "type",
419	"name": "name"
420	},
421	"id": "id",
422	"display_id": "display_id"
423	},
424	"id": "id",
425	"state": "active",
426	"display_id": "display_id",
427	"display_name": "display_name",
428	"email": "email",
429	"full_name": "full_name"
430	}
431	],
432	"created_date": "created_date",
433	"description": "description",
434	"display_id": "display_id",
435	"extracted_content": [
436	{
437	"file": {
438	"type": "type",
439	"name": "name"
440	},
441	"id": "id",
442	"display_id": "display_id"
443	},
444	{
445	"file": {
446	"type": "type",
447	"name": "name"
448	},
449	"id": "id",
450	"display_id": "display_id"
451	}
452	],
453	"modified_date": "modified_date",
454	"num_downvotes": 1,
455	"num_upvotes": 1,
456	"rank": "rank",
457	"title": "title"
458	}
459	],
460	"total": 1,
461	"next_cursor": "next_cursor",
462	"prev_cursor": "prev_cursor"
463	}