Workspace
Get a workspace
Workspace
Get a workspace
GET
/
v1
/
workspaces
/
{workspaceId}
curl --request GET \
--url https://app.typebot.io/api/v1/workspaces/{workspaceId} \
--header 'Authorization: Bearer <token>'
{
"workspace": {
"id": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"name": "<string>",
"icon": "<string>",
"plan": "FREE",
"stripeId": "<string>",
"settings": {
"groupTitlesAutoGeneration": {
"isEnabled": true,
"provider": "<string>",
"credentialsId": "<string>",
"model": "<string>",
"prompt": "<string>"
}
},
"customChatsLimit": 123,
"customSeatsLimit": 123,
"isSuspended": true,
"isPastDue": true,
"isVerified": true,
"chatsHardLimit": 123,
"lastActivityAt": "<string>",
"inactiveFirstEmailSentAt": "<string>",
"inactiveSecondEmailSentAt": "<string>"
},
"currentUserMode": "read"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Response
200
application/json
Successful response
Available options:
FREE
, STARTER
, PRO
, LIFETIME
, OFFERED
, CUSTOM
, UNLIMITED
Available options:
read
, write
, guest
curl --request GET \
--url https://app.typebot.io/api/v1/workspaces/{workspaceId} \
--header 'Authorization: Bearer <token>'
{
"workspace": {
"id": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"name": "<string>",
"icon": "<string>",
"plan": "FREE",
"stripeId": "<string>",
"settings": {
"groupTitlesAutoGeneration": {
"isEnabled": true,
"provider": "<string>",
"credentialsId": "<string>",
"model": "<string>",
"prompt": "<string>"
}
},
"customChatsLimit": 123,
"customSeatsLimit": 123,
"isSuspended": true,
"isPastDue": true,
"isVerified": true,
"chatsHardLimit": 123,
"lastActivityAt": "<string>",
"inactiveFirstEmailSentAt": "<string>",
"inactiveSecondEmailSentAt": "<string>"
},
"currentUserMode": "read"
}