Skip to main content

​
Projects API Reference

Complete reference for all project-related endpoints in the Voyager API.

​
GET /api/v2/projects

List projects with optional filtering and pagination.

​
Query Parameters

ParameterTypeDescription
pageintegerPage number
page_sizeintegerResults per page
statestringFilter by state (active, archived, etc.)
workspacestringFilter by workspace UUID
tagstringFilter by tag
searchstringSearch by project name
orderingstringOrdering field

​
Response

{
  "count": 42,
  "next": "https://api.../projects?page=2",
  "previous": null,
  "results": [
    {
      "id": "project-uuid",
      "name": "Project Name",
      "status": "active",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ]
}

​
POST /api/v2/projects

Create a new project.

​
Request Body

{
  "workspace": {"id": "workspace-uuid"},
  "name": "Project Name"
}

​
GET /api/v2/projects/

Get project details.

​
Path Parameters

ParameterTypeDescription
idstring (UUID)Project ID

​
PUT /api/v2/projects/

Update project (full update).

​
PATCH /api/v2/projects/

Partially update project.

​
DELETE /api/v2/projects/

Delete a project.

​
POST /api/v2/projects//archive

Archive a project.

​
POST /api/v2/projects//restore

Restore an archived project.

​
POST /api/v2/projects//copy

Copy project to another workspace.

​
Request Body

{
  "destinationWorkspaceId": "workspace-uuid",
  "new_project_name": "Copy Name"
}

​
POST /api/v2/projects//move

Move project to another workspace.

​
Request Body

{
  "destinationWorkspaceId": "workspace-uuid"
}
For detailed guides, see Project Management Guide.