Register
curl --request POST \
--url https://api.example.com/api/v1/auth/register \
--header 'Content-Type: application/json' \
--data '
{
"email": "jsmith@example.com",
"password": "<string>",
"tos_accepted": true,
"attribution": {
"referrer": "<string>",
"utm_campaign": "<string>",
"utm_content": "<string>",
"utm_medium": "<string>",
"utm_source": "<string>",
"utm_term": "<string>"
},
"full_name": "<string>",
"workspace_name": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/auth/register"
payload = {
"email": "jsmith@example.com",
"password": "<string>",
"tos_accepted": True,
"attribution": {
"referrer": "<string>",
"utm_campaign": "<string>",
"utm_content": "<string>",
"utm_medium": "<string>",
"utm_source": "<string>",
"utm_term": "<string>"
},
"full_name": "<string>",
"workspace_name": "<string>"
}
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({
email: 'jsmith@example.com',
password: '<string>',
tos_accepted: true,
attribution: {
referrer: '<string>',
utm_campaign: '<string>',
utm_content: '<string>',
utm_medium: '<string>',
utm_source: '<string>',
utm_term: '<string>'
},
full_name: '<string>',
workspace_name: '<string>'
})
};
fetch('https://api.example.com/api/v1/auth/register', 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.example.com/api/v1/auth/register",
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([
'email' => 'jsmith@example.com',
'password' => '<string>',
'tos_accepted' => true,
'attribution' => [
'referrer' => '<string>',
'utm_campaign' => '<string>',
'utm_content' => '<string>',
'utm_medium' => '<string>',
'utm_source' => '<string>',
'utm_term' => '<string>'
],
'full_name' => '<string>',
'workspace_name' => '<string>'
]),
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.example.com/api/v1/auth/register"
payload := strings.NewReader("{\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"tos_accepted\": true,\n \"attribution\": {\n \"referrer\": \"<string>\",\n \"utm_campaign\": \"<string>\",\n \"utm_content\": \"<string>\",\n \"utm_medium\": \"<string>\",\n \"utm_source\": \"<string>\",\n \"utm_term\": \"<string>\"\n },\n \"full_name\": \"<string>\",\n \"workspace_name\": \"<string>\"\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.example.com/api/v1/auth/register")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"tos_accepted\": true,\n \"attribution\": {\n \"referrer\": \"<string>\",\n \"utm_campaign\": \"<string>\",\n \"utm_content\": \"<string>\",\n \"utm_medium\": \"<string>\",\n \"utm_source\": \"<string>\",\n \"utm_term\": \"<string>\"\n },\n \"full_name\": \"<string>\",\n \"workspace_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/auth/register")
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 \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"tos_accepted\": true,\n \"attribution\": {\n \"referrer\": \"<string>\",\n \"utm_campaign\": \"<string>\",\n \"utm_content\": \"<string>\",\n \"utm_medium\": \"<string>\",\n \"utm_source\": \"<string>\",\n \"utm_term\": \"<string>\"\n },\n \"full_name\": \"<string>\",\n \"workspace_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"avatar_url": "<string>",
"current_workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"full_name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"last_login_at": "2023-11-07T05:31:56Z",
"role": "<string>",
"workspaces": [
{}
],
"current_tos_version": "2026-06-01",
"deletion_scheduled_at": "2023-11-07T05:31:56Z",
"email_verified": false,
"has_password": false,
"linked_providers": [],
"onboarding_completed": false,
"tos_accepted_at": "2023-11-07T05:31:56Z",
"tos_enforcement_date": "2026-06-15",
"tos_version": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}auth
Register
Create a new user account with the given email and password, provision their first workspace, owner membership, and default API key, then send a verification email.
POST
/
api
/
v1
/
auth
/
register
Register
curl --request POST \
--url https://api.example.com/api/v1/auth/register \
--header 'Content-Type: application/json' \
--data '
{
"email": "jsmith@example.com",
"password": "<string>",
"tos_accepted": true,
"attribution": {
"referrer": "<string>",
"utm_campaign": "<string>",
"utm_content": "<string>",
"utm_medium": "<string>",
"utm_source": "<string>",
"utm_term": "<string>"
},
"full_name": "<string>",
"workspace_name": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/auth/register"
payload = {
"email": "jsmith@example.com",
"password": "<string>",
"tos_accepted": True,
"attribution": {
"referrer": "<string>",
"utm_campaign": "<string>",
"utm_content": "<string>",
"utm_medium": "<string>",
"utm_source": "<string>",
"utm_term": "<string>"
},
"full_name": "<string>",
"workspace_name": "<string>"
}
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({
email: 'jsmith@example.com',
password: '<string>',
tos_accepted: true,
attribution: {
referrer: '<string>',
utm_campaign: '<string>',
utm_content: '<string>',
utm_medium: '<string>',
utm_source: '<string>',
utm_term: '<string>'
},
full_name: '<string>',
workspace_name: '<string>'
})
};
fetch('https://api.example.com/api/v1/auth/register', 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.example.com/api/v1/auth/register",
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([
'email' => 'jsmith@example.com',
'password' => '<string>',
'tos_accepted' => true,
'attribution' => [
'referrer' => '<string>',
'utm_campaign' => '<string>',
'utm_content' => '<string>',
'utm_medium' => '<string>',
'utm_source' => '<string>',
'utm_term' => '<string>'
],
'full_name' => '<string>',
'workspace_name' => '<string>'
]),
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.example.com/api/v1/auth/register"
payload := strings.NewReader("{\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"tos_accepted\": true,\n \"attribution\": {\n \"referrer\": \"<string>\",\n \"utm_campaign\": \"<string>\",\n \"utm_content\": \"<string>\",\n \"utm_medium\": \"<string>\",\n \"utm_source\": \"<string>\",\n \"utm_term\": \"<string>\"\n },\n \"full_name\": \"<string>\",\n \"workspace_name\": \"<string>\"\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.example.com/api/v1/auth/register")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"tos_accepted\": true,\n \"attribution\": {\n \"referrer\": \"<string>\",\n \"utm_campaign\": \"<string>\",\n \"utm_content\": \"<string>\",\n \"utm_medium\": \"<string>\",\n \"utm_source\": \"<string>\",\n \"utm_term\": \"<string>\"\n },\n \"full_name\": \"<string>\",\n \"workspace_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/auth/register")
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 \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"tos_accepted\": true,\n \"attribution\": {\n \"referrer\": \"<string>\",\n \"utm_campaign\": \"<string>\",\n \"utm_content\": \"<string>\",\n \"utm_medium\": \"<string>\",\n \"utm_source\": \"<string>\",\n \"utm_term\": \"<string>\"\n },\n \"full_name\": \"<string>\",\n \"workspace_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"avatar_url": "<string>",
"current_workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"full_name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"last_login_at": "2023-11-07T05:31:56Z",
"role": "<string>",
"workspaces": [
{}
],
"current_tos_version": "2026-06-01",
"deletion_scheduled_at": "2023-11-07T05:31:56Z",
"email_verified": false,
"has_password": false,
"linked_providers": [],
"onboarding_completed": false,
"tos_accepted_at": "2023-11-07T05:31:56Z",
"tos_enforcement_date": "2026-06-15",
"tos_version": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Body
application/json
First-touch acquisition, forwarded by the client from the landing URL.
A strict whitelist — Pydantic ignores unknown keys by default, so the client can't inject arbitrary person properties via the $set_once below.
Show child attributes
Show child attributes
Response
Successful Response
⌘I
