Milestones

Milestone management operations

Create a new milestone

post

Creates a new milestone within a project

Authorizations

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Body

titlestringRequired

Milestone title

Example: Launch Milestone

descriptionstring · nullableOptional

Milestone description

projectIdintegerRequired

Project to create milestone in

Example: 5

startDatestring · date-time · nullableOptional

Start date (ISO 8601 format)

dueDatestring · date-time · nullableOptional

Due date (ISO 8601 format)

statusstring · enumOptionalDefault: pendingPossible values:

Responses

200

Milestone created successfully

application/json

idintegerRequired

Unique milestone identifier

Example: 1

titlestringRequired

Milestone title

Example: Phase 1 Completion

descriptionstring · nullableOptional

Milestone description

Example: Complete all phase 1 deliverables

projectIdintegerRequired

Associated project ID

Example: 5

startDatestring · date-time · nullableOptional

Milestone start date

Example: 2026-01-15T00:00:00.000Z

dueDatestring · date-time · nullableOptional

Milestone due date

Example: 2026-02-28T00:00:00.000Z

statusstring · enumRequired

Milestone status

Example: in_progressPossible values:

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

400

Validation error

401

Not authenticated

403

Permission denied

500

Server error

post/milestones

POST /api/milestones HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 158

{
  "title": "Launch Milestone",
  "description": "text",
  "projectId": 5,
  "startDate": "2026-01-01T00:00:00.000Z",
  "dueDate": "2026-01-01T00:00:00.000Z",
  "status": "pending"
}

{
  "id": 1,
  "title": "Phase 1 Completion",
  "description": "Complete all phase 1 deliverables",
  "projectId": 5,
  "startDate": "2026-01-15T00:00:00.000Z",
  "dueDate": "2026-02-28T00:00:00.000Z",
  "status": "in_progress",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Get a milestone

get

Returns a specific milestone with its tasks

Authorizations

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters

idintegerRequired

Milestone ID

Responses

200

Milestone details

application/json

idintegerRequired

Unique milestone identifier

Example: 1

titlestringRequired

Milestone title

Example: Phase 1 Completion

descriptionstring · nullableOptional

Milestone description

Example: Complete all phase 1 deliverables

projectIdintegerRequired

Associated project ID

Example: 5

startDatestring · date-time · nullableOptional

Milestone start date

Example: 2026-01-15T00:00:00.000Z

dueDatestring · date-time · nullableOptional

Milestone due date

Example: 2026-02-28T00:00:00.000Z

statusstring · enumRequired

Milestone status

Example: in_progressPossible values:

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

401

Not authenticated

403

Access denied

404

Milestone not found

500

Server error

get/milestones/{id}

GET /api/milestones/{id} HTTP/1.1
Accept: */*

{
  "id": 1,
  "title": "Phase 1 Completion",
  "description": "Complete all phase 1 deliverables",
  "projectId": 5,
  "startDate": "2026-01-15T00:00:00.000Z",
  "dueDate": "2026-02-28T00:00:00.000Z",
  "status": "in_progress",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "tasks": [
    {
      "id": 1,
      "title": "text",
      "status": "text",
      "priority": "text"
    }
  ]
}

Update a milestone

put

Updates an existing milestone

Authorizations

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters

idintegerRequired

Milestone ID

Body

titlestringOptional

descriptionstring · nullableOptional

startDatestring · date-time · nullableOptional

dueDatestring · date-time · nullableOptional

statusstring · enumOptionalPossible values:

Responses

200

Milestone updated successfully

application/json

idintegerRequired

Unique milestone identifier

Example: 1

titlestringRequired

Milestone title

Example: Phase 1 Completion

descriptionstring · nullableOptional

Milestone description

Example: Complete all phase 1 deliverables

projectIdintegerRequired

Associated project ID

Example: 5

startDatestring · date-time · nullableOptional

Milestone start date

Example: 2026-01-15T00:00:00.000Z

dueDatestring · date-time · nullableOptional

Milestone due date

Example: 2026-02-28T00:00:00.000Z

statusstring · enumRequired

Milestone status

Example: in_progressPossible values:

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

401

Not authenticated

403

Permission denied

404

Milestone not found

500

Server error

put/milestones/{id}

PUT /api/milestones/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "title": "text",
  "description": "text",
  "startDate": "2026-01-01T00:00:00.000Z",
  "dueDate": "2026-01-01T00:00:00.000Z",
  "status": "pending"
}

{
  "id": 1,
  "title": "Phase 1 Completion",
  "description": "Complete all phase 1 deliverables",
  "projectId": 5,
  "startDate": "2026-01-15T00:00:00.000Z",
  "dueDate": "2026-02-28T00:00:00.000Z",
  "status": "in_progress",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Delete a milestone

delete

Deletes a milestone. Tasks associated with the milestone will be unlinked.

Authorizations

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters

idintegerRequired

Milestone ID

Responses

204

Milestone deleted successfully

No content

401

Not authenticated

403

Permission denied

404

Milestone not found

500

Server error

delete/milestones/{id}

DELETE /api/milestones/{id} HTTP/1.1
Accept: */*

No content

List milestones for a project

get

Returns all milestones associated with a specific project

Authorizations

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters

projectIdintegerRequired

Project ID

Responses

200

List of project milestones

application/json

idintegerRequired

Unique milestone identifier

Example: 1

titlestringRequired

Milestone title

Example: Phase 1 Completion

descriptionstring · nullableOptional

Milestone description

Example: Complete all phase 1 deliverables

projectIdintegerRequired

Associated project ID

Example: 5

startDatestring · date-time · nullableOptional

Milestone start date

Example: 2026-01-15T00:00:00.000Z

dueDatestring · date-time · nullableOptional

Milestone due date

Example: 2026-02-28T00:00:00.000Z

statusstring · enumRequired

Milestone status

Example: in_progressPossible values:

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

401

Not authenticated

403

Access denied

404

Project not found

500

Server error

get/projects/{projectId}/milestones

GET /api/projects/{projectId}/milestones HTTP/1.1
Accept: */*

[
  {
    "id": 1,
    "title": "Phase 1 Completion",
    "description": "Complete all phase 1 deliverables",
    "projectId": 5,
    "startDate": "2026-01-15T00:00:00.000Z",
    "dueDate": "2026-02-28T00:00:00.000Z",
    "status": "in_progress",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "tasks": [
      {
        "id": 1,
        "title": "text",
        "status": "text",
        "priority": "text"
      }
    ]
  }
]

PreviousDocuments NextTags

Last updated 6 months ago

Was this helpful?