Skip to main content
POST
/
v1
/
onboarding
Start Onboarding
curl --request POST \
  --url https://almanac-backend-83vc.onrender.com/v1/onboarding \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://almanac-backend-83vc.onrender.com/v1/onboarding"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://almanac-backend-83vc.onrender.com/v1/onboarding', 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://almanac-backend-83vc.onrender.com/v1/onboarding",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://almanac-backend-83vc.onrender.com/v1/onboarding"

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

req.Header.Add("Authorization", "Bearer <token>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://almanac-backend-83vc.onrender.com/v1/onboarding")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://almanac-backend-83vc.onrender.com/v1/onboarding")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "overview": {
    "access": [
      {
        "role": "<string>",
        "workspace_id": "<string>",
        "can_manage_billing": false,
        "can_manage_developers": false,
        "can_manage_members": false
      }
    ],
    "session": {
      "user": {
        "display_name": "<string>",
        "email": "<string>",
        "user_id": "<string>",
        "avatar_url": ""
      },
      "workspaces": [
        {
          "name": "<string>",
          "role": "<string>",
          "slug": "<string>",
          "workspace_id": "<string>",
          "permissions": [
            "<string>"
          ]
        }
      ],
      "workspace_id": "<string>"
    },
    "wikis": [
      {
        "slug": "<string>",
        "title": "<string>",
        "wiki_id": "<string>",
        "workspace_id": "<string>",
        "description": ""
      }
    ]
  },
  "workspace": {
    "name": "<string>",
    "role": "<string>",
    "slug": "<string>",
    "workspace_id": "<string>",
    "permissions": [
      "<string>"
    ]
  },
  "workspace_created": true
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}

Authorizations

Authorization
string
header
required

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

Headers

authorization
string | null

Response

Successful Response

overview
HostedOverview · object
required
workspace
HostedWorkspace · object
required
workspace_created
boolean
required