Roadmap milestones
`/roadmap-milestones`
One page of records, newest first unless you say otherwise, with the total count in meta so you know how far to paginate.
Required scope: roadmap-milestones:read.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
page?integer1-based. meta.totalPages says how many there are.
1 <= value1per_page?integerRows per page. A value above 200 returns 400 - never a silent clamp.
1 <= value <= 20050sort?stringPrefix with - for descending. An undeclared sort returns 400.
"startsOn""startsOn""-startsOn""createdAt""-createdAt""name""-name"q?stringCase-insensitive "contains", across: name.
filter[clientId]?stringExact match on clientId.
filter[projectId]?stringExact match on projectId.
filter[clientVisible]?stringExact match on clientVisible.
"true""false"filter[precision]?stringExact match on precision.
filter[dealId]?stringExact match on dealId.
The requested page.
application/json- response
data*array<>meta*curl -X GET 'https://api.usedashly.com/v1/roadmap-milestones'{ "data": [ { "id": "string", "clientId": "string", "projectId": "string", "name": "string", "description": "string", "startsOn": "2019-08-24", "endsOn": "2019-08-24", "precision": "string", "baselineStartsOn": "2019-08-24", "baselineEndsOn": "2019-08-24", "baselinePrecision": "string", "statusOverride": "string", "clientVisible": true, "dealId": "string", "estimatedAmountCents": 0, "amountCents": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "meta": { "page": 0, "perPage": 0, "total": 0, "totalPages": 0 }}Links are given as the target's public id (clientId: "hsbftmp3f5"); the API resolves them server-side. Fields the database requires but the interface decides for you are filled in the same way here.
Required scope: roadmap-milestones:write.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
Idempotency-Key?stringA value you choose (a UUID is the usual one), 8 to 255 characters of A-Z a-z 0-9 _ . : -. Retrying with the same key returns the first call's answer instead of creating a second record, for seven days. The same key with a different body returns 409.
8 <= length <= 255application/json- body
name*string1 <= length <= 200description?|nullclientVisible?booleanstatusOverride?|nullclientId*stringprojectId?string|nulldealId?string|nullestimatedAmountCents?|nullamountCents?|nullcreatedAt?stringWhen this actually happened, for an import. Past dates only; defaults to now. updatedAt follows it unless the body sets one.
date-timeCreated. The body is the new record, as a read would return it.
application/json- response
data*curl -X POST 'https://api.usedashly.com/v1/roadmap-milestones' \ -H 'Content-Type: application/json' \ -d '{ "name": "string", "clientId": "string"}'{ "data": { "id": "string", "clientId": "string", "projectId": "string", "name": "string", "description": "string", "startsOn": "2019-08-24", "endsOn": "2019-08-24", "precision": "string", "baselineStartsOn": "2019-08-24", "baselineEndsOn": "2019-08-24", "baselinePrecision": "string", "statusOverride": "string", "clientVisible": true, "dealId": "string", "estimatedAmountCents": 0, "amountCents": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}The full record, custom fields included when the resource carries them. A record from another agency is a 404, not a 403 - its existence is not ours to confirm.
Required scope: roadmap-milestones:read.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
id*stringThe record's public id (hsbftmp3f5), as returned in the id field. An internal UUID returns 404.
Found.
application/json- response
data*curl -X GET 'https://api.usedashly.com/v1/roadmap-milestones/string'{ "data": { "id": "string", "clientId": "string", "projectId": "string", "name": "string", "description": "string", "startsOn": "2019-08-24", "endsOn": "2019-08-24", "precision": "string", "baselineStartsOn": "2019-08-24", "baselineEndsOn": "2019-08-24", "baselinePrecision": "string", "statusOverride": "string", "clientVisible": true, "dealId": "string", "estimatedAmountCents": 0, "amountCents": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}A partial update: only the fields you send change. One exception - customFields is replaced wholesale, not merged, so sending it with a single key clears the others. Read the record, merge, then write.
Required scope: roadmap-milestones:write.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
id*stringThe record's public id (hsbftmp3f5), as returned in the id field. An internal UUID returns 404.
application/json- body
name?string1 <= length <= 200description?|nullclientVisible?booleanstatusOverride?|nullprojectId?string|nulldealId?string|nullestimatedAmountCents?|nullamountCents?|nullUpdated. The body is the record as it now stands.
application/json- response
data*curl -X PATCH 'https://api.usedashly.com/v1/roadmap-milestones/string' \ -H 'Content-Type: application/json' \ -d '{}'{ "data": { "id": "string", "clientId": "string", "projectId": "string", "name": "string", "description": "string", "startsOn": "2019-08-24", "endsOn": "2019-08-24", "precision": "string", "baselineStartsOn": "2019-08-24", "baselineEndsOn": "2019-08-24", "baselinePrecision": "string", "statusOverride": "string", "clientVisible": true, "dealId": "string", "estimatedAmountCents": 0, "amountCents": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}Permanent. The audit log keeps the trace; the record does not come back.
Required scope: roadmap-milestones:write.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
id*stringThe record's public id (hsbftmp3f5), as returned in the id field. An internal UUID returns 404.
Deleted. Empty body.
curl -X DELETE 'https://api.usedashly.com/v1/roadmap-milestones/string'Every verb this resource answers to, with its target and the JSON Schema of its body - the same contracts this document describes, readable at runtime.
Required scope: roadmap-milestones:read.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
The available verbs.
application/json- response
data*array<>curl -X GET 'https://api.usedashly.com/v1/roadmap-milestones/actions'{ "data": [ { "name": "string", "label": "string", "description": "string", "target": "item", "readOnly": true, "path": "string", "input": {} } ]}Sets the period: startsOn, endsOn (YYYY-MM-DD) and precision (day | month | quarter | half, calendar), or all three null when not planned. A coarse precision widens the days to whole units: 2026-05-10 → 2026-08-02 by quarter is stored as 2026-04-01 → 2026-09-30.
Does what the dashboard's updateMilestoneAction does - same implementation, so the two cannot diverge.
Required scope: roadmap-milestones:write.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
id*stringThe public id of the record to act on. It is resolved inside your agency before the action runs, so an id from another tenant is a 404 and never reaches it.
Idempotency-Key?stringA value you choose (a UUID is the usual one), 8 to 255 characters of A-Z a-z 0-9 _ . : -. Retrying with the same key returns the first call's answer instead of creating a second record, for seven days. The same key with a different body returns 409.
8 <= length <= 255application/json- body
startsOn*string|nullendsOn*string|nullprecision*|nullDone.
application/json- response
data*unknownThe action's result; its shape depends on the verb.
curl -X POST 'https://api.usedashly.com/v1/roadmap-milestones/string/actions/set-period' \ -H 'Content-Type: application/json' \ -d '{ "startsOn": "string", "endsOn": "string", "precision": "day"}'{ "data": null}Moves a planned milestone to the next slot of the same size (Q2 → Q3, a 3-week span → the 3 weeks after). The first postponement keeps the original period as baselineStartsOn / baselineEndsOn / baselinePrecision.
Does what the dashboard's postponeMilestoneAction does - same implementation, so the two cannot diverge. Takes no body.
Required scope: roadmap-milestones:write.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
id*stringThe public id of the record to act on. It is resolved inside your agency before the action runs, so an id from another tenant is a 404 and never reaches it.
Idempotency-Key?stringA value you choose (a UUID is the usual one), 8 to 255 characters of A-Z a-z 0-9 _ . : -. Retrying with the same key returns the first call's answer instead of creating a second record, for seven days. The same key with a different body returns 409.
8 <= length <= 255Done.
application/json- response
data*unknownThe action's result; its shape depends on the verb.
curl -X POST 'https://api.usedashly.com/v1/roadmap-milestones/string/actions/postpone'{ "data": null}Turns a planned milestone (no dealId yet) into a deal of the same client: named after the milestone, worth its estimatedAmountCents, on the agency's follow-up pipeline (the one whose win does not re-onboard the client; else the default pipeline), first open stage, planned to join the milestone's project at its win, expected to close when the milestone starts. The milestone then carries it (dealId). One transaction. A milestone that already has its deal answers 409 milestone_has_deal. Needs deals:write as well. Returns the deal's public id.
Does what the dashboard's createDealFromMilestoneAction does - same implementation, so the two cannot diverge.
Required scope: roadmap-milestones:write.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
id*stringThe public id of the record to act on. It is resolved inside your agency before the action runs, so an id from another tenant is a 404 and never reaches it.
Idempotency-Key?stringA value you choose (a UUID is the usual one), 8 to 255 characters of A-Z a-z 0-9 _ . : -. Retrying with the same key returns the first call's answer instead of creating a second record, for seven days. The same key with a different body returns 409.
8 <= length <= 255application/json- body
Done.
application/json- response
data*unknownThe action's result; its shape depends on the verb.
curl -X POST 'https://api.usedashly.com/v1/roadmap-milestones/string/actions/create-deal' \ -H 'Content-Type: application/json' \ -d '{}'{ "data": null}