Sign in
latestOpenAPI 3.0.02026-08-216686147.9 KB

6f6009a58cdd

milestones

List visible Milestones

get/v1/milestones

Query parameters

associated_engagement_status'Pending' | 'In Progress' | 'Complete' | 'Archived'

An optional association to an Engagement lifecycle phase. It does not change the Engagement's current status or determine Milestone completion.

Filter by the optional Engagement lifecycle phase associated with each Milestone. This is not the Engagement's current status and does not determine Milestone completion.

client_can_viewboolean

Filter Milestones by client visibility.

is_completedboolean

Filter by completion state. A completed Milestone has a non-null completed_at value.

is_overdueboolean

Filter by overdue state using today's UTC date. true requires a due date before today; false includes due dates today or later and Milestones without a due date.

engagement_uuidsstring[]

Filter Milestones by Engagement UUID. Repeat the query parameter for multiple UUIDs.

pagenumber nullable
per_pagenumber nullable
sort_order'asc' | 'desc'

Sort order for paginated results. Use desc to reverse the default ascending order.

Response

The visible Milestones

Example response

{
  "data": [
    {
      "uuid": "4d50d252-be0c-4d69-b77a-5bbdfef83f54",
      "engagement_uuid": "821e8d9e-d2a8-480f-9187-5a685d3d0d71",
      "name": "Planning complete",
      "sequence": 2,
      "due_date": "2026-03-15",
      "completed_at": "2026-03-10T12:30:00.000Z",
      "completed_by_user_uuid": "6b242248-e2b9-4d41-8986-11b710860048",
      "owner_user_uuid": "ee196968-2a7a-48e9-97f9-d12f26a8ff94",
      "client_can_view": true,
      "created_at": "2026-02-01T12:30:00.000Z",
      "updated_at": "2026-03-10T12:30:00.000Z",
      "_links": {
        "self": {
          "href": "https://example.com/resource/or/path",
          "title": "A description for the link",
          "type": "text/html"
        },
        "collection": {
          "href": "https://example.com/resource/or/path",
          "title": "A description for the link",
          "type": "text/html"
        },
        "engagement": {
          "href": "https://example.com/resource/or/path",
          "title": "A description for the link",
          "type": "text/html"
        },
        "fieldguide": {
          "href": "https://example.com/resource/or/path",
          "title": "A description for the link",
          "type": "text/html"
        }
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://api.fieldguide.io/v1/example?page=2&per_page=50"
    },
    "first": {
      "href": "https://api.fieldguide.io/v1/example?page=1&per_page=50"
    },
    "last": {
      "href": "https://api.fieldguide.io/v1/example?page=10&per_page=50"
    },
    "previous": {
      "href": "https://api.fieldguide.io/v1/example?page=1&per_page=50"
    },
    "next": {
      "href": "https://api.fieldguide.io/v1/example?page=3&per_page=50"
    }
  }
}