List Articles
Lists a collection of articles.
All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request.
How do I find my token?
In: header
Query Parameters
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.
Filters for articles authored by any of the provided users.
Filters for articles belonging to any of the provided brands.
Filters for articles created by any of the provided users.
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
textThe maximum number of articles to return. The default is '50'.
int32The iteration mode to use, otherwise if not set, then "after" is used.
"after" | "before"Filters for articles modified by any of the provided users.
Filters for articles owned by any of the provided users.
Filters for articles with the provided parent directories.
Filter for the scope of the articles.
ID of the group/member with whom the item is shared.
idRole ID of the group/member with whom the item is shared.
idFilters for article with any of the provided tags.
Response Body
curl -X GET "https://api.devrev.ai/articles.list?applies_to_parts=PROD-12345&article_type=article&authored_by=DEVU-12345&brands=string&created_by=DEVU-12345&cursor=string&limit=0&mode=after&modified_by=DEVU-12345&owned_by=DEVU-12345&parent=string&scope=0&shared_with.member=string&shared_with.role=string&tags=TAG-12345"{
"articles": [
{
"created_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"created_date": "2023-01-01T12:00:00.000Z",
"display_id": "string",
"id": "string",
"modified_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"modified_date": "2023-01-01T12:00:00.000Z",
"applies_to_parts": [
{
"type": "capability",
"display_id": "string",
"id": "string",
"name": "string",
"owned_by": [
{
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
}
],
"sync_metadata": {
"external_reference": "string",
"origin_system": "string"
}
}
],
"article_type": "article",
"authored_by": [
{
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
}
],
"description": "string",
"extracted_content": [
{
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
}
],
"num_downvotes": 0,
"num_upvotes": 0,
"owned_by": [
{
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
}
],
"parent": {
"display_id": "string",
"id": "string",
"sync_metadata": {
"external_reference": "string",
"origin_system": "string"
}
},
"rank": "string",
"resource": {
"artifacts": [
{
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
}
],
"url": "string"
},
"scope": {
"id": 0,
"label": "string",
"ordinal": 0,
"value": null
},
"sync_metadata": {
"external_reference": "string",
"last_sync_in": {
"status": "failed",
"sync_date": "2023-01-01T12:00:00.000Z",
"sync_unit": {
"display_id": "string",
"id": "string",
"external_system_type": "adaas",
"is_archived": true,
"name": "string",
"sync_run": {
"mode": "initial",
"progress": {
"state": "completed"
}
},
"sync_type": "manual"
}
},
"last_sync_out": {
"status": "failed",
"sync_date": "2023-01-01T12:00:00.000Z",
"sync_unit": {
"display_id": "string",
"id": "string",
"external_system_type": "adaas",
"is_archived": true,
"name": "string",
"sync_run": {
"mode": "initial",
"progress": {
"state": "completed"
}
},
"sync_type": "manual"
}
},
"origin_system": "string"
},
"title": "string"
}
],
"next_cursor": "string",
"prev_cursor": "string",
"total": 0
}{
"detail": "string",
"message": "string",
"type": "artifact_already_attached_to_a_parent",
"existing_parent": "string",
"is_same": true
}{
"detail": "string",
"message": "string",
"type": "unauthenticated"
}{
"detail": "string",
"message": "string",
"type": "forbidden"
}{
"detail": "string",
"message": "string",
"type": "too_many_requests",
"retry_after": 0
}{
"detail": "string",
"message": "string",
"type": "internal_error",
"reference_id": "string"
}{
"detail": "string",
"message": "string",
"type": "service_unavailable"
}