Skip to main content
GET
/
workspaces
/
{url}
Get workspace by URL
curl --request GET \
  --url https://api.reqlick.com/workspaces/{url} \
  --header 'Authorization: Bearer <token>'
{
  "id": "1110580a82031111aaa03333",
  "url": "reqlick-url",
  "name": "Reqlick",
  "logo": "logo.png",
  "status": "ACCEPTED",
  "role": "MEMBER",
  "subscriptionId": "1110580a82031111aaa03333",
  "clicksLimit": 1000,
  "stockageLimit": 10000,
  "qrCodeLinksLimit": 10,
  "shortLinksLimit": 100,
  "plan": "FREE",
  "isPaymentFailed": true
}

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

get workspace by URL

​
id
string

The Workspace ID.

Example:

"1110580a82031111aaa03333"

​
url
string

The URL of the workspace.

Example:

"reqlick-url"

​
name
string

The name of the workspace.

Example:

"Reqlick"

The logo of the workspace.

Example:

"logo.png"

​
status
enum<string>

The member status of the current user.

Available options:
PENDING,
ACCEPTED,
DECLINED
Example:

"ACCEPTED"

​
role
enum<string>

The member role of the current user.

Available options:
OWNER,
ADMIN,
MEMBER
Example:

"MEMBER"

​
subscriptionId
string

The workspace subscription Id.

Example:

"1110580a82031111aaa03333"

​
clicksLimit
integer

The workspace clicks limit

Example:

1000

​
stockageLimit
integer

The workspace stockage limit

Example:

10000

​
qrCodeLinksLimit
integer

The workspace QR Code limit

Example:

10

​
shortLinksLimit
integer

The workspace short links limit

Example:

100

​
plan
enum<string>

The member plan

Available options:
FREE,
PRO,
CUSTOM
Example:

"FREE"

​
isPaymentFailed
boolean

The subscription payment status

Example:

true