Getting Articles
GET /article[?category_id&tag&include_body&updated_at_before=2023-01-02]
If no arguments are passed it'll return all articles on your account of all article statuses.
Arguments | Description |
category_id string (can include , for multiple) | Restrict returned articles to this category |
article_id string (can include , for multiple, ignores other filters) | Restrict returned response to a specific article |
tag string (can include , for multiple) | Restrict returned articles to this tag |
combine_tags "AND|OR" | Return only if all tags match with AND Return if any tags match with OR |
include_body bool | Include the HTML |
permission_group string (can include , for multiple) | Restrict returned articles to a certain permission group ID |
combine_permission_groups "AND|OR" | Return only if all permission groups match with AND Return if any permission groups match with OR |
status "published|draft|private" (can include , for multiple) | Restrict returned articles to a selected article status |
user_id string (can include , for multiple) | Restrict returned articles to a certain user ID |
is_stale bool | Restrict returned articles based on whether they are set as Stale or not |
needs_translation bool | Restrict returned articles base on whether it's marked as Needs Translation |
language string | Restrict returned articles to a language |
updated_at_before string (e.g. 2023-01-02) | Restrict returned articles based on whether they were published before a certain date |
updated_at_after string (e.g. 2023-01-02) | Restrict returned articles based on whether they were published after a certain date |
combine_filters "AND|OR" | Return only if all filters match with AND Return if any of the filters match with OR |
lite bool | Returns a lighter API response. Doesn't return the article body. |
working_copy bool | Returns the latest rather than currently published versions |
limit int | Sets the maximum number of articles to return |
skip int | Sets the number of articles to skip before returning a response |
include_body argument the response from this API will be ~ 10x largerExample response:
{
"articles": [ Article ]
}
