RESTful API Help

Query Basic Info

Http Method

GET

End Point

/~api/groups

Query Parameters

Parameter	Description	Required	Example
name	Name	No	string
offset	Offset	Yes	0
count	Count	Yes	100

Response

Operation Successful

Status Code

200

Response Body

Content Type: application/json
Example: [ {

"id" : 1 ,
"name" : "string" ,
"description" : "string" ,
"administrator" : true ,
"createRootProjects" : true ,
"enforce2FA" : 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://git.codedune.app/~api/groups --data-urlencode name=string --data-urlencode offset=0 --data-urlencode count=100