Get Projects
Developing
Testing Env
Testing Env
GET
/api/v1/projects
Last modified:2025-05-06 10:38:11
API Documentation
Get Business Projects [GET]
URL
/api/v1/projectsRequest Headers
| Key | Value | Required |
|---|---|---|
| Accept | application/json | Yes |
| user-token | {{user_token}} | Yes |
| secure-business-key | {{secure_business_key}} | Yes |
| Accept-Language | en/ar | No |
Request Parameters (Query)
| Field | Type | Description | Required | Validation |
|---|---|---|---|---|
| workspace_id | integer | Filter projects by workspace ID | No | Must exist in workspaces table |
| per_page | integer | Number of items per page (default: config value) | No | min:1, max:100 |
| page | integer | Page number to return | No | min:1 |
Response
Success (200)
{
"status_code": 200,
"code": 1020,
"hint": "Processed Successfully",
"success": true,
"data": {
"projects": {
"data": [
{
"id": 2,
"name": "New Marketing Strategy",
"project_code": "PRJ-202505-WSCJ",
"description": "Creating a comprehensive strategy for Q3",
"project_type": "consulting",
"status": "planning",
"start_date": "2025-05-10",
"end_date": "2025-08-15",
"client_id": 3,
"branch_department_id": 2,
"manager_id": 5,
"estimated_budget": "50000.00",
"cost_center_id": 1
},
{
"id": 1,
"name": "New Marketing Strategy",
"project_code": "PRJ-202505-HYNM",
"description": "Creating a comprehensive strategy for Q3",
"project_type": "consulting",
"status": "planning",
"start_date": "2025-05-10",
"end_date": "2025-08-15",
"client_id": 3,
"branch_department_id": 2,
"manager_id": 5,
"estimated_budget": "50000.00",
"cost_center_id": 1
}
],
"pagination": {
"current_page": 1,
"last_page": 1,
"per_page": 10,
"total": 2
}
},
"message": "Projects retrieved successfully"
}
}Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/projects' \
--header 'user-token: ' \
--header 'secure-business-key: 4765066450c0bd66325.48403130' \
--header 'Accept-Language: en' \
--header 'Accept: application/json'Response Response Example
{
"status_code": 200,
"code": 1020,
"hint": "Processed Successfully",
"success": true,
"data": {
"projects": {
"data": [
{
"id": 2,
"name": "New Marketing Strategy",
"project_code": "PRJ-202505-WSCJ",
"description": "Creating a comprehensive strategy for Q3",
"project_type": "consulting",
"status": "planning",
"start_date": "2025-05-10",
"end_date": "2025-08-15",
"client_id": 3,
"branch_department_id": 2,
"manager_id": 5,
"estimated_budget": "50000.00",
"cost_center_id": 1
},
{
"id": 1,
"name": "New Marketing Strategy",
"project_code": "PRJ-202505-HYNM",
"description": "Creating a comprehensive strategy for Q3",
"project_type": "consulting",
"status": "planning",
"start_date": "2025-05-10",
"end_date": "2025-08-15",
"client_id": 3,
"branch_department_id": 2,
"manager_id": 5,
"estimated_budget": "50000.00",
"cost_center_id": 1
}
],
"pagination": {
"current_page": 1,
"last_page": 1,
"per_page": 10,
"total": 2
}
},
"message": "Projects retrieved successfully"
}
}Request
Header Params
user-token
stringÂ
optional
Example:
{{user_token}}
secure-business-key
stringÂ
optional
Example:
{{secure_business_key}}
Accept-Language
stringÂ
optional
Example:
en
Accept
stringÂ
optional
Example:
application/json