workspaceschema.md

WorkspaceSchema

Fields

Field	Type	Required	Description	Example
id	str	✔️	The unique ID of the workspace.
name	str	✔️	The name of the workspace.
slug	str	✔️	The slug of the workspace.
logo	OptionalNullable[str]	➖	The logo of the workspace.
invite_code	Nullable[str]	✔️	The invite code of the workspace.
plan	components.Plan	✔️	The plan of the workspace.
stripe_id	Nullable[str]	✔️	The Stripe ID of the workspace.
billing_cycle_start	float	✔️	The date and time when the billing cycle starts for the workspace.
payment_failed_at	Nullable[str]	✔️	The date and time when the payment failed for the workspace.
stripe_connect_id	Nullable[str]	✔️	The Stripe Connect ID of the workspace.
total_links	float	✔️	The total number of links in the workspace.
usage	float	✔️	The usage of the workspace.
usage_limit	float	✔️	The usage limit of the workspace.
links_usage	float	✔️	The links usage of the workspace.
links_limit	float	✔️	The links limit of the workspace.
sales_usage	float	✔️	The dollar amount of tracked revenue in the current billing cycle (in cents).
sales_limit	float	✔️	The limit of tracked revenue in the current billing cycle (in cents).
domains_limit	float	✔️	The domains limit of the workspace.
tags_limit	float	✔️	The tags limit of the workspace.
folders_usage	float	✔️	The folders usage of the workspace.
folders_limit	float	✔️	The folders limit of the workspace.
users_limit	float	✔️	The users limit of the workspace.
ai_usage	float	✔️	The AI usage of the workspace.
ai_limit	float	✔️	The AI limit of the workspace.
conversion_enabled	bool	✔️	Whether the workspace has conversion tracking enabled automatically for new links (d.to/conversions).
dot_link_claimed	bool	✔️	Whether the workspace has claimed a free .link domain. (dub.link/free)
partners_enabled	bool	✔️	Whether the workspace has Dub Partners enabled.
created_at	str	✔️	The date and time when the workspace was created.
users	List[components.Users]	✔️	The role of the authenticated user in the workspace.
domains	List[components.Domains]	✔️	The domains of the workspace.
flags	Dict[str, bool]	➖	The feature flags of the workspace, indicating which features are enabled.
store	Dict[str, Any]	✔️	The miscellaneous key-value store of the workspace.
allowed_hostnames	List[str]	✔️	Specifies hostnames permitted for client-side click tracking.	[ "dub.sh" ]