Skip to content
docs
Menu
#

List Projects

Retrieve all projects in your workspace

GET /api/v1/projects
On this page
#

Request

Authorization string · header · required

Bearer token for authentication

#

Response

success boolean

Indicates if the request was successful

data object

data

projects array

Array of project objects

project

id string

Unique project identifier

ownerId string

ID of the project owner

name string

Project name

icon string

Project icon identifier

color string

Project color theme

createdAt string

ISO 8601 creation timestamp

updatedAt string

ISO 8601 last update timestamp

total number

Total number of projects

#

Request examples

cURL

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://cloud.specstory.com/api/v1/projects

JavaScript

const response = await fetch('https://cloud.specstory.com/api/v1/projects', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const data = await response.json();

Python

import requests

response = requests.get(
    'https://cloud.specstory.com/api/v1/projects',
    headers={'Authorization': 'Bearer YOUR_API_KEY'}
)

data = response.json()
#

Response examples

200 Success

{
  "success": true,
  "data": {
    "projects": [
      {
        "id": "proj_abc123xyz789",
        "ownerId": "user_def456uvw012",
        "name": "My Web App",
        "icon": "Code2",
        "color": "blue",
        "createdAt": "2024-01-15T10:30:00.000Z",
        "updatedAt": "2024-01-20T14:45:30.000Z"
      },
      {
        "id": "proj_ghi789rst345",
        "ownerId": "user_def456uvw012",
        "name": "Mobile App Development",
        "icon": "Rocket",
        "color": "emerald",
        "createdAt": "2024-01-10T14:20:00.000Z",
        "updatedAt": "2024-01-18T09:15:00.000Z"
      }
    ],
    "total": 2
  }
}

401 Unauthorized

{
  "success": false,
  "error": "Invalid or missing authentication token"
}