GET
/api/public/v1/milestones

List milestones

The company’s own named groupings of work. `projectCount` is how many tickets each one holds.

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

Query Parameters

NameTypeRequiredDescription
limitnumberOptionalMaximum number of items to return (1-100).Default: 20
offsetnumberOptionalNumber of items to skip before starting to collect the result set.Default: 0
sortBystringOptionalField to sort by. Allowed values vary by endpoint.Default: createdAt
sortOrderstring
asc
desc
OptionalSort direction.Default: desc
searchstringOptionalFree-text search across the resource’s primary fields.
createdAfterstringOptionalISO 8601 timestamp — only return items created after this time.
createdBeforestringOptionalISO 8601 timestamp — only return items created before this time.
updatedAfterstringOptionalISO 8601 timestamp — only return items updated after this time.
GETExample request
curl
curl -X GET "https://www.pxb.app/api/public/v1/milestones" \
  -H "Authorization: Bearer your_access_token"
200Example response
json
{
  "message": "Milestones retrieved successfully!",
  "content": {
    "milestones": [
      {
        "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"
      }
    ],
    "pagination": {
      "total": 42,
      "limit": 20,
      "offset": 0,
      "hasMore": true
    }
  }
}

In the console

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

Projects → Milestones
/projects
  1. Open the Projects table.
  2. Milestones.