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_blockpage

authored_bylist of stringsOptional

Filters for articles authored by any of the provided users.

brandslist of stringsOptional

Filters for articles belonging to any of the provided brands.

created_bylist of stringsOptional

Filters for articles created by any of the provided users.

cursorstringOptionalformat: "text"

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

dev_orgstringOptionalformat: "id"

Optional Dev Org ID for the unauthenticated user.

limitintegerOptional

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

modeenumOptional

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.memberstringOptionalformat: "id"

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

shared_with.rolestringOptionalformat: "id"

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_cursorstringOptionalformat: "text"

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

prev_cursorstringOptionalformat: "text"

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

Errors

GET

1 curl https://api.devrev.ai/articles.list \
2      -H "Authorization: Bearer <token>"

200listArticlesExample

1 {
2   "articles": [
3     {
4       "id": "foo",
5       "owned_by": [
6         {
7           "display_id": "foo",
8           "id": "foo",
9           "display_name": "foo",
10           "display_picture": {
11             "display_id": "foo",
12             "id": "foo",
13             "file": {
14               "type": "foo",
15               "name": "foo",
16               "size": 42
17             }
18           },
19           "email": "foo",
20           "full_name": "foo",
21           "state": "active"
22         }
23       ],
24       "applies_to_parts": [
25         {
26           "display_id": "foo",
27           "id": "foo",
28           "name": "foo",
29           "owned_by": [
30             {}
31           ],
32           "sync_metadata": {
33             "external_reference": "foo",
34             "origin_system": "foo"
35           }
36         }
37       ],
38       "article_type": "article",
39       "authored_by": [
40         {
41           "display_id": "foo",
42           "id": "foo",
43           "display_name": "foo",
44           "display_picture": {
45             "display_id": "foo",
46             "id": "foo",
47             "file": {
48               "type": "foo",
49               "name": "foo",
50               "size": 42
51             }
52           },
53           "email": "foo",
54           "full_name": "foo",
55           "state": "active"
56         }
57       ],
58       "created_by": {
59         "display_id": "foo",
60         "id": "foo",
61         "display_name": "foo",
62         "display_picture": {
63           "display_id": "foo",
64           "id": "foo",
65           "file": {
66             "type": "foo",
67             "name": "foo",
68             "size": 42
69           }
70         },
71         "email": "foo",
72         "full_name": "foo",
73         "state": "active"
74       },
75       "created_date": "2023-01-01T12:00:00.000Z",
76       "description": "foo",
77       "display_id": "foo",
78       "extracted_content": [
79         {
80           "id": "foo",
81           "display_id": "foo",
82           "file": {
83             "type": "foo",
84             "name": "foo",
85             "size": 42
86           }
87         }
88       ],
89       "modified_by": {
90         "display_id": "foo",
91         "id": "foo",
92         "display_name": "foo",
93         "display_picture": {
94           "display_id": "foo",
95           "id": "foo",
96           "file": {
97             "type": "foo",
98             "name": "foo",
99             "size": 42
100           }
101         },
102         "email": "foo",
103         "full_name": "foo",
104         "state": "active"
105       },
106       "modified_date": "2023-01-01T12:00:00.000Z",
107       "num_downvotes": 42,
108       "num_upvotes": 42,
109       "parent": {
110         "id": "foo",
111         "display_id": "foo",
112         "sync_metadata": {
113           "external_reference": "foo",
114           "origin_system": "foo"
115         }
116       },
117       "rank": "foo",
118       "resource": {
119         "artifacts": [
120           {
121             "id": "foo",
122             "display_id": "foo",
123             "file": {
124               "type": "foo",
125               "name": "foo",
126               "size": 42
127             }
128           }
129         ],
130         "url": "foo"
131       },
132       "scope": {
133         "id": 42,
134         "label": "foo",
135         "ordinal": 42,
136         "value": null
137       },
138       "sync_metadata": {
139         "external_reference": "foo",
140         "last_sync_in": {
141           "status": "failed",
142           "sync_date": "2023-01-01T12:00:00.000Z",
143           "sync_unit": {
144             "id": "foo",
145             "display_id": "foo",
146             "external_system_type": "adaas",
147             "is_archived": true,
148             "name": "foo",
149             "sync_run": {
150               "mode": "initial",
151               "progress": {
152                 "state": "completed"
153               }
154             },
155             "sync_type": "manual"
156           }
157         },
158         "last_sync_out": {
159           "status": "failed",
160           "sync_date": "2023-01-01T12:00:00.000Z",
161           "sync_unit": {
162             "id": "foo",
163             "display_id": "foo",
164             "external_system_type": "adaas",
165             "is_archived": true,
166             "name": "foo",
167             "sync_run": {
168               "mode": "initial",
169               "progress": {
170                 "state": "completed"
171               }
172             },
173             "sync_type": "manual"
174           }
175         },
176         "origin_system": "foo"
177       },
178       "title": "foo"
179     }
180   ],
181   "total": 42,
182   "next_cursor": "foo",
183   "prev_cursor": "foo"
184 }

List Articles (POST)

Up Next

Built with

1	curl https://api.devrev.ai/articles.list \
2	-H "Authorization: Bearer <token>"

1	{
2	"articles": [
3	{
4	"id": "foo",
5	"owned_by": [
6	{
7	"display_id": "foo",
8	"id": "foo",
9	"display_name": "foo",
10	"display_picture": {
11	"display_id": "foo",
12	"id": "foo",
13	"file": {
14	"type": "foo",
15	"name": "foo",
16	"size": 42
17	}
18	},
19	"email": "foo",
20	"full_name": "foo",
21	"state": "active"
22	}
23	],
24	"applies_to_parts": [
25	{
26	"display_id": "foo",
27	"id": "foo",
28	"name": "foo",
29	"owned_by": [
30	{}
31	],
32	"sync_metadata": {
33	"external_reference": "foo",
34	"origin_system": "foo"
35	}
36	}
37	],
38	"article_type": "article",
39	"authored_by": [
40	{
41	"display_id": "foo",
42	"id": "foo",
43	"display_name": "foo",
44	"display_picture": {
45	"display_id": "foo",
46	"id": "foo",
47	"file": {
48	"type": "foo",
49	"name": "foo",
50	"size": 42
51	}
52	},
53	"email": "foo",
54	"full_name": "foo",
55	"state": "active"
56	}
57	],
58	"created_by": {
59	"display_id": "foo",
60	"id": "foo",
61	"display_name": "foo",
62	"display_picture": {
63	"display_id": "foo",
64	"id": "foo",
65	"file": {
66	"type": "foo",
67	"name": "foo",
68	"size": 42
69	}
70	},
71	"email": "foo",
72	"full_name": "foo",
73	"state": "active"
74	},
75	"created_date": "2023-01-01T12:00:00.000Z",
76	"description": "foo",
77	"display_id": "foo",
78	"extracted_content": [
79	{
80	"id": "foo",
81	"display_id": "foo",
82	"file": {
83	"type": "foo",
84	"name": "foo",
85	"size": 42
86	}
87	}
88	],
89	"modified_by": {
90	"display_id": "foo",
91	"id": "foo",
92	"display_name": "foo",
93	"display_picture": {
94	"display_id": "foo",
95	"id": "foo",
96	"file": {
97	"type": "foo",
98	"name": "foo",
99	"size": 42
100	}
101	},
102	"email": "foo",
103	"full_name": "foo",
104	"state": "active"
105	},
106	"modified_date": "2023-01-01T12:00:00.000Z",
107	"num_downvotes": 42,
108	"num_upvotes": 42,
109	"parent": {
110	"id": "foo",
111	"display_id": "foo",
112	"sync_metadata": {
113	"external_reference": "foo",
114	"origin_system": "foo"
115	}
116	},
117	"rank": "foo",
118	"resource": {
119	"artifacts": [
120	{
121	"id": "foo",
122	"display_id": "foo",
123	"file": {
124	"type": "foo",
125	"name": "foo",
126	"size": 42
127	}
128	}
129	],
130	"url": "foo"
131	},
132	"scope": {
133	"id": 42,
134	"label": "foo",
135	"ordinal": 42,
136	"value": null
137	},
138	"sync_metadata": {
139	"external_reference": "foo",
140	"last_sync_in": {
141	"status": "failed",
142	"sync_date": "2023-01-01T12:00:00.000Z",
143	"sync_unit": {
144	"id": "foo",
145	"display_id": "foo",
146	"external_system_type": "adaas",
147	"is_archived": true,
148	"name": "foo",
149	"sync_run": {
150	"mode": "initial",
151	"progress": {
152	"state": "completed"
153	}
154	},
155	"sync_type": "manual"
156	}
157	},
158	"last_sync_out": {
159	"status": "failed",
160	"sync_date": "2023-01-01T12:00:00.000Z",
161	"sync_unit": {
162	"id": "foo",
163	"display_id": "foo",
164	"external_system_type": "adaas",
165	"is_archived": true,
166	"name": "foo",
167	"sync_run": {
168	"mode": "initial",
169	"progress": {
170	"state": "completed"
171	}
172	},
173	"sync_type": "manual"
174	}
175	},
176	"origin_system": "foo"
177	},
178	"title": "foo"
179	}
180	],
181	"total": 42,
182	"next_cursor": "foo",
183	"prev_cursor": "foo"
184	}