RESTful API Help

Query Profile

Http Method

GET

End Point

/~api/users

Query Parameters

Parameter	Description	Required	Example
term	Any string in login name, full name or email address	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" ,
"fullName" : "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/users --data-urlencode term=string --data-urlencode offset=0 --data-urlencode count=100