REST API
Retrieve a list of articles from your Simplist project with pagination, filtering, and sorting options.
GET
{{baseUrl}}/v1/articlesAuth required
| Property | Type | Description | Default |
|---|---|---|---|
page | number | Page number for pagination | 1 |
limit | number | Number of items per page | 10 |
sort | string | Field to sort by | createdAt |
order | string | Sort direction (asc or desc) | desc |
published | boolean | Filter by published status | - |
search | string | Search in title and content | - |
status | string | Filter by article status | - |
tags | string[] | Filter articles with at least one of these tags (OR logic) | - |
tagsAll | string[] | Filter articles with all of these tags (AND logic) | - |
excludeTags | string[] | Exclude articles with any of these tags | - |
Returns an array of ArticleListItem objects (articles without full content).
| Property | Type | Description | Default |
|---|---|---|---|
id* | string | Unique article identifier | - |
title* | string | Article title | - |
slug* | string | URL-friendly article identifier | - |
excerpt | string | null | Short article summary | - |
coverImage | string | null | Cover image URL | - |
published* | boolean | Publication status | - |
viewCount* | number | Number of views | - |
readTimeMinutes* | number | Estimated reading time | - |
createdAt* | string | ISO 8601 creation date | - |
publishedAt | string | null | ISO 8601 publication date | - |
curl -X GET "https://api.simplist.blog/v1/articles?page=1&limit=5&published=true"
-H "X-API-Key: YOUR_API_KEY"{
"data": [
{
"id": "art_123",
"title": "Getting Started with Simplist",
"slug": "getting-started",
"excerpt": "Learn how to use Simplist in your projects",
"coverImage": "https://cdn.simplist.blog/covers/getting-started.jpg",
"published": true,
"viewCount": 1547,
"readTimeMinutes": 5,
"createdAt": "2025-01-15T10:30:00Z",
"publishedAt": "2025-01-15T14:00:00Z"
}
],
"meta": {
"page": 1,
"limit": 5,
"total": 42,
"totalPages": 9
}
}You can filter articles by tags using three different parameters:
Get articles with at least one of the specified tags:
# Articles tagged with JavaScript OR TypeScript
curl -X GET "https://api.simplist.blog/v1/articles?tags=JavaScript,TypeScript" \
-H "X-API-Key: YOUR_API_KEY"Get articles that have all specified tags:
# Articles tagged with BOTH Tutorial AND JavaScript
curl -X GET "https://api.simplist.blog/v1/articles?tagsAll=Tutorial,JavaScript" \
-H "X-API-Key: YOUR_API_KEY"Get articles that don't have specific tags:
# Articles without Advanced or Deprecated tags
curl -X GET "https://api.simplist.blog/v1/articles?excludeTags=Advanced,Deprecated" \
-H "X-API-Key: YOUR_API_KEY"You can combine multiple tag filters for complex queries:
# Articles about JavaScript OR TypeScript, that are tutorials, but not advanced
curl -X GET "https://api.simplist.blog/v1/articles?tags=JavaScript,TypeScript&tagsAll=Tutorial&excludeTags=Advanced" \
-H "X-API-Key: YOUR_API_KEY"If you're using TypeScript/JavaScript, you can use the SDK instead: client.articles.list()
- GET/v1/tags - List all available tags
- GET/v1/tags/:name - Get a specific tag
-
GET/v1/articles/:slug
- Get a single article