Route: https://api.kayran.live/GetProjects
This feature allows you to fetch all the existing projects that are related to a certain user.
Roles Required: Admin and User. Private Users can only View Projects they created.
Request Syntax
{
"apiKey": "String",
"sort": "String",
"desc": True/False
}Request Parameters
Parameters being used in the Request
Parameter Name :
apiKey
Parameter Usage and Options :
Your Kayran given API Key.
How do I get it ? :
Located in the “Profile” section.
Note : by default, the “API Status” is enabled, unless, the Admin has disabled it in the “Server Settings” section.
Type :
String
Is it Optional ? :
No.
Parameter Name :
sort
Parameter Usage and Options :
allows you to sort your imported projects by id\name.
Type :
String
Is it Optional ? :
Yes.
Parameter Name :
desc
Parameter Usage and Options :
In case you want to fetch the Targets in descending order.
Value :
true\false
Type :
Boolean
Is it Optional ? :
No – if you enable sort.
Successful Response
{
"Error": 0,
"Function": "GetProjects",
"Data": "[{\"id\": 123456789, \"proj_name\": \"Testytest\", \"img\": \"\", \"company_name\": \"Name\", \"description\": \"Description\", \"user_id\": \"123456789\", \"img_ext\": \"png\", \"targets\": 0
}
}Errors and their Possible Causes
For more information, please refer to the General Errors section.