ื“ืœื’ ืœืชื•ื›ืŸ ื”ืจืืฉื™

Project Endpoints

API endpoints for project management, modules, and sprints.

Projectsโ€‹

List Projectsโ€‹

GET /api/organization-projects?take=20&skip=0&relations[]=members&relations[]=organizationContact
Authorization: Bearer {token}

Response (200 OK):

{
  "items": [
    {
      "id": "...",
      "name": "Gauzy Platform",
      "description": "Open-source business management platform",
      "billing": "RATE",
      "currency": "USD",
      "startDate": "2024-01-01T00:00:00.000Z",
      "endDate": null,
      "budget": 100000,
      "budgetType": "COST",
      "openSource": true,
      "taskListType": "GRID",
      "membersCount": 15,
      "isActive": true,
      "organizationId": "...",
      "organizationContactId": "..."
    }
  ],
  "total": 8
}

Get Project by IDโ€‹

GET /api/organization-projects/{id}?relations[]=teams&relations[]=modules
Authorization: Bearer {token}

Create Projectโ€‹

POST /api/organization-projects
Authorization: Bearer {token}
Content-Type: application/json

{
  "name": "New Project",
  "description": "Project description",
  "billing": "RATE",
  "currency": "USD",
  "startDate": "2024-01-01",
  "budget": 50000,
  "budgetType": "COST",
  "taskListType": "SPRINT",
  "organizationId": "org-uuid",
  "members": [{ "id": "employee-uuid" }]
}

Update Projectโ€‹

PUT /api/organization-projects/{id}
Authorization: Bearer {token}
Content-Type: application/json

{
  "name": "Updated Name",
  "billing": "MILESTONES"
}

Delete Projectโ€‹

DELETE /api/organization-projects/{id}
Authorization: Bearer {token}

Project Billing Typesโ€‹

TypeDescription
RATEHourly rate billing
FLATFlat project fee
MILESTONESMilestone-based billing

Project Budget Typesโ€‹

TypeDescription
COSTBudget in monetary amount
HOURSBudget in working hours

Project Task List Viewsโ€‹

TypeDescription
GRIDKanban/grid view
SPRINTSprint board view

Project Modulesโ€‹

List Modulesโ€‹

GET /api/organization-project-module?where[projectId]={project-id}
Authorization: Bearer {token}

Create Moduleโ€‹

POST /api/organization-project-module
Authorization: Bearer {token}
Content-Type: application/json

{
  "name": "Authentication Module",
  "description": "User authentication and authorization",
  "projectId": "project-uuid",
  "organizationId": "org-uuid",
  "startDate": "2024-01-15",
  "endDate": "2024-02-15"
}

Project Settingsโ€‹

Get Project Settingsโ€‹

GET /api/organization-projects/{id}/settings
Authorization: Bearer {token}

Update Project Settingsโ€‹

PUT /api/organization-projects/{id}/settings
Authorization: Bearer {token}
Content-Type: application/json

{
  "isTasksAutoSync": true,
  "isTasksAutoSyncOnLabel": true,
  "syncTag": "gauzy"
}

Required Permissionsโ€‹

EndpointPermission
GET /api/organization-projectsORG_PROJECT_VIEW
POST /api/organization-projectsORG_PROJECT_EDIT
PUT /api/organization-projects/:idORG_PROJECT_EDIT
DELETE /api/organization-projects/:idORG_PROJECT_EDIT