GET
/
workspaces
/
{idOrSlug}
Retrieve a workspace
curl --request GET \
  --url https://api.dub.co/workspaces/{idOrSlug} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "logo": null,
  "usage": 123,
  "usageLimit": 123,
  "linksUsage": 123,
  "linksLimit": 123,
  "domainsLimit": 123,
  "tagsLimit": 123,
  "usersLimit": 123,
  "plan": "free",
  "stripeId": "<string>",
  "billingCycleStart": 123,
  "createdAt": "<string>",
  "users": [
    {
      "role": "owner"
    }
  ],
  "domains": [
    {
      "slug": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
idOrSlug
string
required

The ID or slug of the workspace.

Response

200
application/json

The retrieved workspace

The response is of type object.