GET
/
v3
/
workspaces
/
{workspaceId}
Get Workspace
curl --request GET \
  --url http://127.0.0.1:3333/v3/workspaces/{workspaceId} \
  --header 'Authorization: Bearer <token>'
{
  "workspace": {
    "id": "<string>",
    "name": "<string>",
    "icon": "<string>",
    "plan": "HOBBY",
    "stripeId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "members": [
      {
        "userId": "<string>",
        "workspaceId": "<string>",
        "role": "ADMIN",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "email": "<string>",
        "image": "<string>"
      }
    ],
    "creditsRecurring": 0,
    "creditsPurchased": 0,
    "billingStrategy": "PREPAID",
    "overageCapAmount": 123,
    "autoRechargeEnabled": false,
    "autoRechargeTrigger": 0,
    "autoRechargeAmount": 0,
    "billingCurrency": "brl",
    "resolvedCreditsLimit": 123,
    "resolvedSeatsLimit": 123,
    "resolvedStorageLimit": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string
required

Response

200 - application/json

Default Response

workspace
object
required