API Referencearticles

Count Articles

Beta
Get count of articles matching given filter.

Headers

AuthorizationstringRequired

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

Query parameters

ancestorstringOptionalformat: "id"
The ancestor directory of the articles.
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_bylist 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.
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

Success.
countinteger
The total number of articles matching the filter.

Errors