Create an organization snapshot
curl --request POST \
--url https://your-instance.example.com/api/org-snapshots \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Production baseline 2026-05",
"description": "Reference Acme Corp configuration for new-tenant onboarding.",
"sourceOrgId": "64ee9a8b1e7f2a0011223344",
"sourceUserId": "64ee9a8b1e7f2a0011223399"
}
'import requests
url = "https://your-instance.example.com/api/org-snapshots"
payload = {
"name": "Production baseline 2026-05",
"description": "Reference Acme Corp configuration for new-tenant onboarding.",
"sourceOrgId": "64ee9a8b1e7f2a0011223344",
"sourceUserId": "64ee9a8b1e7f2a0011223399"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Production baseline 2026-05',
description: 'Reference Acme Corp configuration for new-tenant onboarding.',
sourceOrgId: '64ee9a8b1e7f2a0011223344',
sourceUserId: '64ee9a8b1e7f2a0011223399'
})
};
fetch('https://your-instance.example.com/api/org-snapshots', 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://your-instance.example.com/api/org-snapshots",
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([
'name' => 'Production baseline 2026-05',
'description' => 'Reference Acme Corp configuration for new-tenant onboarding.',
'sourceOrgId' => '64ee9a8b1e7f2a0011223344',
'sourceUserId' => '64ee9a8b1e7f2a0011223399'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://your-instance.example.com/api/org-snapshots"
payload := strings.NewReader("{\n \"name\": \"Production baseline 2026-05\",\n \"description\": \"Reference Acme Corp configuration for new-tenant onboarding.\",\n \"sourceOrgId\": \"64ee9a8b1e7f2a0011223344\",\n \"sourceUserId\": \"64ee9a8b1e7f2a0011223399\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://your-instance.example.com/api/org-snapshots")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Production baseline 2026-05\",\n \"description\": \"Reference Acme Corp configuration for new-tenant onboarding.\",\n \"sourceOrgId\": \"64ee9a8b1e7f2a0011223344\",\n \"sourceUserId\": \"64ee9a8b1e7f2a0011223399\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/org-snapshots")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Production baseline 2026-05\",\n \"description\": \"Reference Acme Corp configuration for new-tenant onboarding.\",\n \"sourceOrgId\": \"64ee9a8b1e7f2a0011223344\",\n \"sourceUserId\": \"64ee9a8b1e7f2a0011223399\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Snapshot created",
"snapshot": {
"_id": "665f1a0c0e0a4b001a2c9f90",
"name": "Production baseline 2026-05",
"sourceOrgName": "Acme Corp",
"counts": {
"pipelines": 3,
"automations": 12,
"prompts": 20,
"templates": 30
}
}
}{
"error": "Snapshot not found",
"message": "No snapshot exists with the given id"
}{
"error": "Snapshot not found",
"message": "No snapshot exists with the given id"
}{
"error": "Snapshot not found",
"message": "No snapshot exists with the given id"
}{
"error": "Snapshot not found",
"message": "No snapshot exists with the given id"
}{
"error": "Snapshot not found",
"message": "No snapshot exists with the given id"
}Org Snapshots
Create an organization snapshot
Captures an organization-level snapshot (pipelines, automations, prompts, templates) of a source user inside a source organization. Superadmin only.
POST
/
api
/
org-snapshots
Create an organization snapshot
curl --request POST \
--url https://your-instance.example.com/api/org-snapshots \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Production baseline 2026-05",
"description": "Reference Acme Corp configuration for new-tenant onboarding.",
"sourceOrgId": "64ee9a8b1e7f2a0011223344",
"sourceUserId": "64ee9a8b1e7f2a0011223399"
}
'import requests
url = "https://your-instance.example.com/api/org-snapshots"
payload = {
"name": "Production baseline 2026-05",
"description": "Reference Acme Corp configuration for new-tenant onboarding.",
"sourceOrgId": "64ee9a8b1e7f2a0011223344",
"sourceUserId": "64ee9a8b1e7f2a0011223399"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Production baseline 2026-05',
description: 'Reference Acme Corp configuration for new-tenant onboarding.',
sourceOrgId: '64ee9a8b1e7f2a0011223344',
sourceUserId: '64ee9a8b1e7f2a0011223399'
})
};
fetch('https://your-instance.example.com/api/org-snapshots', 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://your-instance.example.com/api/org-snapshots",
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([
'name' => 'Production baseline 2026-05',
'description' => 'Reference Acme Corp configuration for new-tenant onboarding.',
'sourceOrgId' => '64ee9a8b1e7f2a0011223344',
'sourceUserId' => '64ee9a8b1e7f2a0011223399'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://your-instance.example.com/api/org-snapshots"
payload := strings.NewReader("{\n \"name\": \"Production baseline 2026-05\",\n \"description\": \"Reference Acme Corp configuration for new-tenant onboarding.\",\n \"sourceOrgId\": \"64ee9a8b1e7f2a0011223344\",\n \"sourceUserId\": \"64ee9a8b1e7f2a0011223399\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://your-instance.example.com/api/org-snapshots")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Production baseline 2026-05\",\n \"description\": \"Reference Acme Corp configuration for new-tenant onboarding.\",\n \"sourceOrgId\": \"64ee9a8b1e7f2a0011223344\",\n \"sourceUserId\": \"64ee9a8b1e7f2a0011223399\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/org-snapshots")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Production baseline 2026-05\",\n \"description\": \"Reference Acme Corp configuration for new-tenant onboarding.\",\n \"sourceOrgId\": \"64ee9a8b1e7f2a0011223344\",\n \"sourceUserId\": \"64ee9a8b1e7f2a0011223399\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Snapshot created",
"snapshot": {
"_id": "665f1a0c0e0a4b001a2c9f90",
"name": "Production baseline 2026-05",
"sourceOrgName": "Acme Corp",
"counts": {
"pipelines": 3,
"automations": 12,
"prompts": 20,
"templates": 30
}
}
}{
"error": "Snapshot not found",
"message": "No snapshot exists with the given id"
}{
"error": "Snapshot not found",
"message": "No snapshot exists with the given id"
}{
"error": "Snapshot not found",
"message": "No snapshot exists with the given id"
}{
"error": "Snapshot not found",
"message": "No snapshot exists with the given id"
}{
"error": "Snapshot not found",
"message": "No snapshot exists with the given id"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Snapshot display name shown in the snapshot picker.
Required string length:
1 - 120Organization whose state is being captured.
User triggering the snapshot (recorded for audit).
Free-form notes describing what this snapshot captures.
Maximum string length:
500Response
Snapshot created
Show child attributes
Show child attributes
Example:
{
"_id": "665f1a0c0e0a4b001a2c9f90",
"name": "Production baseline 2026-05",
"description": "Reference Acme Corp configuration for new-tenant onboarding.",
"sourceOrgName": "Acme Corp",
"sourceUserEmail": "alex@acme.example",
"sourceUserName": "Alex Rep",
"counts": {
"pipelines": 3,
"automations": 12,
"prompts": 20,
"templates": 30
},
"createdByName": "Pat Superadmin",
"createdAt": "2026-05-15T09:00:00.000Z",
"updatedAt": "2026-05-15T09:00:00.000Z"
}
⌘I