Create a milestone

Add a grouping inside one project. Names are unique within that project — a duplicate is refused rather than creating a second milestone. In the console this is a project manager’s job: the milestone list is how everyone’s work is grouped, so adding to it is not a side effect of being able to write your own.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Settings → Company → API, and to a teammate under Employee → Permissions.

projects:admin

Request Body

Property	Type	Required	Description
`projectId`	string	Required	The project the milestone belongs to. Milestones do not span projects.
`name`	string	Required	Unique within the project.
`color`	string	Required	One of the shared palette keys.
`ownerId`	string	Required	Active employee of this company. The owner and projects admins are the only ones who may later edit or delete it.
`description`	string	Optional	What the milestone covers.
`startAt`	string	Optional	ISO 8601 — the day the work starts. Together with `endsAt`, this is what puts it on the roadmap. Store it at midday: these are calendar days held as instants, and a midnight boundary reads as the previous day west of UTC.
`endsAt`	string	Optional	ISO 8601 — the day the work ends. Must not be earlier than `startAt`.

POSTExample request

curl

curl -X POST "https://www.pxb.app/api/public/v1/milestones" \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "projectId": "prj_a1b2c3",
    "name": "Billing",
    "color": "violet",
    "ownerId": "emp_12ab"
  }'

200Example response

json

{
  "message": "Milestone created successfully!",
  "content": {
    "milestone": {
      "id": "epc_9f8e",
      "name": "Billing",
      "description": "Everything invoicing-related for the rebuild.",
      "color": "violet",
      "status": "IN_PROGRESS",
      "startAt": "2026-07-01T12:00:00.000Z",
      "endsAt": "2026-09-30T12:00:00.000Z",
      "order": 0,
      "projectId": "prj_a1b2c3",
      "projectKey": "APOLLO",
      "projectName": "Apollo billing rebuild",
      "owner": {
        "employeeId": "emp_12ab",
        "name": "Sam Okafor",
        "email": "sam@example.com",
        "avatarUrl": null
      },
      "ticketCount": 6,
      "createdAt": "2026-06-02T10:00:00.000Z"
    }
  }
}

409Example response

json

{
  "message": "A milestone with that name already exists here."
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Projects → Milestones

/projects

Open a project.
Milestones → Manage milestones.