Get Shared Project List
Important Note
This feature is available in the Business plan. If you haven't upgraded yet, please upgrade before using this feature.
API Overview
- Function: Get List of Shared Projects in a Team
- Request Method: GET
- Request URL: /api/orgs/{org_id}/projects?appid={appid}&access_token={access_token}
Request Parameters
Parameter Name | Type | Required | Location | Description | Example |
---|---|---|---|---|---|
org_id | integer | Yes | uri | Team ID | 60000000002, obtained from [Workspace - Avatar (top-right) - Team Management - Click Team Name] |
Response Parameters
Parameter Name | Type | Description |
---|---|---|
total | integer | Total Count |
list | array[object] | Project List |
list[_].id | integer | Project ID |
list[_].user_id | integer | Creator User ID |
list[_].name | string | Project Name |
Response Examples
- Successful Request
{
"code": "OK",
"error": {
"type": "",
},
"data": {
"total": 3,
"list": [
{
"id": 391504,
"type": 1,
"level": 0,
"user_id": 50000000003,
"owner_user_id": 60001689255,
"name": "Engineering Department Project",
"status": 1,
"created_at": "2023-12-12 17:15:23",
"updated_at": "2023-12-12 17:15:23"
},
{
"id": 391502,
"type": 1,
"level": 0,
"user_id": 50000000004,
"owner_user_id": 60001689255,
"name": "Test Project",
"status": 1,
"created_at": "2023-12-12 17:15:23",
"updated_at": "2023-12-12 17:15:23"
},
{
"id": 391503,
"type": 1,
"level": 0,
"user_id": 50000000004,
"owner_user_id": 60001689255,
"name": "OpenAPI Project",
"status": 1,
"created_at": "2023-12-12 17:15:23",
"updated_at": "2023-12-12 17:15:23"
}
]
},
"request_id": "2d9b5e52-9165-4f7d-a40d-83a1178e3538"
}
- Failed Request
{
"code": "InvalidArgument",
"error": {
"type": "invalid_argument",
},
"data": {},
"request_id": "ddec96d2-165e-4f3e-8a64-2057db116983"
}
Error Codes
error.type Code | Description |
---|---|
claim_error | Permission Validation Failed |
invalid_argument | Parameter Validation Failed |