Workspaces
Retrieve all Workspaces
Control Plane
- Configs
- Virtual Keys
- API Keys
- Analytics [BETA]
- Users
- User Invites
- Workspaces
- Workspace Members
Data Plane
- Feedback
- Guardrails
- Logs
OpenAPI
Retrieve all Workspaces
GET
/
admin
/
workspaces
from portkey_ai import Portkey
# Initialize the Portkey client
portkey = Portkey(
api_key="PORTKEY_API_KEY",
)
# List workspaces
workspaces = portkey.admin.workspaces.list()
print(workspaces)
{
"total": 2,
"object": "list",
"data": [
{
"id": "test-prod-ws-12345",
"name": "Test prod workspace",
"description": "This is a production workspace",
"created_at": "2023-07-13 13:51:27",
"last_updated_at": "2023-07-13 14:51:27",
"defaults": {
"metadata": {
"foo": "bar"
}
},
"object": "workspace"
},
{
"id": "test-prod-ws-12345",
"name": "Test prod workspace",
"description": "This is a production workspace",
"created_at": "2023-07-13 13:51:27",
"last_updated_at": "2023-07-13 14:51:27",
"defaults": {
"metadata": {
"foo": "bar"
}
},
"object": "workspace"
}
]
}
Authorizations
Response
200 - application/json
OK
Example:
2
Available options:
list
Example:
"ws-test-a-174eb1"
Example:
"ws-test-a-174eb1"
Example:
"New Workspace"
Example:
null
Example:
"2024-07-30T13:27:29.000Z"
Example:
"2024-07-30T13:27:29.000Z"
Was this page helpful?
from portkey_ai import Portkey
# Initialize the Portkey client
portkey = Portkey(
api_key="PORTKEY_API_KEY",
)
# List workspaces
workspaces = portkey.admin.workspaces.list()
print(workspaces)
{
"total": 2,
"object": "list",
"data": [
{
"id": "test-prod-ws-12345",
"name": "Test prod workspace",
"description": "This is a production workspace",
"created_at": "2023-07-13 13:51:27",
"last_updated_at": "2023-07-13 14:51:27",
"defaults": {
"metadata": {
"foo": "bar"
}
},
"object": "workspace"
},
{
"id": "test-prod-ws-12345",
"name": "Test prod workspace",
"description": "This is a production workspace",
"created_at": "2023-07-13 13:51:27",
"last_updated_at": "2023-07-13 14:51:27",
"defaults": {
"metadata": {
"foo": "bar"
}
},
"object": "workspace"
}
]
}