get Boards
Developing
Testing Env
Testing Env
GET
/api/v1/boards
Last modified:2025-04-27 21:06:39
API Endpoint: List Boards
GET /api/boardsDescription
Authentication
Authorization: Bearer {api_token}Request Parameters
Query Parameters
| Parameter | Type | Required | Default | Description | Validation Rules |
|---|---|---|---|---|---|
| per_page | integer | No | 10 | Number of items per page | nullable|integer|min:1|max:100 |
| page | integer | No | 1 | Page number to retrieve | nullable|integer|min:1 |
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 |
Responses
Success (200 OK)
{
"status": "success",
"code": 200,
"data": {
"boards": [
{
"id": 1,
"client_name": "Client Name",
"project_name": "Project Name",
"description": "Project details",
"project_type": "kanban",
"team_ids": [1, 2, 3],
"business_id": 123,
"created_at": "2023-01-01T12:00:00.000000Z"
}
],
"meta": {
"current_page": 1,
"last_page": 5,
"per_page": 10,
"total": 50
}
},
"message": "Boards retrieved successfully"
}Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/boards' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
--header 'user-token: ' \
--header 'secure-business-key: 4765066450c0bd66325.48403130'Response Response Example
{
"status_code": 200,
"code": 1020,
"hint": "Processed Successfully",
"success": true,
"data": {
"boards": {
"data": [
{
"id": 10,
"client_name": "اسم العميل",
"project_name": "اسم المشروع",
"description": "Project details",
"project_type": "kanban",
"team_ids": "1,2,3",
"business_id": 259,
"workspace_id": 3,
"created_at": "2025-04-29T20:43:03.000000Z",
"updated_at": "2025-04-29T20:43:03.000000Z"
},
{
"id": 9,
"client_name": "اسم العميل",
"project_name": "اسم المشروع",
"description": "Project details",
"project_type": "kanban",
"team_ids": "1,2,3",
"business_id": 259,
"workspace_id": null,
"created_at": "2025-04-29T20:40:48.000000Z",
"updated_at": "2025-04-29T20:40:48.000000Z"
},
{
"id": 8,
"client_name": "تعديل اسم العميل",
"project_name": "تعديل اسم المشروع",
"description": "Project details edit",
"project_type": "gantt",
"team_ids": "1,5,7",
"business_id": 259,
"workspace_id": 4,
"created_at": "2025-04-27T20:35:21.000000Z",
"updated_at": "2025-04-29T20:49:47.000000Z"
},
{
"id": 7,
"client_name": "اسم العميل",
"project_name": "اسم المشروع",
"description": "Project details",
"project_type": "kanban",
"team_ids": "1,2,3",
"business_id": 259,
"workspace_id": null,
"created_at": "2025-04-27T20:34:55.000000Z",
"updated_at": "2025-04-27T20:34:55.000000Z"
},
{
"id": 6,
"client_name": "اسم العميل",
"project_name": "اسم المشروع",
"description": "Project details",
"project_type": "kanban",
"team_ids": "1,2,3",
"business_id": 259,
"workspace_id": null,
"created_at": "2025-04-27T20:33:55.000000Z",
"updated_at": "2025-04-27T20:33:55.000000Z"
},
{
"id": 4,
"client_name": "اسم العميل",
"project_name": "اسم المشروع",
"description": "Project details",
"project_type": "kanban",
"team_ids": "1,2,3",
"business_id": 259,
"workspace_id": null,
"created_at": "2025-04-27T20:06:36.000000Z",
"updated_at": "2025-04-29T08:25:31.000000Z"
},
{
"id": 3,
"client_name": "اسم العميل",
"project_name": "اسم المشروع",
"description": "Project details",
"project_type": "kanban",
"team_ids": "1,2,3",
"business_id": 259,
"workspace_id": null,
"created_at": "2025-04-27T19:59:53.000000Z",
"updated_at": "2025-04-29T08:25:31.000000Z"
},
{
"id": 2,
"client_name": "اسم العميل",
"project_name": "اسم المشروع",
"description": "Project details",
"project_type": "kanban",
"team_ids": "1,2,3",
"business_id": 259,
"workspace_id": null,
"created_at": "2025-04-27T19:50:43.000000Z",
"updated_at": "2025-04-29T08:20:32.000000Z"
},
{
"id": 1,
"client_name": "اسم العميل",
"project_name": "اسم المشروع",
"description": "Project details",
"project_type": "kanban",
"team_ids": "1,2,3",
"business_id": 259,
"workspace_id": null,
"created_at": "2025-04-27T19:41:10.000000Z",
"updated_at": "2025-04-29T08:20:32.000000Z"
}
],
"pagination": {
"current_page": 1,
"last_page": 1,
"per_page": 10,
"total": 9
}
},
"message": "تم استرداد اللوحات بنجاح."
}
}Request
Header Params
Accept
string
optional
Example:
application/json
Accept-Language
string
optional
Example:
en
user-token
string
optional
Example:
{{user_token}}
secure-business-key
string
optional
Example:
{{secure_business_key}}