Retrieve a workspace

Retrieve a workspace for the authenticated user.

Authorizations

Authorization

string

header

required

Default authentication mechanism

Path Parameters

idOrSlug

string

required

The ID or slug of the workspace.

Response

200 - application/json

aiLimit

number

required

The AI limit of the workspace.

aiUsage

number

required

The AI usage of the workspace.

bankAccountName

string | null

required

[BETA – Dub Partners]: The name of the connected bank account.

bankAccountVerified

boolean

required

[BETA – Dub Partners]: Whether the bank account is verified.

billingCycleStart

number

required

The date and time when the billing cycle starts for the workspace.

conversionEnabled

boolean

required

Whether the workspace has conversion tracking enabled (d.to/conversions).

createdAt

string

required

The date and time when the workspace was created.

domains

object[]

required

The domains of the workspace.

Show child attributes

domains.primary

boolean

default:

false

required

Whether the domain is the primary domain for the workspace.

domains.slug

string

required

The domain name.

domains.verified

boolean

default:

false

required

Whether the domain is verified.

domainsLimit

number

required

The domains limit of the workspace.

dotLinkClaimed

boolean

required

Whether the workspace has claimed a free .link domain. (dub.link/free)

id

string

required

The unique ID of the workspace.

inviteCode

string | null

required

The invite code of the workspace.

linksLimit

number

required

The links limit of the workspace.

linksUsage

number

required

The links usage of the workspace.

logo

string | null

required

The logo of the workspace.

name

string

required

The name of the workspace.

partialAccountNumber

string | null

required

[BETA – Dub Partners]: The partial account number of the bank account.

paymentFailedAt

string | null

required

The date and time when the payment failed for the workspace.

plan

enum<string>

required

The plan of the workspace.

Available options:

free,

pro,

business,

business plus,

business extra,

business max,

enterprise

publishableKey

string | null

required

The publishable key of the workspace.

referralLinkId

string | null

required

The ID of the referral link of the workspace.

routingNumber

string | null

required

[BETA – Dub Partners]: The routing number of the bank account.

salesLimit

number

required

The limit of tracked revenue in the current billing cycle (in cents).

salesUsage

number

required

The dollar amount of tracked revenue in the current billing cycle (in cents).

slug

string

required

The slug of the workspace.

stripeConnectId

string | null

required

[BETA – Dub Conversions]: The Stripe Connect ID of the workspace.

stripeId

string | null

required

The Stripe ID of the workspace.

tagsLimit

number

required

The tags limit of the workspace.

usage

number

required

The usage of the workspace.

usageLimit

number

required

The usage limit of the workspace.

users

object[]

required

The role of the authenticated user in the workspace.

Show child attributes

users.role

enum<string>

required

The role of the authenticated user in the workspace.

Available options:

owner,

member

usersLimit

number

required

The users limit of the workspace.

flags

object

The feature flags of the workspace, indicating which features are enabled.

Show child attributes

flags.{key}

boolean