Workspace
Look up a nonprofit during workspace setup
Searches the configured nonprofit directory while the session is authenticated or organization_confirmed. Returns up to eight normalized matches; a disabled or failed provider returns HTTP200 unavailable with an empty results array. Search collapses whitespace and must remain2–100 characters after normalization.
POST
/
workspace-onboarding
/
{public_id}
/
organization-lookup
Look up a nonprofit during workspace setup
curl --request POST \
--url https://api.gratona.com/v1/workspace-onboarding/{public_id}/organization-lookup \
--header 'Content-Type: application/json' \
--header 'X-Workspace-Onboarding-Session: <x-workspace-onboarding-session>' \
--data '
{
"query": "Example Nonprofit"
}
'import requests
url = "https://api.gratona.com/v1/workspace-onboarding/{public_id}/organization-lookup"
payload = { "query": "Example Nonprofit" }
headers = {
"X-Workspace-Onboarding-Session": "<x-workspace-onboarding-session>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Workspace-Onboarding-Session': '<x-workspace-onboarding-session>',
'Content-Type': 'application/json'
},
body: JSON.stringify({query: 'Example Nonprofit'})
};
fetch('https://api.gratona.com/v1/workspace-onboarding/{public_id}/organization-lookup', 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}/organization-lookup",
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([
'query' => 'Example Nonprofit'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gratona.com/v1/workspace-onboarding/{public_id}/organization-lookup"
payload := strings.NewReader("{\n \"query\": \"Example Nonprofit\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Workspace-Onboarding-Session", "<x-workspace-onboarding-session>")
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.gratona.com/v1/workspace-onboarding/{public_id}/organization-lookup")
.header("X-Workspace-Onboarding-Session", "<x-workspace-onboarding-session>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"Example Nonprofit\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/workspace-onboarding/{public_id}/organization-lookup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Workspace-Onboarding-Session"] = '<x-workspace-onboarding-session>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"Example Nonprofit\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"status": "ready",
"results": [
{
"name": "Example Nonprofit",
"ein": "12-3456789",
"website": "https://example.org",
"country": "United States",
"city": "Washington",
"state": "DC"
}
],
"source": "nonprofit_directory"
}
}{
"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."
}{
"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.
Body
application/json
Validated request fields for this operation.
Required string length:
2 - 100Example:
"Example Nonprofit"
⌘I
Look up a nonprofit during workspace setup
curl --request POST \
--url https://api.gratona.com/v1/workspace-onboarding/{public_id}/organization-lookup \
--header 'Content-Type: application/json' \
--header 'X-Workspace-Onboarding-Session: <x-workspace-onboarding-session>' \
--data '
{
"query": "Example Nonprofit"
}
'import requests
url = "https://api.gratona.com/v1/workspace-onboarding/{public_id}/organization-lookup"
payload = { "query": "Example Nonprofit" }
headers = {
"X-Workspace-Onboarding-Session": "<x-workspace-onboarding-session>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Workspace-Onboarding-Session': '<x-workspace-onboarding-session>',
'Content-Type': 'application/json'
},
body: JSON.stringify({query: 'Example Nonprofit'})
};
fetch('https://api.gratona.com/v1/workspace-onboarding/{public_id}/organization-lookup', 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}/organization-lookup",
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([
'query' => 'Example Nonprofit'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gratona.com/v1/workspace-onboarding/{public_id}/organization-lookup"
payload := strings.NewReader("{\n \"query\": \"Example Nonprofit\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Workspace-Onboarding-Session", "<x-workspace-onboarding-session>")
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.gratona.com/v1/workspace-onboarding/{public_id}/organization-lookup")
.header("X-Workspace-Onboarding-Session", "<x-workspace-onboarding-session>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"Example Nonprofit\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/workspace-onboarding/{public_id}/organization-lookup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Workspace-Onboarding-Session"] = '<x-workspace-onboarding-session>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"Example Nonprofit\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"status": "ready",
"results": [
{
"name": "Example Nonprofit",
"ein": "12-3456789",
"website": "https://example.org",
"country": "United States",
"city": "Washington",
"state": "DC"
}
],
"source": "nonprofit_directory"
}
}{
"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."
}{
"status": "error",
"code": "workspace_onboarding_session_unavailable",
"message": "This setup session is no longer available. Start again."
}