List Workspaces

GET

///api/v1/workspaces/

GET

/api/v1/workspaces/

1 import requests
2 
3 url = "https://api.example.com/api/v1/workspaces/"
4 
5 payload = {}
6 headers = {"Content-Type": "application/json"}
7 
8 response = requests.get(url, json=payload, headers=headers)
9 
10 print(response.json())

200Retrieved

1 {
2   "count": 3,
3   "results": [
4     {
5       "id": 101,
6       "name": "Marketing Team Workspace",
7       "type": "team",
8       "description": "Workspace for the marketing department projects and campaigns.",
9       "logo": "https://cdn.aisquare.com/logos/marketing_team.png"
10     },
11     {
12       "id": 102,
13       "name": "Product Development",
14       "type": "department",
15       "parent_id": 101,
16       "description": "Workspace dedicated to product design and development.",
17       "logo": "https://cdn.aisquare.com/logos/product_dev.png"
18     },
19     {
20       "id": 103,
21       "name": "AI Research Group",
22       "type": "group",
23       "parent_id": 102,
24       "description": "Research group focused on AI and machine learning innovations."
25     }
26   ],
27   "next": "https://api.aisquare.com/api/v1/workspaces/?page=2"
28 }

List all workspaces where the authenticated user has effective membership (direct or inherited), ordered by most recently selected.

Query parameters

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

Response

Workspace list

countinteger

resultslist of objects

nextstring or nullformat: "uri"

previousstring or nullformat: "uri"