REST API
Retrieve complete project information including metadata and statistics.
GET
{{baseUrl}}/v1/projectAuth required
Returns a ProjectInfo object containing both project metadata and statistics.
| Property | Type | Description | Default |
|---|---|---|---|
project* | Project | Project metadata | - |
stats* | ProjectStats | Project statistics | - |
| Property | Type | Description | Default |
|---|---|---|---|
id* | string | Unique project identifier | - |
name* | string | Project name | - |
slug* | string | URL-friendly identifier | - |
createdAt* | string | ISO 8601 creation timestamp | - |
updatedAt* | string | ISO 8601 last update | - |
| Property | Type | Description | Default |
|---|---|---|---|
totalArticles* | number | Total article count | - |
publishedArticles* | number | Published article count | - |
totalViews* | number | Total views across all articles | - |
storageUsed* | string | Storage used (e.g., '1.2 MB') | - |
storageLimit* | string | Storage limit (e.g., '100 MB') | - |
cURL Command
curl -X GET "https://api.simplist.blog/v1/project" \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"{
"data": {
"project": {
"id": "prj_abc123",
"name": "My Blog",
"slug": "my-blog",
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2025-12-09T08:15:00Z"
},
"stats": {
"totalArticles": 42,
"publishedArticles": 35,
"totalViews": 15473,
"storageUsed": "1.2 MB",
"storageLimit": "100 MB"
}
}
}- Dashboard: Display project statistics
- Monitoring: Track storage usage and article count
- Analytics: Show total views and publication rate
- Health checks: Verify project status
If you're using TypeScript/JavaScript, you can use the SDK instead: client.project.get()