Skip to main content
GET
List Articles

List Articles

Returns a paginated list of published articles for the current location. Supports filtering by category, keyword search, and featured flag.

Authentication

No authentication required.

Query Parameters

number
required
1-based page number.
number
required
Number of posts per page.
number
Filter to posts belonging to a specific category. Omit to return posts across all categories.
Keyword filter applied to post title and body. URL-encoded.
When true, returns only articles marked as featured by the operator.
string
Comma-separated list of field paths to include in the response. When provided, only the specified fields are returned — useful for reducing payload size. Supports nested paths using dot notation. Example: _shape=BlogPosts.Records.Title,BlogPosts.Records.SummaryText,BlogPosts.Records.PublishDate.

Response

Returns a BlogPostList object containing paginated articles, available categories, and the currently selected category.
ApiListResult<BlogPost>
Paginated wrapper containing article records.
BlogPost[]
Array of article summaries for the current page.
number
Current page number.
number
Total number of matching posts.
number
Total number of pages.
boolean
Whether there are more pages after the current one.
BlogCategory[]
Array of all available article categories.
BlogCategory
The currently selected category (when filtering by categoryId).

Examples

Fetch first page of posts

TypeScript Integration