Onboarding setup
curl --request POST \
--url https://api.anhome.tuanle.dev/api/v1/onboarding/setup \
--header 'Content-Type: application/json' \
--data '
{
"account": {
"display_name": "Demo Owner",
"email": "owner@example.com",
"password": "change-me-123",
"username": "demo_owner"
},
"billing_settings": {
"billing_day": 1,
"due_day": 5,
"electricity_pricing_type": "METERED",
"electricity_unit_price": "3500",
"water_fixed_amount": "15000",
"water_pricing_type": "PER_OCCUPANT"
},
"organization": {
"name": "Demo Boarding House"
},
"property": {
"address": "123 Nguyen Huu Canh",
"city": "Ho Chi Minh",
"district": "Binh Thanh",
"name": "Demo Property",
"ward": "Ward 22"
},
"rooms": {
"base_rent": "3000000",
"count": 3,
"default_deposit": "3000000",
"name_prefix": "Phòng",
"start_number": 1
}
}
'import requests
url = "https://api.anhome.tuanle.dev/api/v1/onboarding/setup"
payload = {
"account": {
"display_name": "Demo Owner",
"email": "owner@example.com",
"password": "change-me-123",
"username": "demo_owner"
},
"billing_settings": {
"billing_day": 1,
"due_day": 5,
"electricity_pricing_type": "METERED",
"electricity_unit_price": "3500",
"water_fixed_amount": "15000",
"water_pricing_type": "PER_OCCUPANT"
},
"organization": { "name": "Demo Boarding House" },
"property": {
"address": "123 Nguyen Huu Canh",
"city": "Ho Chi Minh",
"district": "Binh Thanh",
"name": "Demo Property",
"ward": "Ward 22"
},
"rooms": {
"base_rent": "3000000",
"count": 3,
"default_deposit": "3000000",
"name_prefix": "Phòng",
"start_number": 1
}
}
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({
account: {
display_name: 'Demo Owner',
email: 'owner@example.com',
password: 'change-me-123',
username: 'demo_owner'
},
billing_settings: {
billing_day: 1,
due_day: 5,
electricity_pricing_type: 'METERED',
electricity_unit_price: '3500',
water_fixed_amount: '15000',
water_pricing_type: 'PER_OCCUPANT'
},
organization: {name: 'Demo Boarding House'},
property: {
address: '123 Nguyen Huu Canh',
city: 'Ho Chi Minh',
district: 'Binh Thanh',
name: 'Demo Property',
ward: 'Ward 22'
},
rooms: {
base_rent: '3000000',
count: 3,
default_deposit: '3000000',
name_prefix: 'Phòng',
start_number: 1
}
})
};
fetch('https://api.anhome.tuanle.dev/api/v1/onboarding/setup', 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.anhome.tuanle.dev/api/v1/onboarding/setup",
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([
'account' => [
'display_name' => 'Demo Owner',
'email' => 'owner@example.com',
'password' => 'change-me-123',
'username' => 'demo_owner'
],
'billing_settings' => [
'billing_day' => 1,
'due_day' => 5,
'electricity_pricing_type' => 'METERED',
'electricity_unit_price' => '3500',
'water_fixed_amount' => '15000',
'water_pricing_type' => 'PER_OCCUPANT'
],
'organization' => [
'name' => 'Demo Boarding House'
],
'property' => [
'address' => '123 Nguyen Huu Canh',
'city' => 'Ho Chi Minh',
'district' => 'Binh Thanh',
'name' => 'Demo Property',
'ward' => 'Ward 22'
],
'rooms' => [
'base_rent' => '3000000',
'count' => 3,
'default_deposit' => '3000000',
'name_prefix' => 'Phòng',
'start_number' => 1
]
]),
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.anhome.tuanle.dev/api/v1/onboarding/setup"
payload := strings.NewReader("{\n \"account\": {\n \"display_name\": \"Demo Owner\",\n \"email\": \"owner@example.com\",\n \"password\": \"change-me-123\",\n \"username\": \"demo_owner\"\n },\n \"billing_settings\": {\n \"billing_day\": 1,\n \"due_day\": 5,\n \"electricity_pricing_type\": \"METERED\",\n \"electricity_unit_price\": \"3500\",\n \"water_fixed_amount\": \"15000\",\n \"water_pricing_type\": \"PER_OCCUPANT\"\n },\n \"organization\": {\n \"name\": \"Demo Boarding House\"\n },\n \"property\": {\n \"address\": \"123 Nguyen Huu Canh\",\n \"city\": \"Ho Chi Minh\",\n \"district\": \"Binh Thanh\",\n \"name\": \"Demo Property\",\n \"ward\": \"Ward 22\"\n },\n \"rooms\": {\n \"base_rent\": \"3000000\",\n \"count\": 3,\n \"default_deposit\": \"3000000\",\n \"name_prefix\": \"Phòng\",\n \"start_number\": 1\n }\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.anhome.tuanle.dev/api/v1/onboarding/setup")
.header("Content-Type", "application/json")
.body("{\n \"account\": {\n \"display_name\": \"Demo Owner\",\n \"email\": \"owner@example.com\",\n \"password\": \"change-me-123\",\n \"username\": \"demo_owner\"\n },\n \"billing_settings\": {\n \"billing_day\": 1,\n \"due_day\": 5,\n \"electricity_pricing_type\": \"METERED\",\n \"electricity_unit_price\": \"3500\",\n \"water_fixed_amount\": \"15000\",\n \"water_pricing_type\": \"PER_OCCUPANT\"\n },\n \"organization\": {\n \"name\": \"Demo Boarding House\"\n },\n \"property\": {\n \"address\": \"123 Nguyen Huu Canh\",\n \"city\": \"Ho Chi Minh\",\n \"district\": \"Binh Thanh\",\n \"name\": \"Demo Property\",\n \"ward\": \"Ward 22\"\n },\n \"rooms\": {\n \"base_rent\": \"3000000\",\n \"count\": 3,\n \"default_deposit\": \"3000000\",\n \"name_prefix\": \"Phòng\",\n \"start_number\": 1\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anhome.tuanle.dev/api/v1/onboarding/setup")
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 \"account\": {\n \"display_name\": \"Demo Owner\",\n \"email\": \"owner@example.com\",\n \"password\": \"change-me-123\",\n \"username\": \"demo_owner\"\n },\n \"billing_settings\": {\n \"billing_day\": 1,\n \"due_day\": 5,\n \"electricity_pricing_type\": \"METERED\",\n \"electricity_unit_price\": \"3500\",\n \"water_fixed_amount\": \"15000\",\n \"water_pricing_type\": \"PER_OCCUPANT\"\n },\n \"organization\": {\n \"name\": \"Demo Boarding House\"\n },\n \"property\": {\n \"address\": \"123 Nguyen Huu Canh\",\n \"city\": \"Ho Chi Minh\",\n \"district\": \"Binh Thanh\",\n \"name\": \"Demo Property\",\n \"ward\": \"Ward 22\"\n },\n \"rooms\": {\n \"base_rent\": \"3000000\",\n \"count\": 3,\n \"default_deposit\": \"3000000\",\n \"name_prefix\": \"Phòng\",\n \"start_number\": 1\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"access_token": "<string>",
"refresh_token": "<string>",
"user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"username": "<string>",
"email": "<string>",
"display_name": "<string>"
},
"organization": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"slug": "<string>"
},
"property": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"address": "<string>",
"city": "<string>",
"district": "<string>",
"ward": "<string>",
"note": "<string>",
"archived_at": "2023-11-07T05:31:56Z"
},
"billing_settings": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"property_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"billing_day": 123,
"due_day": 123,
"electricity_unit_price": "3500",
"electricity_fixed_amount": "0",
"water_unit_price": "15000",
"water_fixed_amount": "0",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"rooms": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"property_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"has_active_lease": true,
"base_rent": "3000000",
"default_deposit": "3000000",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"images": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"image_url": "<string>",
"sort_order": 123,
"media_asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alt_text": "<string>"
}
],
"floor": "<string>",
"area_m2": 123,
"note": "<string>",
"archived_at": "2023-11-07T05:31:56Z",
"cover_image": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"image_url": "<string>",
"sort_order": 123,
"media_asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alt_text": "<string>"
},
"meter_reading_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
},
"request_id": "<string>",
"meta": {}
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"fields": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"fields": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"fields": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"fields": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"fields": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"fields": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"fields": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"fields": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"fields": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"details": "<unknown>"
}
}onboarding
Onboarding setup
Documents an AnHome API operation.
POST
https://api.anhome.tuanle.dev
/
api
/
v1
/
onboarding
/
setup
Onboarding setup
curl --request POST \
--url https://api.anhome.tuanle.dev/api/v1/onboarding/setup \
--header 'Content-Type: application/json' \
--data '
{
"account": {
"display_name": "Demo Owner",
"email": "owner@example.com",
"password": "change-me-123",
"username": "demo_owner"
},
"billing_settings": {
"billing_day": 1,
"due_day": 5,
"electricity_pricing_type": "METERED",
"electricity_unit_price": "3500",
"water_fixed_amount": "15000",
"water_pricing_type": "PER_OCCUPANT"
},
"organization": {
"name": "Demo Boarding House"
},
"property": {
"address": "123 Nguyen Huu Canh",
"city": "Ho Chi Minh",
"district": "Binh Thanh",
"name": "Demo Property",
"ward": "Ward 22"
},
"rooms": {
"base_rent": "3000000",
"count": 3,
"default_deposit": "3000000",
"name_prefix": "Phòng",
"start_number": 1
}
}
'import requests
url = "https://api.anhome.tuanle.dev/api/v1/onboarding/setup"
payload = {
"account": {
"display_name": "Demo Owner",
"email": "owner@example.com",
"password": "change-me-123",
"username": "demo_owner"
},
"billing_settings": {
"billing_day": 1,
"due_day": 5,
"electricity_pricing_type": "METERED",
"electricity_unit_price": "3500",
"water_fixed_amount": "15000",
"water_pricing_type": "PER_OCCUPANT"
},
"organization": { "name": "Demo Boarding House" },
"property": {
"address": "123 Nguyen Huu Canh",
"city": "Ho Chi Minh",
"district": "Binh Thanh",
"name": "Demo Property",
"ward": "Ward 22"
},
"rooms": {
"base_rent": "3000000",
"count": 3,
"default_deposit": "3000000",
"name_prefix": "Phòng",
"start_number": 1
}
}
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({
account: {
display_name: 'Demo Owner',
email: 'owner@example.com',
password: 'change-me-123',
username: 'demo_owner'
},
billing_settings: {
billing_day: 1,
due_day: 5,
electricity_pricing_type: 'METERED',
electricity_unit_price: '3500',
water_fixed_amount: '15000',
water_pricing_type: 'PER_OCCUPANT'
},
organization: {name: 'Demo Boarding House'},
property: {
address: '123 Nguyen Huu Canh',
city: 'Ho Chi Minh',
district: 'Binh Thanh',
name: 'Demo Property',
ward: 'Ward 22'
},
rooms: {
base_rent: '3000000',
count: 3,
default_deposit: '3000000',
name_prefix: 'Phòng',
start_number: 1
}
})
};
fetch('https://api.anhome.tuanle.dev/api/v1/onboarding/setup', 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.anhome.tuanle.dev/api/v1/onboarding/setup",
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([
'account' => [
'display_name' => 'Demo Owner',
'email' => 'owner@example.com',
'password' => 'change-me-123',
'username' => 'demo_owner'
],
'billing_settings' => [
'billing_day' => 1,
'due_day' => 5,
'electricity_pricing_type' => 'METERED',
'electricity_unit_price' => '3500',
'water_fixed_amount' => '15000',
'water_pricing_type' => 'PER_OCCUPANT'
],
'organization' => [
'name' => 'Demo Boarding House'
],
'property' => [
'address' => '123 Nguyen Huu Canh',
'city' => 'Ho Chi Minh',
'district' => 'Binh Thanh',
'name' => 'Demo Property',
'ward' => 'Ward 22'
],
'rooms' => [
'base_rent' => '3000000',
'count' => 3,
'default_deposit' => '3000000',
'name_prefix' => 'Phòng',
'start_number' => 1
]
]),
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.anhome.tuanle.dev/api/v1/onboarding/setup"
payload := strings.NewReader("{\n \"account\": {\n \"display_name\": \"Demo Owner\",\n \"email\": \"owner@example.com\",\n \"password\": \"change-me-123\",\n \"username\": \"demo_owner\"\n },\n \"billing_settings\": {\n \"billing_day\": 1,\n \"due_day\": 5,\n \"electricity_pricing_type\": \"METERED\",\n \"electricity_unit_price\": \"3500\",\n \"water_fixed_amount\": \"15000\",\n \"water_pricing_type\": \"PER_OCCUPANT\"\n },\n \"organization\": {\n \"name\": \"Demo Boarding House\"\n },\n \"property\": {\n \"address\": \"123 Nguyen Huu Canh\",\n \"city\": \"Ho Chi Minh\",\n \"district\": \"Binh Thanh\",\n \"name\": \"Demo Property\",\n \"ward\": \"Ward 22\"\n },\n \"rooms\": {\n \"base_rent\": \"3000000\",\n \"count\": 3,\n \"default_deposit\": \"3000000\",\n \"name_prefix\": \"Phòng\",\n \"start_number\": 1\n }\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.anhome.tuanle.dev/api/v1/onboarding/setup")
.header("Content-Type", "application/json")
.body("{\n \"account\": {\n \"display_name\": \"Demo Owner\",\n \"email\": \"owner@example.com\",\n \"password\": \"change-me-123\",\n \"username\": \"demo_owner\"\n },\n \"billing_settings\": {\n \"billing_day\": 1,\n \"due_day\": 5,\n \"electricity_pricing_type\": \"METERED\",\n \"electricity_unit_price\": \"3500\",\n \"water_fixed_amount\": \"15000\",\n \"water_pricing_type\": \"PER_OCCUPANT\"\n },\n \"organization\": {\n \"name\": \"Demo Boarding House\"\n },\n \"property\": {\n \"address\": \"123 Nguyen Huu Canh\",\n \"city\": \"Ho Chi Minh\",\n \"district\": \"Binh Thanh\",\n \"name\": \"Demo Property\",\n \"ward\": \"Ward 22\"\n },\n \"rooms\": {\n \"base_rent\": \"3000000\",\n \"count\": 3,\n \"default_deposit\": \"3000000\",\n \"name_prefix\": \"Phòng\",\n \"start_number\": 1\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anhome.tuanle.dev/api/v1/onboarding/setup")
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 \"account\": {\n \"display_name\": \"Demo Owner\",\n \"email\": \"owner@example.com\",\n \"password\": \"change-me-123\",\n \"username\": \"demo_owner\"\n },\n \"billing_settings\": {\n \"billing_day\": 1,\n \"due_day\": 5,\n \"electricity_pricing_type\": \"METERED\",\n \"electricity_unit_price\": \"3500\",\n \"water_fixed_amount\": \"15000\",\n \"water_pricing_type\": \"PER_OCCUPANT\"\n },\n \"organization\": {\n \"name\": \"Demo Boarding House\"\n },\n \"property\": {\n \"address\": \"123 Nguyen Huu Canh\",\n \"city\": \"Ho Chi Minh\",\n \"district\": \"Binh Thanh\",\n \"name\": \"Demo Property\",\n \"ward\": \"Ward 22\"\n },\n \"rooms\": {\n \"base_rent\": \"3000000\",\n \"count\": 3,\n \"default_deposit\": \"3000000\",\n \"name_prefix\": \"Phòng\",\n \"start_number\": 1\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"access_token": "<string>",
"refresh_token": "<string>",
"user": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"username": "<string>",
"email": "<string>",
"display_name": "<string>"
},
"organization": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"slug": "<string>"
},
"property": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"address": "<string>",
"city": "<string>",
"district": "<string>",
"ward": "<string>",
"note": "<string>",
"archived_at": "2023-11-07T05:31:56Z"
},
"billing_settings": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"property_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"billing_day": 123,
"due_day": 123,
"electricity_unit_price": "3500",
"electricity_fixed_amount": "0",
"water_unit_price": "15000",
"water_fixed_amount": "0",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"rooms": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"property_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"has_active_lease": true,
"base_rent": "3000000",
"default_deposit": "3000000",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"images": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"image_url": "<string>",
"sort_order": 123,
"media_asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alt_text": "<string>"
}
],
"floor": "<string>",
"area_m2": 123,
"note": "<string>",
"archived_at": "2023-11-07T05:31:56Z",
"cover_image": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"image_url": "<string>",
"sort_order": 123,
"media_asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alt_text": "<string>"
},
"meter_reading_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
},
"request_id": "<string>",
"meta": {}
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"fields": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"fields": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"fields": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"fields": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"fields": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"fields": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"fields": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"fields": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"request_id": "<string>",
"fields": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"details": "<unknown>"
}
}Body
application/json
JSON payload used to onboarding setup.
Request payload for onboarding setup.
account value for onboarding setup request.
Show child attributes
Show child attributes
Organization record included in the response.
Show child attributes
Show child attributes
property value for onboarding setup request.
Show child attributes
Show child attributes
billing settings value for onboarding setup request.
Show child attributes
Show child attributes
Rooms returned by the response.
Show child attributes
Show child attributes
Response
Created landlord account, organization, property, billing settings, rooms, and auth session atomically
Endpoint-specific response payload. See the referenced schema for the resource fields.
Show child attributes
Show child attributes
Request correlation identifier returned from X-Request-Id or generated by the API.
Optional response metadata such as pagination limits, counts, or export context.
⌘I