RESTful API Help

Query Basic Info

Http Method

GET

End Point

/~api/projects

Query Parameters

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

Response

Operation Successful

Status Code

200

Response Body

Content Type: application/json
Example: [ {

"id" : 1 ,
"forkedFromId" : 1 ,
"parentId" : 1 ,
"description" : "string" ,
"createDate" : "2024-04-25T07:02:22.616+00:00" ,
"defaultRoleId" : 1 ,
"name" : "string" ,
"codeManagement" : true ,
"issueManagement" : true ,
"gitPackConfig" : {

"windowMemory" : "string" ,
"packSizeLimit" : "string" ,
"threads" : "string" ,
"window" : "string"

} ,
"codeAnalysisSetting" : {

"analysisFiles" : "string"

}

} ]

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 --data-urlencode 'query="Name" is "projectName"' --data-urlencode offset=0 --data-urlencode count=100