List Articles

GET

Lists a collection of articles.

Query parameters

applies_to_partsstringOptional

Filters for articles belonging to any of the provided parts.

article_type"article" or "content_block"Optional

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_bystringOptional

Filters for articles authored by any of the provided users.

created_bystringOptional

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’.

mode"after" or "before"Optional

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

Allowed values: afterbefore

modified_bystringOptional

Filters for articles modified by any of the provided users.

owned_bystringOptional

Filters for articles owned by any of the provided users.

scopelongOptional

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.

Response

This endpoint returns an object.

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 https://api.devrev.ai/articles.list \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "articles": [
3     {
4       "applies_to_parts": [
5         {
6           "type": "product",
7           "id": "applies_to_parts",
8           "name": "applies_to_parts",
9           "owned_by": [
10             {
11               "type": "sys_user",
12               "id": "applies_to_parts"
13             }
14           ]
15         }
16       ],
17       "id": "id",
18       "owned_by": [
19         {
20           "type": "sys_user",
21           "id": "owned_by"
22         }
23       ],
24       "article_type": "article",
25       "authored_by": [
26         {
27           "type": "sys_user",
28           "id": "authored_by"
29         }
30       ],
31       "created_by": {
32         "type": "sys_user",
33         "id": "created_by"
34       },
35       "created_date": "2023-01-01T12:00:00Z",
36       "description": "description",
37       "display_id": "display_id",
38       "extracted_content": [
39         {
40           "id": "id"
41         }
42       ],
43       "modified_by": {
44         "type": "sys_user",
45         "id": "modified_by"
46       },
47       "modified_date": "2023-01-01T12:00:00Z",
48       "num_downvotes": 1,
49       "num_upvotes": 1,
50       "parent": {
51         "id": "id"
52       },
53       "rank": "rank",
54       "scope": {
55         "id": 1000000,
56         "label": "label",
57         "ordinal": 1000000
58       },
59       "title": "title"
60     }
61   ],
62   "total": 1,
63   "next_cursor": "next_cursor",
64   "prev_cursor": "prev_cursor"
65 }

Built with

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

1	{
2	"articles": [
3	{
4	"applies_to_parts": [
5	{
6	"type": "product",
7	"id": "applies_to_parts",
8	"name": "applies_to_parts",
9	"owned_by": [
10	{
11	"type": "sys_user",
12	"id": "applies_to_parts"
13	}
14	]
15	}
16	],
17	"id": "id",
18	"owned_by": [
19	{
20	"type": "sys_user",
21	"id": "owned_by"
22	}
23	],
24	"article_type": "article",
25	"authored_by": [
26	{
27	"type": "sys_user",
28	"id": "authored_by"
29	}
30	],
31	"created_by": {
32	"type": "sys_user",
33	"id": "created_by"
34	},
35	"created_date": "2023-01-01T12:00:00Z",
36	"description": "description",
37	"display_id": "display_id",
38	"extracted_content": [
39	{
40	"id": "id"
41	}
42	],
43	"modified_by": {
44	"type": "sys_user",
45	"id": "modified_by"
46	},
47	"modified_date": "2023-01-01T12:00:00Z",
48	"num_downvotes": 1,
49	"num_upvotes": 1,
50	"parent": {
51	"id": "id"
52	},
53	"rank": "rank",
54	"scope": {
55	"id": 1000000,
56	"label": "label",
57	"ordinal": 1000000
58	},
59	"title": "title"
60	}
61	],
62	"total": 1,
63	"next_cursor": "next_cursor",
64	"prev_cursor": "prev_cursor"
65	}