articles

List Articles Post

POST
Lists a collection of articles.

Request

This endpoint expects an object.
applies_to_parts
list of stringsOptional
Filters for articles belonging to any of the provided parts.
authored_by
list of stringsOptional
Filters for articles authored by any of the provided users.
created_by
list of stringsOptional
Filters for articles created by any of the provided users.
cursor
stringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
limit
integerOptional
The maximum number of articles to return. The default is '50'.
mode
enumOptional
The iteration mode to use. If "after", then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If "before", then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.
Allowed values: afterbefore
owned_by
list of stringsOptional
Filters for articles owned by any of the provided users.
shared_with
list of maps from strings to anyOptional
Filter for articles based on intended audience.

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.
POST
1curl -X POST https://api.devrev.ai/articles.list \
2     -H "Authorization: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{}'
200
Successful
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