GET
/
v1
/
admin
/
workspaces
/
{id}
curl --request GET \
  --url https://api.botpress.cloud/v1/admin/workspaces/{id}
{
  "id": "<string>",
  "name": "<string>",
  "ownerId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "botCount": 123,
  "billingVersion": "v1",
  "plan": "community",
  "blocked": true,
  "spendingLimit": 123,
  "about": "",
  "profilePicture": "",
  "contactEmail": "",
  "website": "",
  "socialAccounts": [],
  "isPublic": true,
  "handle": ""
}

Path Parameters

​
id
string
required

Workspace ID

Response

200
application/json
Success
​
id
string
required
​
name
string
required
​
ownerId
string
required
​
createdAt
string
required
​
updatedAt
string
required
​
botCount
number
required
​
billingVersion
enum<string>
required
Available options:
v1,
v2,
v3
​
plan
enum<string>
required
Available options:
community,
team,
enterprise,
plus
​
blocked
boolean
required
​
spendingLimit
number
required
​
about
string
default:
​
profilePicture
string
default:
​
contactEmail
string
default:
​
website
string
default:
​
socialAccounts
string[]
​
isPublic
boolean
​
handle
string
default:

Was this page helpful?

Suggest editsRaise issue