Back to Documentation
Projects API
API reference for managing projects on UXFeed.
Base URL
https://api.uxfeed.com/v1List Projects
Get a list of all your projects:
GET /projects
Response:
{
"data": [
{
"id": "proj_123",
"title": "My Project",
"description": "Project description",
"category": "web",
"status": "active",
"createdAt": "2024-01-15T10:00:00Z"
}
],
"pagination": {
"page": 1,
"perPage": 20,
"total": 1
}
}Get Project
Get details of a specific project:
GET /projects/{id}
Response:
{
"id": "proj_123",
"title": "My Project",
"description": "Project description",
"category": "web",
"status": "active",
"screenshots": ["https://..."],
"projectUrl": "https://...",
"stats": {
"views": 150,
"testerRequests": 12,
"approvedTesters": 8,
"feedbackCount": 5
},
"createdAt": "2024-01-15T10:00:00Z",
"updatedAt": "2024-01-20T14:30:00Z"
}Create Project
Create a new project:
POST /projects
Content-Type: application/json
{
"title": "My New Project",
"description": "Project description",
"category": "web",
"screenshots": ["https://..."],
"projectUrl": "https://...",
"isPublic": true,
"testingRequirements": {
"minTesters": 5,
"maxTesters": 10,
"feedbackTypes": ["ui", "ux"]
}
}
Response:
{
"id": "proj_123",
"title": "My New Project",
...
}Update Project
Update an existing project:
PATCH /projects/{id}
Content-Type: application/json
{
"title": "Updated Title",
"description": "Updated description"
}
Response:
{
"id": "proj_123",
"title": "Updated Title",
...
}Delete Project
Delete a project:
DELETE /projects/{id}
Response:
{
"success": true,
"message": "Project deleted"
}Query Parameters
When listing projects, you can use these query parameters:
page- Page number (default: 1)perPage- Items per page (default: 20, max: 100)status- Filter by status (draft, active, completed, archived)category- Filter by category (web, mobile, desktop, other)search- Search in title and description