Workspace
Get a resumable workspace setup session
Returns the authenticated setup state and display-safe questions. Before intent confirmation, primary_goal selects the starting-point question branch. The default session lifetime is24 hours, configurable by the server. Use the session header, rather than an administrator bearer token.
GET
/
workspace-onboarding
/
{public_id}
Get a resumable workspace setup session
curl --request GET \
--url https://api.gratona.com/v1/workspace-onboarding/{public_id} \
--header 'X-Workspace-Onboarding-Session: <x-workspace-onboarding-session>'import requests
url = "https://api.gratona.com/v1/workspace-onboarding/{public_id}"
headers = {"X-Workspace-Onboarding-Session": "<x-workspace-onboarding-session>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Workspace-Onboarding-Session': '<x-workspace-onboarding-session>'}
};
fetch('https://api.gratona.com/v1/workspace-onboarding/{public_id}', 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.gratona.com/v1/workspace-onboarding/{public_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Workspace-Onboarding-Session: <x-workspace-onboarding-session>"
],
]);
$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://api.gratona.com/v1/workspace-onboarding/{public_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Workspace-Onboarding-Session", "<x-workspace-onboarding-session>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.gratona.com/v1/workspace-onboarding/{public_id}")
.header("X-Workspace-Onboarding-Session", "<x-workspace-onboarding-session>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/workspace-onboarding/{public_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Workspace-Onboarding-Session"] = '<x-workspace-onboarding-session>'
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"public_id": "550e8400-e29b-41d4-a716-446655440000",
"state": "authenticated",
"brand_id": "gratona",
"email": "jane@example.org",
"answers": {
"primary_goal": "fundraising_campaigns",
"starting_point": "launching_new"
},
"automatic_billing": false,
"qualification": "verify_payment_method",
"expires_at": "2026-10-21T12:00:00Z",
"first_name": "Jane",
"last_name": "Donor",
"organization_name": "Example Nonprofit",
"website": "https://example.org/",
"ein": "123456789",
"country_code": "US",
"phone": "+12025550123",
"questions": [
{
"key": "primary_goal",
"prompt": "What would you like Gratona to help you set up first?",
"type": "single_choice",
"required": true,
"options": [
{
"value": "fundraising_campaigns",
"label": "Fundraising campaigns and donations"
}
]
}
]
}
}{
"status": "error",
"code": "workspace_onboarding_session_unavailable",
"message": "This setup session is no longer available. Start again."
}{
"status": "error",
"code": "workspace_onboarding_session_unavailable",
"message": "This setup session is no longer available. Start again."
}{
"status": "error",
"code": "workspace_onboarding_session_unavailable",
"message": "This setup session is no longer available. Start again."
}Headers
Opaque resume credential returned after mailbox or invitation authentication. It is bound to this setup session and expires or rotates during handoff.
Required string length:
64Path Parameters
Public setup-session UUID.
Query Parameters
Registered primary-goal choice used only to display its follow-up question.
⌘I
Get a resumable workspace setup session
curl --request GET \
--url https://api.gratona.com/v1/workspace-onboarding/{public_id} \
--header 'X-Workspace-Onboarding-Session: <x-workspace-onboarding-session>'import requests
url = "https://api.gratona.com/v1/workspace-onboarding/{public_id}"
headers = {"X-Workspace-Onboarding-Session": "<x-workspace-onboarding-session>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Workspace-Onboarding-Session': '<x-workspace-onboarding-session>'}
};
fetch('https://api.gratona.com/v1/workspace-onboarding/{public_id}', 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.gratona.com/v1/workspace-onboarding/{public_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Workspace-Onboarding-Session: <x-workspace-onboarding-session>"
],
]);
$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://api.gratona.com/v1/workspace-onboarding/{public_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Workspace-Onboarding-Session", "<x-workspace-onboarding-session>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.gratona.com/v1/workspace-onboarding/{public_id}")
.header("X-Workspace-Onboarding-Session", "<x-workspace-onboarding-session>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/workspace-onboarding/{public_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Workspace-Onboarding-Session"] = '<x-workspace-onboarding-session>'
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"public_id": "550e8400-e29b-41d4-a716-446655440000",
"state": "authenticated",
"brand_id": "gratona",
"email": "jane@example.org",
"answers": {
"primary_goal": "fundraising_campaigns",
"starting_point": "launching_new"
},
"automatic_billing": false,
"qualification": "verify_payment_method",
"expires_at": "2026-10-21T12:00:00Z",
"first_name": "Jane",
"last_name": "Donor",
"organization_name": "Example Nonprofit",
"website": "https://example.org/",
"ein": "123456789",
"country_code": "US",
"phone": "+12025550123",
"questions": [
{
"key": "primary_goal",
"prompt": "What would you like Gratona to help you set up first?",
"type": "single_choice",
"required": true,
"options": [
{
"value": "fundraising_campaigns",
"label": "Fundraising campaigns and donations"
}
]
}
]
}
}{
"status": "error",
"code": "workspace_onboarding_session_unavailable",
"message": "This setup session is no longer available. Start again."
}{
"status": "error",
"code": "workspace_onboarding_session_unavailable",
"message": "This setup session is no longer available. Start again."
}{
"status": "error",
"code": "workspace_onboarding_session_unavailable",
"message": "This setup session is no longer available. Start again."
}