Skip to main content
POST
/
api
/
auth
/
signup
Create new workspace and user
curl --request POST \
  --url https://api.staging.whilst.app/api/auth/signup \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceName": "Acme Inc",
  "email": "founder@acme.com"
}
'
import requests

url = "https://api.staging.whilst.app/api/auth/signup"

payload = {
"workspaceName": "Acme Inc",
"email": "founder@acme.com"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({workspaceName: 'Acme Inc', email: 'founder@acme.com'})
};

fetch('https://api.staging.whilst.app/api/auth/signup', 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.staging.whilst.app/api/auth/signup",
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([
'workspaceName' => 'Acme Inc',
'email' => 'founder@acme.com'
]),
CURLOPT_HTTPHEADER => [
"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.staging.whilst.app/api/auth/signup"

payload := strings.NewReader("{\n \"workspaceName\": \"Acme Inc\",\n \"email\": \"founder@acme.com\"\n}")

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

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.staging.whilst.app/api/auth/signup")
.header("Content-Type", "application/json")
.body("{\n \"workspaceName\": \"Acme Inc\",\n \"email\": \"founder@acme.com\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.staging.whilst.app/api/auth/signup")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspaceName\": \"Acme Inc\",\n \"email\": \"founder@acme.com\"\n}"

response = http.request(request)
puts response.read_body
{
  "redirectUrl": "<string>",
  "organizationId": "<string>"
}
{
"message": "<string>",
"code": "<string>",
"details": {}
}
{
"message": "<string>",
"code": "<string>",
"details": {}
}
{
"message": "<string>",
"code": "<string>",
"details": {}
}

Body

application/json
workspaceName
string
required

Name of the workspace to create

Minimum string length: 1
Example:

"Acme Inc"

email
string<email>
required

Email address of the workspace creator

Example:

"founder@acme.com"

Response

Workspace created, redirect to WorkOS for verification

redirectUrl
string<uri>
required

WorkOS authorization URL for email verification

organizationId
string
required

WorkOS organization ID for the created workspace