RESTful API Help

Query Basic Info

Http Method

GET

End Point

/~api/issues

Query Parameters

Parameter	Description	Required	Example
query	Syntax of this query is the same as query box in issues page	No	"Number" is "projectName#100"
offset	Offset	Yes	0
count	Count	Yes	100

Response

Operation Successful

Status Code

200

Response Body

Content Type: application/json
Example: [ {

"id" : 1 ,
"description" : "string" ,
"state" : "string" ,
"stateOrdinal" : 1 ,
"title" : "string" ,
"numberScopeId" : 1 ,
"projectId" : 1 ,
"submitterId" : 1 ,
"submitDate" : "2024-04-16T20:35:27.440+00:00" ,
"voteCount" : 1 ,
"commentCount" : 1 ,
"uuid" : "string" ,
"number" : 1 ,
"threadingReference" : "string" ,
"lastActivity" : {

"userId" : 1 ,
"date" : "2024-04-16T20:35:27.440+00:00" ,
"description" : "string"

} ,
"confidential" : 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/issues --data-urlencode 'query="Number" is "projectName#100"' --data-urlencode offset=0 --data-urlencode count=100