Join us now
← Back to API Reference overview

Workspaces

Endpoints for managing workspaces in Linkbreakers. These endpoints allow you to update and get workspaces.

Shortcut: ⌘K

#The Workspace object

Workspace represents a workspace in the system

country

string

createdAt

string (date-time)

enforceMfa

boolean

id

string

inactiveSince

string (date-time)

linkSettingId

string

name

string

subscriptionType

string (enum)
Allowed values
SUBSCRIPTION_TYPE_UNSPECIFIED
SUBSCRIPTION_TYPE_FREE_TRIAL
SUBSCRIPTION_TYPE_FREE_FOREVER
SUBSCRIPTION_TYPE_PRO_PLAN
SUBSCRIPTION_TYPE_ENTERPRISE_PLAN

timezone

string

updatedAt

string (date-time)

verifiedAt

string (date-time)
GET/v1/workspaceRequires auth

#Get my workspace

#Parameters

This endpoint does not accept any parameters.

#Response

200

Everything worked as expected.

country

string

createdAt

string (date-time)

enforceMfa

boolean

id

string

inactiveSince

string (date-time)

linkSettingId

string

name

string

subscriptionType

string (enum)
Allowed values
SUBSCRIPTION_TYPE_UNSPECIFIED
SUBSCRIPTION_TYPE_FREE_TRIAL
SUBSCRIPTION_TYPE_FREE_FOREVER
SUBSCRIPTION_TYPE_PRO_PLAN
SUBSCRIPTION_TYPE_ENTERPRISE_PLAN

timezone

string

updatedAt

string (date-time)

verifiedAt

string (date-time)

#Error response

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

GET/v1/workspaces/{id}Requires auth

#Get a workspace by ID

#Parameters

path parameters

id

stringRequiredpath

#Response

200

Everything worked as expected.

country

string

createdAt

string (date-time)

enforceMfa

boolean

id

string

inactiveSince

string (date-time)

linkSettingId

string

name

string

subscriptionType

string (enum)
Allowed values
SUBSCRIPTION_TYPE_UNSPECIFIED
SUBSCRIPTION_TYPE_FREE_TRIAL
SUBSCRIPTION_TYPE_FREE_FOREVER
SUBSCRIPTION_TYPE_PRO_PLAN
SUBSCRIPTION_TYPE_ENTERPRISE_PLAN

timezone

string

updatedAt

string (date-time)

verifiedAt

string (date-time)

#Error response

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

PUT/v1/workspaceRequires auth

#Update a workspace

#Parameters

This endpoint does not accept any parameters.

#Request body

enforceMfa

boolean

name

string

#Response

200

Everything worked as expected.

country

string

createdAt

string (date-time)

enforceMfa

boolean

id

string

inactiveSince

string (date-time)

linkSettingId

string

name

string

subscriptionType

string (enum)
Allowed values
SUBSCRIPTION_TYPE_UNSPECIFIED
SUBSCRIPTION_TYPE_FREE_TRIAL
SUBSCRIPTION_TYPE_FREE_FOREVER
SUBSCRIPTION_TYPE_PRO_PLAN
SUBSCRIPTION_TYPE_ENTERPRISE_PLAN

timezone

string

updatedAt

string (date-time)

verifiedAt

string (date-time)

#Error response

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.