Skip to main content
GET
/
projects
Get all projects by software product
curl --request GET \
  --url https://api.workser.ai/projects \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "software_product_id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "E-commerce Web Application",
    "description": "A modern e-commerce web application built with React and Node.js",
    "project_type": "web",
    "project_template_type": "nextjs_typescript",
    "created_at": "2024-01-01T00:00:00.000Z",
    "updated_at": "2024-01-15T12:00:00.000Z",
    "user_email": "john.doe@example.com",
    "prebuilt_url": "https://example.com/prebuilt",
    "return_url": "https://example.com/back",
    "ref_id": "1234567890"
  }
]

Authorizations

​
x-api-key
string
header
required

API key for authentication

Query Parameters

​
software_product_id
string
required

Software product ID to filter projects

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
order_by
enum<string>

Sort order for projects by creation date

Available options:
ASC,
DESC

Response

Projects retrieved successfully

​
id
string

Project ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
software_product_id
string

Software product ID

Example:

"550e8400-e29b-41d4-a716-446655440001"

​
name
string

Project name

Example:

"E-commerce Web Application"

​
description
string

Project description

Example:

"A modern e-commerce web application built with React and Node.js"

​
project_type
enum<string>

Type of project

Available options:
web
Example:

"web"

​
project_template_type
string

Project template type

Example:

"nextjs_typescript"

​
created_at
string<date-time>

Creation timestamp

Example:

"2024-01-01T00:00:00.000Z"

​
updated_at
string<date-time>

Last update timestamp

Example:

"2024-01-15T12:00:00.000Z"

​
user_email
string

User email from your application

Example:

"john.doe@example.com"

​
prebuilt_url
string

Prebuilt UI URL for to use by user to interact with Workser Coding AI Agent directly

Example:

"https://example.com/prebuilt"

​
return_url
string

Return URL for prebuilt UI to get back to your application

Example:

"https://example.com/back"

​
ref_id
string

Reference ID with your application

Example:

"1234567890"