Skip to content

Events & Milestones

Get all events

Section titled “ Get all events ”
GET v3/projects/23423233/events?view=all&startDate=2019-02-25&endDate=2019-03-31 returns all events and milestones for a project.
  • view is required.
  • view=all returns events and milestones.
  • view=milestones returns milestones only.
  • view=events returns events only.
  • startDate and endDate are optional.
[
  {
    "id": 643515557,
    "title": "Coming soon",
    "start": "2016-12-28 00:00",
    "end": "2016-12-28 23:59",
    "milestone": false,
    "completed": false
  },
  {
    "id": 643501988,
    "title": "Target completed",
    "start": "2016-12-27 00:00",
    "end": "2016-12-27 23:59",
    "milestone": true,
    "completed": false
  }
]

Get event

Section titled “ Get event ”
GET v3/projects/23423233/events/643515557 returns the specified event. 
{
  "id": 643515557,
  "title": "Coming soon",
  "start": "2016-12-28 00:00",
  "end": "2016-12-28 23:59",
  "all_day": false,
  "milestone": false,
  "completed": false,
  "description": "Details will follow"
}

Create event

Section titled “ Create event ”
POST v3/projects/23423233/events creates a new event or milestone.

Milestone Example

{
  "title": "Milestone type event",
  "description": "Details to follow",
  "start": "2016-04-20",
  "private": true,
  "milestone": true,
  "assigned": [5895623, 4634893]
}

Single-Day Event Example

{
  "title": "Single-day event",
  "description": "Details to follow",
  "start": "2016-04-20",
  "all_day": true,
  "private": false,
  "assigned": [5895623, 4634893]
}

Multi-Day Event Example

{
  "title": "Multi-day event",
  "description": "Details to follow",
  "start": "2016-04-20",
  "end": "2016-04-22",
  "all_day": true,
  "private": false,
  "assigned": [5895623, 4634893]
}

Timed Event Example

{
  "title": "Timed event",
  "description": "Details to follow",
  "start": "2016-04-20T15:30:00-05:00",
  "end": "2016-04-20T16:30:00-05:00",
  "all_day": false,
  "private": false,
  "reminder": 30,
  "assigned": [5895623, 4634893]
}

The start and end values can be dates for all-day events or timezone-aware timestamps for timed events.

201 Created is returned along with the event JSON if the record is created successfully.

Update event

Section titled “ Update event ”
PUT v3/projects/23423233/events/789456 updates an existing event. 
{
  "title": "Timed event",
  "description": "Details to follow",
  "start": "2016-04-20T15:30:00-05:00",
  "end": "2016-04-20T18:30:00-05:00",
  "private": true,
  "all_day": false,
  "assigned": [5895623, 4634893]
}
200 OK is returned along with the updated event JSON. 403 Forbidden is returned for invalid access.

Complete milestone

Section titled “ Complete milestone ”
PUT v3/projects/23423233/events/845875 can be used to complete a milestone. 
{
  "completed": true
}

Only milestone-type events can be marked as completed. Pass false to mark a completed milestone as incomplete.

200 OK is returned along with the updated event JSON.

Delete event

Section titled “ Delete event ”
DELETE DELETE v3/projects/23423233/events/789456 deletes the specified event.
204 No Content is returned if the event is deleted successfully. 403 Forbidden is returned for invalid access.