get WorkSpaces
Developing
Testing Env
Testing Env
GET
/api/v1/workspaces
Last modified:2025-05-05 18:52:28
List Workspaces
Endpoint
GET /api/workspacesParameters
Query Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| per_page | integer | No | 15 | Number of items to return per page |
| page | integer | No | 1 | Page number to retrieve |
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 Body (JSON)
| Name | Type | Required | Description |
|---|---|---|---|
| business_id | integer | Yes | ID of the associated business |
Responses
Success Response (200 OK)
{
"status_code": 200,
"code": 1020,
"hint": "Processed Successfully",
"success": true,
"data": {
"workspaces": {
"data": [
{
"id": 8,
"name": "Workspace Name",
"client_name": "اسم العميل",
"description": "وصف المساحة",
"board_ids": "1,2",
"team_ids": "1,2",
"business_id": 259,
"created_at": "2025-04-29T07:44:40.000000Z",
"updated_at": "2025-04-29T07:44:40.000000Z"
},
{
"id": 4,
"name": "Workspace Name",
"client_name": "اسم العميل",
"description": "وصف المساحة",
"board_ids": "1,2",
"team_ids": "1,2",
"business_id": 259,
"created_at": "2025-04-29T07:18:33.000000Z",
"updated_at": "2025-04-29T07:18:33.000000Z"
},
],
"pagination": {
"current_page": 1,
"last_page": 1,
"per_page": 10,
"total": 3
}
},
"message": "Workspaces retrieved successfully"
}
}Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/workspaces' \
--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": {
"workspaces": {
"data": [
{
"id": 8,
"name": "Workspace Name",
"client_name": "اسم العميل",
"description": "وصف المساحة",
"board_ids": "1,2",
"team_ids": "1,2",
"business_id": 259,
"created_at": "2025-04-29T07:44:40.000000Z",
"updated_at": "2025-04-29T07:44:40.000000Z"
},
{
"id": 4,
"name": "Workspace Name",
"client_name": "اسم العميل",
"description": "وصف المساحة",
"board_ids": "1,2",
"team_ids": "1,2",
"business_id": 259,
"created_at": "2025-04-29T07:18:33.000000Z",
"updated_at": "2025-04-29T07:18:33.000000Z"
},
{
"id": 3,
"name": "Workspace Name",
"client_name": "اسم العميل",
"description": "وصف المساحة",
"board_ids": "1,2",
"team_ids": "1,2",
"business_id": 259,
"created_at": "2025-04-29T06:55:45.000000Z",
"updated_at": "2025-04-29T06:55:45.000000Z"
}
],
"pagination": {
"current_page": 1,
"last_page": 1,
"per_page": 10,
"total": 3
}
},
"message": "Workspaces 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
required
Example:
application/json