Skip to main content

Get list of workspaces

Retrieve list of workspaces

Header Parameters
X-Bc-Token string REQUIRED

JWT token with user account

Responses
200

Successful response

Schema OPTIONAL
workspaces object[] OPTIONAL
id integer OPTIONAL

ID of the workspace

uuid string OPTIONAL

Universally Unique Identifier

name string OPTIONAL

Name of the workspace

description string OPTIONAL

Description of the workspace

current integer OPTIONAL

Current value

created_at date-time OPTIONAL

Date and time the workspace was created

updated_at date-time OPTIONAL

Date and time the workspace was last updated

deleted_at date-time OPTIONAL

Date and time the workspace was deleted

user_id integer OPTIONAL

ID of the user

users object[] OPTIONAL
id integer OPTIONAL

ID of the user

uuid string OPTIONAL

Universally Unique Identifier

name string OPTIONAL

Name of the user

email string OPTIONAL

Email of the user

email_verified_at date-time OPTIONAL

Date and time the email was verified

created_at date-time OPTIONAL

Date and time the user was created

updated_at date-time OPTIONAL

Date and time the user was last updated

deleted_at date-time OPTIONAL

Date and time the user was deleted

sub string OPTIONAL

Subject of the user

pivot object OPTIONAL
workspace_id integer OPTIONAL

ID of the workspace

user_id integer OPTIONAL

ID of the user

settings object[] OPTIONAL
id integer OPTIONAL

ID of the settings

workspace_id integer OPTIONAL

ID of the workspace

setting string OPTIONAL

Setting name

data object OPTIONAL
currency_id integer OPTIONAL

ID of the currency

payment_type_id integer OPTIONAL

ID of the payment type

created_at date-time OPTIONAL

Date and time the settings were created

updated_at date-time OPTIONAL

Date and time the settings were last updated

deleted_at date-time OPTIONAL

Date and time the settings were deleted

user object OPTIONAL
id integer OPTIONAL

ID of the user

uuid string OPTIONAL

Universally Unique Identifier

name string OPTIONAL

Name of the user

email string OPTIONAL

Email of the user

email_verified_at date-time OPTIONAL

Date and time the email was verified

created_at date-time OPTIONAL

Date and time the user was created

updated_at date-time OPTIONAL

Date and time the user was last updated

deleted_at date-time OPTIONAL

Date and time the user was deleted

sub string OPTIONAL

Subject of the user