• About
    • For Developers
    • Authentication
    • Pagination
    • Versioning
    • Rate Limits
    • Errors
  • API Reference
    • Getting started
    • Changelog
  • Guides
    • Webhooks
    • Restricted messages on a timeline
    • Object customization
    • Custom objects
  • SDKs
    • Push notifications for mobile
  • Snap-in development
    • Concepts
    • Development best practices
    • Locally testing snap-ins
    • Handling errors and retrying
    • Debugging
    • Quotas and limits
    • Upgrade snap-ins
    • Code Samples
    • Marketplace listings
  • AirSync
    • Getting started
    • Examples of snap-ins
    • Deploy to organization
    • Publish to the marketplace
    • MCP integration
    • Common issues
    • Supported DevRev object types
LogoLogo
API Referencearticles

List Articles

GET
https://api.devrev.ai/articles.list
GET
/articles.list
1curl https://api.devrev.ai/articles.list \
2     -H "Authorization: Bearer <token>"
Try it
200Retrieved
1{
2  "articles": [
3    {
4      "id": "string",
5      "owned_by": [
6        {
7          "display_id": "string",
8          "id": "string",
9          "display_name": "string",
10          "display_picture": {
11            "display_id": "string",
12            "id": "string",
13            "file": {
14              "type": "string",
15              "name": "string",
16              "size": 1
17            }
18          },
19          "email": "string",
20          "full_name": "string",
21          "state": "active"
22        }
23      ],
24      "applies_to_parts": [
25        {
26          "display_id": "string",
27          "id": "string",
28          "name": "string",
29          "owned_by": [
30            {
31              "display_id": "string",
32              "id": "string",
33              "display_name": "string",
34              "display_picture": {
35                "display_id": {},
36                "id": {},
37                "file": {}
38              },
39              "email": "string",
40              "full_name": "string",
41              "state": "active"
42            }
43          ]
44        }
45      ],
46      "article_type": "article",
47      "authored_by": [
48        {
49          "display_id": "string",
50          "id": "string",
51          "display_name": "string",
52          "display_picture": {
53            "display_id": "string",
54            "id": "string",
55            "file": {
56              "type": "string",
57              "name": "string",
58              "size": 1
59            }
60          },
61          "email": "string",
62          "full_name": "string",
63          "state": "active"
64        }
65      ],
66      "created_by": {
67        "display_id": "string",
68        "id": "string",
69        "display_name": "string",
70        "display_picture": {
71          "display_id": "string",
72          "id": "string",
73          "file": {
74            "type": "string",
75            "name": "string",
76            "size": 1
77          }
78        },
79        "email": "string",
80        "full_name": "string",
81        "state": "active"
82      },
83      "created_date": "2023-01-01T12:00:00.000Z",
84      "description": "string",
85      "display_id": "string",
86      "extracted_content": [
87        {
88          "id": "string",
89          "display_id": "string",
90          "file": {
91            "type": "string",
92            "name": "string",
93            "size": 1
94          }
95        }
96      ],
97      "modified_by": {
98        "display_id": "string",
99        "id": "string",
100        "display_name": "string",
101        "display_picture": {
102          "display_id": "string",
103          "id": "string",
104          "file": {
105            "type": "string",
106            "name": "string",
107            "size": 1
108          }
109        },
110        "email": "string",
111        "full_name": "string",
112        "state": "active"
113      },
114      "modified_date": "2023-01-01T12:00:00.000Z",
115      "num_downvotes": 1,
116      "num_upvotes": 1,
117      "parent": {
118        "id": "string",
119        "display_id": "string"
120      },
121      "rank": "string",
122      "resource": {
123        "artifacts": [
124          {
125            "id": "string",
126            "display_id": "string",
127            "file": {
128              "type": "string",
129              "name": "string",
130              "size": 1
131            }
132          }
133        ],
134        "url": "string"
135      },
136      "scope": {
137        "id": 1,
138        "label": "string",
139        "ordinal": 1,
140        "value": null
141      },
142      "title": "string"
143    }
144  ],
145  "total": 1,
146  "next_cursor": "string",
147  "prev_cursor": "string"
148}
Lists a collection of articles.
Was this page helpful?
Previous

List Articles (POST)

Next
Built with
Lists a collection of articles.

List Articles (POST)

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

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:
authored_by
Filters for articles belonging to any of the provided parts.
Filter for the type of articles. If this is not provided, then articles that are not content blocks are returned.

Bearer authentication of the form Bearer <token>, where token is your auth token.

list 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.
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:
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.
parentlist of stringsOptional
Filters for articles with the provided parent directories.
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_cursorstring or nullformat: "text"
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursorstring or nullformat: "text"
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors

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

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