RESTful API Help

Query Milestones

Http Method

GET

End Point

/~api/projects/{projectId}/milestones

Placeholder	Description	Example
{projectId}	Project Id	1

Query Parameters

Parameter	Description	Required	Example
name	Name	No	string
startBefore	ISO 8601 date	No	2023-09-21T23:27:00.845Z
startAfter	ISO 8601 date	No	2023-09-21T23:27:00.845Z
dueBefore	ISO 8601 date	No	2023-09-21T23:27:00.845Z
dueAfter	ISO 8601 date	No	2023-09-21T23:27:00.845Z
closed	Closed	No	true
offset	Offset	Yes	0
count	Count	Yes	100

Response

Operation Successful

Status Code

200

Response Body

Content Type: application/json
Example: [ {

"id" : 1 ,
"projectId" : 1 ,
"name" : "string" ,
"description" : "string" ,
"startDate" : "2023-09-21T23:27:00.840+00:00" ,
"dueDate" : "2023-09-21T23:27:00.840+00:00" ,
"closed" : true

} ]

Operation Failed

Status code: Status code other than 200 indicating the error type
Response Body: Error detail of content type "text/plain"

cURL Example

$ curl -u <login name>:<password or access token> -G https://crash.software/~api/projects/1/milestones --data-urlencode name=string --data-urlencode startBefore=2023-09-21T23:27:00.841Z --data-urlencode startAfter=2023-09-21T23:27:00.841Z --data-urlencode dueBefore=2023-09-21T23:27:00.841Z --data-urlencode dueAfter=2023-09-21T23:27:00.841Z --data-urlencode closed=true --data-urlencode offset=0 --data-urlencode count=100