GET
/
workspaces
/
{idOrSlug}
Ruby
require 'dub'

s = ::OpenApiSDK::Dub.new(
      security: ::OpenApiSDK::Shared::Security.new(
        token: "DUB_API_KEY",
      ),
    )

req = ::OpenApiSDK::Operations::GetWorkspaceRequest.new(
  id_or_slug: "<value>",
)

res = s.workspaces.get(req)

if ! res.workspace_schema.nil?
  # handle response
end
{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "logo": null,
  "inviteCode": "<string>",
  "plan": "free",
  "stripeId": "<string>",
  "billingCycleStart": 123,
  "paymentFailedAt": "<string>",
  "stripeConnectId": "<string>",
  "totalLinks": 123,
  "usage": 123,
  "usageLimit": 123,
  "linksUsage": 123,
  "linksLimit": 123,
  "payoutsUsage": 123,
  "payoutsLimit": 123,
  "payoutFee": 123,
  "domainsLimit": 123,
  "tagsLimit": 123,
  "foldersUsage": 123,
  "foldersLimit": 123,
  "usersLimit": 123,
  "aiUsage": 123,
  "aiLimit": 123,
  "conversionEnabled": true,
  "dotLinkClaimed": true,
  "partnersEnabled": true,
  "createdAt": "<string>",
  "users": [
    {
      "role": "owner",
      "defaultFolderId": "<string>"
    }
  ],
  "domains": [
    {
      "slug": "acme.com",
      "primary": false,
      "verified": false
    }
  ],
  "flags": {},
  "store": {},
  "allowedHostnames": [
    "dub.sh"
  ]
}

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.