List Articles REST Endpoint

Ben Tiedt — Fri, 08 Mar 2024 17:44:11 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:44:11

GET api.ashx/v2/articles/articles.{json|xml}

Request Parameters

Name	Type	Location	Description	Required	Default	Options
ArticleCollectionId	string	Query String	Used to filter articles by a specific article collection.	Optional
ArticleCollectionIds	string	Query String	Comma separated list of article collection id's to filter articles by.	Optional
ArticleIds	string	Query String	Comma separated list of article ids to filter by.	Optional
CategoryIds	string	Query String	Comma separated list of category id's. Used to filter articles by specific categories.	Optional
HasScheduledUpdate	bool	Query String	Whether the article has active unpublished versions that are ready to publish.	Optional
InCategory	bool	Query String	Allows filtering only article versions within or not within a category. Ignored if CategoryIds is passed in.	Optional	True
IncludeArticleTypeIds	string	Query String	Comma separated list of article type ids to filter the articles by.	Optional
IsDefault	bool	Query String	Allows filtering articles that are the default of a category or a collection.	Optional
IsDeleted	bool	Query String	Filters articles that have been deleted.	Optional	False
IsPublished	bool	Query String	Filter to return articles by their IsPublished value.	Optional	True
PageIndex	int	Query String	The page index to return based on page size. This value is 'zero' based and defaults to zero.	Optional	0
PageSize	int	Query String	The total amount of articles to return per paged request. The default is 20, the maximum is 100.	Optional	20
PostTarget	string	Query String	Render target.	Optional	WebServices	Unknown,Web,Syndication,Other,Print,Nntp,Email,WebQuote,WebServices
PublishAfterDate	DateTime	Query String	Include only articles with a publish date after the provided date.	Optional
PublishBeforeDate	DateTime	Query String	Include only articles with a publish date before the provided date.	Optional
PublishGroupId	int	Query String	Id of the publish group in which the article has active versions.	Optional
SortBy	string	Query String	The sort option for the articles. 'articleids' is only valid when ArticleIds are specified.	Optional	publishdate	sortorder,publishdate,lastupdatedate,deletedate,title,articleids
SortOrder	string	Query String	The direction to sort the articles by based on the current SortBy options. The options are 'ascending' or 'descending'.	Optional	ascending
Tags	string	Query String	Comma separated list of tags to filter articles by.	Optional
WasPublished	bool	Query String	Articles that have been published but are no longer published and do not have a draft.	Optional

Example Requests

Widget Javascript

jQuery.telligent.evolution.get({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/articles/articles.json'
}).then(function(response) {
	// use response
});