Genealogy

Page current subtree

Requires company admin access and members.view. Returns the kept selected node at relative depth zero followed by its kept strict descendants, breadth-first by (relative_depth, id), within the admitted depth 1-7 / 10,000-position profile. The anchor’s parent identity is masked when it lies outside the read scope. Depth beyond the profile and within-range position overflow return pagination_requires_projection without partial output; a statement deadline returns lookup_too_large. Only depth, cursor, limit, ids_only, and as_of query parameters are accepted; body, history, filters, and other depth selectors are unsupported. Cursors are bound to company, tree, anchor, operation, depth, and scope. depth_truncated reports eligible positions beyond the selected bound without implying full traversal. Current pages are not a frozen snapshot across requests. This endpoint does not activate or populate a tree.

GET

api

company

v2026-10

genealogy

nodes

{id}

subtree

Page current subtree

curl --request GET \
  --url https://api.fluid.app/api/company/v2026-10/genealogy/nodes/{id}/subtree \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.fluid.app/api/company/v2026-10/genealogy/nodes/{id}/subtree"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.fluid.app/api/company/v2026-10/genealogy/nodes/{id}/subtree', 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.fluid.app/api/company/v2026-10/genealogy/nodes/{id}/subtree",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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://api.fluid.app/api/company/v2026-10/genealogy/nodes/{id}/subtree"

	req, _ := http.NewRequest("GET", 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))

}

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/company/v2026-10/genealogy/nodes/{id}/subtree")

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

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

response = http.request(request)
puts response.read_body

{
  "status": 200,
  "nodes": [
    {
      "id": "019e5b8a-4c10-7000-8000-000000000001",
      "tree_id": "7096ad49-7117-53f6-8f7f-4805473d14c5",
      "member_id": "019e5b8a-4c10-7000-8000-000000000002",
      "parent_node_id": null,
      "leg": null,
      "position": 0,
      "pinned": false,
      "relative_depth": 0
    }
  ],
  "meta": {
    "request_uuid": null,
    "timestamp": "2026-09-16T00:00:00Z",
    "pagination": {
      "cursor": null,
      "next_cursor": null,
      "limit": 100,
      "ordering": "relative_depth_id_asc"
    },
    "traversal": {
      "depth_truncated": false
    }
  }
}

{
  "message": "<string>",
  "error": "<unknown>"
}

{
  "message": "<string>",
  "error": "<unknown>"
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_uuid": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_uuid": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

Company admin or company service token, subject to developer permissions.

Path Parameters

string<uuid>

required

Existing node UUID in the authenticated company.

Query Parameters

depth

integer

required

Positive relative depth bound; values above the admitted profile are refused, not clamped.

Required range: x >= 1

cursor

string

Opaque forward cursor returned by this same lookup.

Minimum string length: 1

limit

integer

default:100

Maximum nodes in this page; may change between pages.

Required range: 1 <= x <= 1000

ids_only

boolean

default:false

When true, return the same ordered page as an ids array instead of node objects.

as_of

string<date-time>

Read recorded placements containing this instant; omit for current state. Intervals include their start and exclude their end.

Response

Ordered current or recorded nodes, forward pagination, and traversal metadata; the paginated result set begins with the kept anchor.

Option 1
Option 2

status

integer

required

nodes

object[]

required

Maximum array length: 1000

Show child attributes

meta

object

required

Show child attributes

Page current subtree

curl --request GET \
  --url https://api.fluid.app/api/company/v2026-10/genealogy/nodes/{id}/subtree \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.fluid.app/api/company/v2026-10/genealogy/nodes/{id}/subtree"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.fluid.app/api/company/v2026-10/genealogy/nodes/{id}/subtree', 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.fluid.app/api/company/v2026-10/genealogy/nodes/{id}/subtree",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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://api.fluid.app/api/company/v2026-10/genealogy/nodes/{id}/subtree"

	req, _ := http.NewRequest("GET", 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))

}

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/company/v2026-10/genealogy/nodes/{id}/subtree")

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

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

response = http.request(request)
puts response.read_body

{
  "status": 200,
  "nodes": [
    {
      "id": "019e5b8a-4c10-7000-8000-000000000001",
      "tree_id": "7096ad49-7117-53f6-8f7f-4805473d14c5",
      "member_id": "019e5b8a-4c10-7000-8000-000000000002",
      "parent_node_id": null,
      "leg": null,
      "position": 0,
      "pinned": false,
      "relative_depth": 0
    }
  ],
  "meta": {
    "request_uuid": null,
    "timestamp": "2026-09-16T00:00:00Z",
    "pagination": {
      "cursor": null,
      "next_cursor": null,
      "limit": 100,
      "ordering": "relative_depth_id_asc"
    },
    "traversal": {
      "depth_truncated": false
    }
  }
}

{
  "message": "<string>",
  "error": "<unknown>"
}

{
  "message": "<string>",
  "error": "<unknown>"
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_uuid": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_uuid": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Overview

Storefront

Commerce

Checkout

Members

Messaging

People

Payments

DAM

Website

Portal

Content and tools

Analytics

Sales channels

Settings

FairShare SDK

Droplets

Developers

Portal & Widgets

Page current subtree

Authorizations

Path Parameters

Query Parameters

Response