Skip to main content
POST
/
workspaces
Create workspace
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"
}
'
import requests

url = "https://api.gologin.com/workspaces"

payload = {
    "name": "My Workspace",
    "os": "win",
    "osSpec": "win11"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'My Workspace', os: 'win', osSpec: 'win11'})
};

fetch('https://api.gologin.com/workspaces', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gologin.com/workspaces",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'My Workspace',
    'os' => 'win',
    'osSpec' => 'win11'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gologin.com/workspaces"

	payload := strings.NewReader("{\n  \"name\": \"My Workspace\",\n  \"os\": \"win\",\n  \"osSpec\": \"win11\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.gologin.com/workspaces")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"My Workspace\",\n  \"os\": \"win\",\n  \"osSpec\": \"win11\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.gologin.com/workspaces")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"My Workspace\",\n  \"os\": \"win\",\n  \"osSpec\": \"win11\"\n}"

response = http.request(request)
puts response.read_body
{
  "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,
ios
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,
A18,
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