articles

List Articles

GET
Lists a collection of articles.

Query parameters

applies_to_partsstringOptional
Filters for articles belonging to any of the provided parts.
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'.
modeenumOptional
The iteration mode to use, otherwise if not set, then "after" is used.
Allowed values: afterbefore
owned_bystringOptional
Filters for articles owned by any of the provided users.

Response

This endpoint returns an object
articles
list of objects
The article entries matching the request.
total
integer
Total number of article items for the request.
next_cursor
stringOptional
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursor
stringOptional
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.
GET
1curl https://api.devrev.ai/articles.list \
2     -H "Authorization: <apiKey>"
200
Retrieved
1{
2  "articles": [
3    {
4      "applies_to_parts": [],
5      "id": "id",
6      "created_date": "2023-01-01T12:00:00Z",
7      "description": "description",
8      "display_id": "display_id",
9      "extracted_content": [
10        {
11          "id": "id"
12        }
13      ],
14      "modified_date": "2023-01-01T12:00:00Z",
15      "num_downvotes": 1,
16      "num_upvotes": 1,
17      "parent": {
18        "id": "id"
19      },
20      "rank": "rank",
21      "title": "title"
22    }
23  ],
24  "total": 1,
25  "next_cursor": "next_cursor",
26  "prev_cursor": "prev_cursor"
27}
Built with