Create workspace

Creates a new workspace.

POST /workspaces

Create workspace

cURL

curl --request POST \
  --url https://api.gologin.com/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Workspace",
  "os": "win",
  "osSpec": "win11"
}
'

200

{
  "id": "<string>",
  "name": "<string>",
  "owner": "<string>",
  "planId": "<string>",
  "planName": "<string>",
  "paymentMethod": "<string>",
  "planMembersMax": 123,
  "isPlanUnlimited": true,
  "planExpiresAt": "2023-11-07T05:31:56Z",
  "paymentIsTrial": true,
  "isUnpaid": true,
  "memberCount": 123,
  "profilesCount": 123,
  "planProfilesMax": 123,
  "permissions": {
    "canAddBilling": true,
    "canClaimProfilesWithoutFolder": true
  }
}

Authorizations

Authorization · string · header · required

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

Body

application/json

name · string

Name of the workspace.

Example:

"My Workspace"

os · enum<string>

Gologin will create starting profiles with creating a workspace. If you want to create a workspace with a specific OS, you can specify it here.

Available options: lin, mac, win, android, android-cloud

Example:

"win"

osSpec · enum<string>

Here you can specify OS specification. For example chip version for macos or version of windows.

Available options: M1, M2, M3, M4, M5, win11,

Example:

"win11"

Response

200 - application/json

id · string · required

name · string · required

owner · string · required

planId · string · required

planName · string · required

paymentMethod · string · required

planMembersMax · number · required

isPlanUnlimited · boolean · required

planExpiresAt · string<date-time> · required

paymentIsTrial · boolean · required

isUnpaid · boolean · required

memberCount · number · required

profilesCount · number · required

planProfilesMax · number · required

permissions · object · required

Show child attributes