GET
/
workspaces
/
{url}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
url
string
required

Workspace URL

Response

200
application/json
get workspace by URL
​
id
string

The Workspace ID.

​
url
string

The URL of the workspace.

​
name
string

The name of the workspace.

The logo of the workspace.

​
status
enum<string>

The member status of the current user.

Available options:
PENDING,
ACCEPTED,
DECLINED
​
role
enum<string>

The member role of the current user.

Available options:
OWNER,
ADMIN,
MEMBER
​
subscriptionId
string

The workspace subscription Id.

​
clicksLimit
integer

The workspace clicks limit

​
stockageLimit
integer

The workspace stockage limit

​
qrCodeLinksLimit
integer

The workspace QR Code limit

​
shortLinksLimit
integer

The workspace short links limit

​
plan
enum<string>

The member plan

Available options:
FREE,
PRO,
CUSTOM
​
isPaymentFailed
boolean

The subscription payment status

Delete a documentRetrieve a list of links