Skip to main content

GetWorkspace

Properties

NameTypeRequiredDescription
workspaceGetWorkspaceWorkspaceInformation about the workspace.

GetWorkspaceWorkspace

Information about the workspace.

Properties

NameTypeRequiredDescription
idstringThe workspace's ID.
namestringThe workspace's name.
typeWorkspaceType2The type of workspace.
descriptionstringThe workspace's description.
visibilityWorkspaceVisibilityThe workspace's visibility. Visibility determines who can access the workspace: - personal — Only you can access the workspace. - team — All team members can access the workspace. - private — Only invited team members can access the workspace (Professional and Enterprise plans only). - public — Everyone can access the workspace. - partner — Only invited team members and partners can access the workspace (Professional and Enterprise plans only).
createdBystringThe user ID of the user who created the workspace.
updatedBystringThe user ID of the user who last updated the workspace.
createdAtstringThe date and time at which the workspace was created.
updatedAtstringThe date and time at which the workspace was last updated.
collectionsWorkspaceCollections[]The workspace's collections.
environmentsWorkspaceEnvironments[]The workspace's environments.
mocksWorkspaceMocks[]The workspace's mock servers.
monitorsWorkspaceMonitors[]The workspace's monitors.
apisWorkspaceApis[]The workspace's APIs.

WorkspaceType2

The type of workspace.

Properties

NameTypeRequiredDescription
PERSONALstring"personal"
TEAMstring"team"
PRIVATE_string"private"
PUBLIC_string"public"
PARTNERstring"partner"

WorkspaceVisibility

The workspace's visibility. Visibility determines who can access the workspace: - personal — Only you can access the workspace. - team — All team members can access the workspace. - private — Only invited team members can access the workspace (Professional and Enterprise plans only). - public — Everyone can access the workspace. - partner — Only invited team members and partners can access the workspace (Professional and Enterprise plans only).

Properties

NameTypeRequiredDescription
PERSONALstring"personal"
TEAMstring"team"
PRIVATE_string"private"
PUBLIC_string"public"
PARTNERstring"partner"

WorkspaceCollections

Information about the collection.

Properties

NameTypeRequiredDescription
idstringThe collection's ID.
namestringThe collection's name.
uidstringThe collection's unique ID.

WorkspaceEnvironments

Information about the environment.

Properties

NameTypeRequiredDescription
idstringThe environment's ID.
namestringThe environment's name.
uidstringThe environment's unique ID.

WorkspaceMocks

Information about the mock server.

Properties

NameTypeRequiredDescription
idstringThe mock server's ID.
namestringThe mock server's name.
uidstringThe mock server's unique ID.
deactivatedbooleanIf true, the mock server is not active. Mock servers deactivate when a linked collection or environment is deleted.

WorkspaceMonitors

Information about the monitor.

Properties

NameTypeRequiredDescription
idstringThe monitor's ID.
namestringThe monitor's name.
uidstringThe monitor's unique ID.

WorkspaceApis

Information about the API.

Properties

NameTypeRequiredDescription
idstringThe API's ID.
namestringThe API's name.
uidstringThe API's unique ID.

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →